ydb 0.17.1

Crate contains generated low-level grpc code from YDB API protobuf, used as base for ydb crate
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239

//! YDB SDK - a client for YDB.
//!
//! # Example
//!
//! ```no_run
//! # use ydb::{AccessTokenCredentials, ClientBuilder, YdbResult};
//! #
//! # #[tokio::main]
//! # async fn main() -> YdbResult<()> {
//!
//!  // create driver
//!  let client = ClientBuilder::new_from_connection_string("grpc://localhost:2136/local")?
//!     .with_credentials(AccessTokenCredentials::from("asd"))
//!     .client()?;
//!
//!  // wait until driver background initialization finish
//!  client.wait().await?;
//!
//!  // read query result via Query API
//!  let mut row = client
//!     .query_client()
//!     .query_row("SELECT 1 + 1 AS sum")
//!     .await?;
//!  let sum: i32 = row.remove_field_by_name("sum")?.try_into()?;
//!
//!  // it will print "sum: 2"
//!  println!("sum: {}", sum);
//! #    return Ok(());
//! # }
//! ```
//!
//! # More examples
//! [Examples](https://github.com/ydb-platform/ydb-rs-sdk/tree/master/ydb/examples)
//!
// This workaround solves compiler error
// ```
// error: queries overflow the depth limit!
//   |
//   = help: consider increasing the recursion limit by adding a `#![recursion_limit = "256"]` attribute to your crate ...
// ```
// because queue depth limit has changed since 1.94. See https://github.com/rust-lang/rust/issues/152942
#![recursion_limit = "256"]

extern crate core;

pub(crate) mod client;
mod client_builder;
pub(crate) mod client_common;
pub(crate) mod client_coordination;
#[cfg(test)]
mod client_directory_test_integration;
pub(crate) mod client_operation;
pub(crate) mod client_query;
pub(crate) mod client_scheme;
pub(crate) mod client_table;
#[cfg(test)]
mod client_table_test_integration;
pub(crate) mod client_topic;
pub(crate) mod connection_pool;
mod credentials;
pub(crate) mod discovery;
mod errors;
mod grpc;
pub(crate) mod grpc_connection_manager;
mod grpc_options;
mod grpc_wrapper;
mod load_balancer;
mod pub_traits;
pub(crate) mod query;
pub(crate) mod result;
mod retry;
mod retry_budget;
mod session;
mod session_pool;
mod sugar;

#[cfg(test)]
pub(crate) mod auth_test;

#[cfg(test)]
pub(crate) mod custom_ca_test;

#[cfg(test)]
mod test_helpers;

mod async_closure;
#[cfg(test)]
pub(crate) mod coordination_test;
pub(crate) mod discovery_pessimization_interceptor;
mod table_requests;
mod table_service_types;
#[cfg(test)]
mod test_integration_helper;
#[cfg(test)]
pub(crate) mod topic_reader_tx_test;
#[cfg(test)]
pub(crate) mod topics_compression_test;
#[cfg(test)]
pub(crate) mod topics_test;
#[cfg(test)]
pub(crate) mod topics_writer_tx_test;
pub mod traces;
mod trait_operation;
mod types;
mod types_converters;
pub(crate) mod waiter;

#[cfg(test)]
mod types_test;

#[cfg(test)]
mod connection_pool_test;

pub use async_closure::{
    __make_closure, AsyncFnMut, DynAsyncFnMut,
    with_lifetime::{MutWithLifetime, OwnedWithLifetime, RefWithLifetime, WithLifetime},
};

pub use client_coordination::client::CoordinationClient;
pub use client_coordination::list_types::{
    ConsistencyMode, NodeConfig, NodeConfigBuilder, NodeDescription, RateLimiterCountersMode,
};
pub use client_coordination::session::acquire_options::{AcquireOptions, AcquireOptionsBuilder};
pub use client_coordination::session::coordination_session::CoordinationSession;
pub use client_coordination::session::describe_options::{
    DescribeOptions, DescribeOptionsBuilder, WatchMode, WatchOptions, WatchOptionsBuilder,
};
pub use client_coordination::session::lease::Lease;
pub use client_coordination::session::session_options::{SessionOptions, SessionOptionsBuilder};

// full enum pub types
pub use client_topic::client::{
    AlterTopicOptions, AlterTopicOptionsBuilder, CreateTopicOptions, CreateTopicOptionsBuilder,
    DescribeConsumerOptions, DescribeConsumerOptionsBuilder, DescribeTopicOptions,
    DescribeTopicOptionsBuilder, TopicClient,
};
pub use client_topic::list_types::{
    AlterConsumer, AlterConsumerBuilder, Codec, Consumer, ConsumerBuilder, ConsumerDescription,
    MeteringMode, PartitionInfo, PartitionLocation, PartitionStats, PartitioningSettings,
    TopicDescription, TopicStats,
};
// full enum pub types
pub use client_topic::topicreader::messages::{
    PartitionSessionKey, TopicReaderBatch, TopicReaderMessage,
};
// full enum pub types
pub use client_topic::topicreader::reader::{
    TopicReader, TopicReaderCommitMarker, TopicSelector, TopicSelectorBuilder, TopicSelectors,
};
pub use client_topic::topicreader::reader_options::{
    TopicReaderOptions, TopicReaderOptionsBuilder,
};
pub use client_topic::topicreader::reader_tx::TopicReaderTx;
// full enum pub types
pub use client_topic::topicwriter::message::{TopicWriterMessage, TopicWriterMessageBuilder};
// full enum pub types
pub use client_topic::topicwriter::partitioning::PartitioningStrategy;
// full enum pub types
pub use client_topic::compression::{CompressionDecoder, CompressionEncoder, Executor};
pub use client_topic::topicwriter::writer::TopicWriter;
pub use client_topic::topicwriter::writer_options::{
    TopicWriterOptions, TopicWriterOptionsBuilder,
};
pub use client_topic::topicwriter::writer_tx::TopicWriterTx;
pub use client_topic::topicwriter::writer_tx_options::{
    TopicWriterTxOptions, TopicWriterTxOptionsBuilder,
};
// full enum pub types
pub use client::{Client, SessionPoolSettings, SessionPoolStats};

pub use retry_budget::{
    LimitedRetryBudget, PercentOfRpsRetryBudget, PercentRetryBudget, RetryBudget, RetryBudgetError,
    RetryMetrics,
};

// full enum pub types
pub use client_builder::ClientBuilder;
pub use grpc_options::{GrpcOptions, HasGrpcOptions};

// full enum pub types
pub use client_query::{
    CallBuilder, ClientOneShot, ExecBuilder, ExecCall, ExecuteScriptBuilder,
    ExecuteScriptOperation, FetchScriptResult, FetchScriptResultsBuilder, FromYdbRow, Interactive,
    OneResultSet, OneRow, OptionalRow, OptionalRowBuilder, QueryClient, QueryExecutor,
    QueryRowBuilder, QueryStats, QueryStream, QueryStreamBuilder, ResultSetBuilder, RetryTxAttempt,
    RetryTxBuilder, Streamed, Transaction, TransactionOptions, TxMode,
};

// full enum pub types
pub use client_table::TableClient;

// full enum pub types
pub use table_service_types::{
    ColumnDescription, CopyTableItem, IndexDescription, IndexStatus, IndexType, RenameTableItem,
    StoreType, TableDescription, UnknownTypeDescription,
};

// full enum pub types
pub use client_scheme::client::SchemeClient;
pub use client_scheme::list_types::{SchemeEntry, SchemeEntryType, SchemePermissions};

pub use client_operation::{
    ListOperationsRequest, ListOperationsResult, OperationClient, OperationInfo, OperationKind,
};

// full enum pub types
pub use discovery::{Discovery, DiscoveryState, StaticDiscovery};
// full enum pub types
pub use query::Query;
// full enum pub types
pub use result::{ResultSet, ResultSetRowsIter, Row};
pub use table_requests::{
    AlterTableRequest, CreateTableRequest, DropTableRequest, NamedPolicyDescription,
    ReadRowsRequest, TableColumn, TableOptionsDescription,
};
// full enum pub types
pub use waiter::Waiter;
// full enum pub types
pub use crate::{
    credentials::{
        AccessTokenCredentials, AnonymousCredentials, CommandLineCredentials, FromEnvCredentials,
        GCEMetadata, MetadataUrlCredentials, ServiceAccountCredentials, StaticCredentials,
    },
    errors::{
        YdbError, YdbIssue, YdbIssueSeverity, YdbOrCustomerError, YdbResult,
        YdbResultWithCustomerErr, YdbStatusError,
    },
    pub_traits::{Credentials, TokenInfo},
    types::{
        Bytes, Sign, SignedInterval, Value, ValueList, ValueOptional, ValueStruct, YdbDecimal,
    },
};

// deprecated types

#[allow(deprecated)]
pub use crate::credentials::{
    CommandLineYcToken, StaticCredentialsAuth, StaticToken, YandexMetadata,
};