Crate ydb

YDB SDK - a client for YDB.

Example

 // create driver
 let client = ClientBuilder::new_from_connection_string("grpc://localhost:2136?database=local")?
    .with_credentials(StaticToken::from("asd"))
    .client()?;

 // wait until driver background initialization finish
 client.wait().await?;

 // read query result
 let sum: i32 = client
    .table_client() // create table client
    .retry_transaction(|mut t| async move {
        // code in transaction can retry few times if was some retriable error

        // send query to database
        let res = t.query(Query::from("SELECT 1 + 1 AS sum")).await?;

        // read exact one result from db
        let field_val: i32 = res.into_only_row()?.remove_field_by_name("sum")?.try_into()?;

        // return result
        return Ok(field_val);
    })
    .await?;

 // it will print "sum: 2"
 println!("sum: {}", sum);

More examples

Url shorneter application

Many small examples

Macros

ydb_params

sugar for manual construct query params

ydb_struct

Sugar for manual construct structs Example:

Structs

AccessTokenCredentials

Credentials with static token without renewing

AcquireOptions

AcquireOptionsBuilder

Builder for AcquireOptions.

AlterConsumer

AlterConsumerBuilder

Builder for AlterConsumer.

AlterTopicOptions

AlterTopicOptionsBuilder

Builder for AlterTopicOptions.

AnonymousCredentials

Bytes

Client

YDB client

ClientBuilder

Codec

CommandLineCredentials

Get from stdout of command

Consumer

ConsumerBuilder

Builder for Consumer.

CoordinationClient

CoordinationSession

CreateTopicOptions

CreateTopicOptionsBuilder

Builder for CreateTopicOptions.

DescribeOptions

DescribeOptionsBuilder

Builder for DescribeOptions.

DescribeTopicOptions

DescribeTopicOptionsBuilder

Builder for DescribeTopicOptions.

DiscoveryState

Current discovery state

FromEnvCredentials

GCEMetadata

Get instance service account token from GCE instance

Lease

MetadataUrlCredentials

Get token of service account of instance

NodeConfig

NodeConfigBuilder

Builder for NodeConfig.

NodeDescription

PartitionInfo

PartitionInfo contains info about partition.

PartitionLocation

PartitionStats

PartitioningSettings

Query

Query object

QueryResult

ResultSet

ResultSetRowsIter

RetryOptions

Retry options

Row

SchemeClient

SchemeEntry

SchemePermissions

ServiceAccountCredentials

Get service account credentials instance service account key should be:

SessionOptions

SessionOptionsBuilder

Builder for SessionOptions.

SignedInterval

StaticCredentials

StaticDiscovery

Always discovery once static node

StreamResult

TableClient

Client for YDB table service (SQL queries)

TokenInfo

TopicClient

TopicDescription

TopicDescription contains info about topic.

TopicStats

TopicWriter

TopicWriter at initial state of implementation it really doesn’t ready for use. For example It isn’t handle lost connection to the server and have some unimplemented method.

TopicWriterConnectionOptions

TopicWriterMessage

TopicWriterMessageBuilder

Builder for TopicWriterMessage.

TopicWriterOptions

TopicWriterOptionsBuilder

Builder for TopicWriterOptions.

TopicWriterRetrySettings

TransactionOptions

Options for create transaction

ValueList

ValueOptional

ValueStruct

WatchOptions

WatchOptionsBuilder

Builder for WatchOptions.

YdbIssue

Describe issue from server

YdbStatusError

Describe operation status from server

Enums

ConsistencyMode

MeteringMode

Mode

RateLimiterCountersMode

SchemeEntryType

Sign

Value

Internal represent database value for send to or received from database.

WatchMode

YdbError

Error which can be returned from the crate.

YdbIssueSeverity

Severity of issue

YdbOrCustomerError

Error for wrap user errors while return it from callback

Traits

Credentials

Discovery

Discovery YDB endpoints

Transaction

Waiter

Type Aliases

CommandLineYcTokenDeprecated

StaticCredentialsAuthDeprecated

StaticTokenDeprecated

YandexMetadataDeprecated

YdbResult

T result or YdbError as Error

YdbResultWithCustomerErr

T result or YdbOrCustomerError as Error