ydb
Getting Started
Overview
Quick Start
Connecting
Driver
Services
Query Service
Topic Service
Table Service
Coordination Service
Scheme Service
Reference
YDB Types
Errors and Retries
YDB API Reference
ydb
Index
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
K
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
Y
_
_ResultSet (class in ydb.convert)
A
Aborted (class in ydb)
AccessTokenCredentials (class in ydb)
acquire() (ydb.aio.QuerySessionPool method)
(ydb.QuerySessionPool method)
(ydb.SessionPool method)
active_size (ydb.SessionPool property)
add_column() (ydb.BulkUpsertColumns method)
add_element() (ydb.TupleType method)
add_member() (ydb.StructType method)
AGGREGATED (ydb.coordination.RateLimiterCountersMode attribute)
AlreadyExists (class in ydb)
alter_table() (ydb.Session method)
(ydb.TableClient method)
alter_topic() (ydb.TopicClient method)
AnonymousCredentials (class in ydb)
ARROW (ydb.QueryResultSetFormat attribute)
arrow_format_meta (ydb.convert._ResultSet attribute)
ArrowFormatSettings (class in ydb)
async_alter_table() (ydb.Session method)
async_begin() (ydb.TxContext method)
async_bulk_upsert() (ydb.TableClient method)
async_checkout() (ydb.SessionPool method)
async_commit() (ydb.TxContext method)
async_copy_table() (ydb.Session method)
async_copy_tables() (ydb.Session method)
async_create() (ydb.Session method)
async_create_table() (ydb.Session method)
async_delete() (ydb.Session method)
async_describe_path() (ydb.SchemeClient method)
async_describe_table() (ydb.Session method)
async_drop_table() (ydb.Session method)
async_execute() (ydb.TxContext method)
async_execute_scheme() (ydb.Session method)
async_keep_alive() (ydb.Session method)
async_list_directory() (ydb.SchemeClient method)
async_make_directory() (ydb.SchemeClient method)
async_modify_permissions() (ydb.SchemeClient method)
async_prepare() (ydb.Session method)
async_read_table() (ydb.Session method)
async_remove_directory() (ydb.SchemeClient method)
async_rename_tables() (ydb.Session method)
async_rollback() (ydb.TxContext method)
async_scan_query() (ydb.TableClient method)
async_wait() (ydb.Driver method)
attach_consistency_mode (ydb.coordination.NodeConfig attribute)
auth_metadata() (ydb.AccessTokenCredentials method)
(ydb.AnonymousCredentials static method)
B
BackoffSettings (class in ydb)
BadRequest (class in ydb)
BadSession (class in ydb)
BaseQueryTxMode (class in ydb)
BaseRequestSettings (class in ydb)
BASIC (ydb.QueryStatsMode attribute)
begin() (ydb.aio.QueryTxContext method)
(ydb.QueryTxContext method)
(ydb.TxContext method)
BLOCK_STORE_VOLUME (ydb.SchemeEntryType attribute)
Bool (ydb.PrimitiveType attribute)
bulk_upsert() (ydb.TableClient method)
BulkUpsertColumns (class in ydb)
busy_size (ydb.SessionPool property)
C
calc_timeout() (ydb.BackoffSettings method)
cancel_after (ydb.DescribeTableSettings attribute)
checkout() (ydb.aio.QuerySessionPool method)
(ydb.QuerySessionPool method)
(ydb.SessionPool method)
close() (ydb.TopicClient method)
closing() (ydb.Session method)
Column (class in ydb)
COLUMN_STORE (ydb.SchemeEntryType attribute)
COLUMN_TABLE (ydb.SchemeEntryType attribute)
ColumnFamily (class in ydb)
columns (ydb.convert._ResultSet attribute)
ColumnUnit (class in ydb)
commit() (ydb.aio.QueryTxContext method)
(ydb.QueryTxContext method)
(ydb.TxContext method)
commit_offset() (ydb.TopicClient method)
Compression (class in ydb)
compression (ydb.DescribeTableSettings attribute)
(ydb.DriverConfig attribute)
ConnectionError (class in ydb)
ConnectionFailure (class in ydb)
ConnectionLost (class in ydb)
ConsistencyMode (class in ydb.coordination)
COORDINATION_NODE (ydb.SchemeEntryType attribute)
copy_table() (ydb.Session method)
(ydb.TableClient method)
copy_tables() (ydb.Session method)
(ydb.TableClient method)
create() (ydb.aio.QuerySession method)
(ydb.QuerySession method)
(ydb.Session method)
create_table() (ydb.Session method)
(ydb.TableClient method)
create_topic() (ydb.TopicClient method)
D
data (ydb.convert._ResultSet attribute)
DATABASE (ydb.SchemeEntryType attribute)
DataQuery (class in ydb)
Date (ydb.PrimitiveType attribute)
Date32 (ydb.PrimitiveType attribute)
Datetime (ydb.PrimitiveType attribute)
Datetime64 (ydb.PrimitiveType attribute)
DeadlineExceed (class in ydb)
DecimalType (class in ydb)
default_from_connection_string() (ydb.DriverConfig class method)
default_from_endpoint_and_database() (ydb.DriverConfig class method)
delete() (ydb.aio.QuerySession method)
(ydb.QuerySession method)
(ydb.Session method)
describe_consumer() (ydb.TopicClient method)
describe_path() (ydb.SchemeClient method)
describe_table() (ydb.Session method)
(ydb.TableClient method)
describe_topic() (ydb.TopicClient method)
DescribeTableSettings (class in ydb)
DETAILED (ydb.coordination.RateLimiterCountersMode attribute)
detect_local_dc (ydb.DriverConfig attribute)
DICT (ydb.QueryExplainResultFormat attribute)
DictType (class in ydb)
DIRECTORY (ydb.SchemeEntryType attribute)
disable_discovery (ydb.DriverConfig attribute)
DISABLED (ydb.FeatureFlag attribute)
discovery_debug_details() (ydb.aio.Driver method)
(ydb.Driver method)
discovery_request_timeout (ydb.DriverConfig attribute)
Double (ydb.PrimitiveType attribute)
Driver (class in ydb)
(class in ydb.aio)
DriverConfig (class in ydb)
drop_table() (ydb.Session method)
(ydb.TableClient method)
drop_topic() (ydb.TopicClient method)
DyNumber (ydb.PrimitiveType attribute)
E
effective_permissions (ydb.SchemeEntry attribute)
(ydb.TableSchemeEntry attribute)
ENABLED (ydb.FeatureFlag attribute)
encode_decode_threads_count (ydb.TopicClientSettings attribute)
Error (class in ydb)
exclusive() (ydb.KeyBound class method)
execute() (ydb.aio.QuerySession method)
(ydb.aio.QueryTxContext method)
(ydb.QuerySession method)
(ydb.QueryTxContext method)
(ydb.TxContext method)
execute_scheme() (ydb.Session method)
execute_with_retries() (ydb.aio.QuerySessionPool method)
(ydb.QuerySessionPool method)
execute_with_retries_async() (ydb.QuerySessionPool method)
explain() (ydb.aio.QuerySession method)
(ydb.QuerySession method)
(ydb.Session method)
explain_with_retries() (ydb.aio.QuerySessionPool method)
(ydb.QuerySessionPool method)
EXTERNAL_DATA_SOURCE (ydb.SchemeEntryType attribute)
EXTERNAL_TABLE (ydb.SchemeEntryType attribute)
F
FeatureFlag (class in ydb)
Float (ydb.PrimitiveType attribute)
format (ydb.convert._ResultSet attribute)
free_size (ydb.SessionPool property)
from_bound (ydb.KeyRange attribute)
from_message() (ydb.convert._ResultSet class method)
from_proto() (ydb.coordination.NodeConfig static method)
from_user_password() (ydb.StaticCredentials class method)
FULL (ydb.QueryStatsMode attribute)
future() (ydb.Driver method)
G
GenericError (class in ydb)
get_value() (ydb.PrimitiveType method)
grpc_lb_policy_name (ydb.DriverConfig attribute)
H
has_prepared() (ydb.Session method)
headers (ydb.DescribeTableSettings attribute)
I
inclusive() (ydb.KeyBound class method)
index (ydb.convert._ResultSet attribute)
initialized() (ydb.Session method)
Int16 (ydb.PrimitiveType attribute)
Int32 (ydb.PrimitiveType attribute)
Int64 (ydb.PrimitiveType attribute)
Int8 (ydb.PrimitiveType attribute)
Interval (ydb.PrimitiveType attribute)
Interval64 (ydb.PrimitiveType attribute)
is_active (ydb.aio.QuerySession property)
(ydb.QuerySession property)
is_any_table() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
is_closed (ydb.aio.QuerySession property)
(ydb.QuerySession property)
is_column_store() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
is_column_table() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
is_coordination_node() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
is_database() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
is_directory() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
is_directory_or_database() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
is_exclusive() (ydb.KeyBound method)
is_external_data_source() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
is_external_table() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
is_inclusive() (ydb.KeyBound method)
is_resource_pool() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
is_row_table() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
is_sysview() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
is_table() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
is_topic() (ydb.SchemeEntryType static method)
is_view() (ydb.SchemeEntry method)
(ydb.SchemeEntryType static method)
item (ydb.OptionalType property)
J
Json (ydb.PrimitiveType attribute)
JsonDocument (ydb.PrimitiveType attribute)
K
keep_alive() (ydb.Session method)
KeyBound (class in ydb)
KeyRange (class in ydb)
L
last_query_stats (ydb.aio.QuerySession property)
(ydb.aio.QueryTxContext property)
(ydb.QuerySession property)
(ydb.QueryTxContext property)
lazy_from_message() (ydb.convert._ResultSet class method)
list_directory() (ydb.SchemeClient method)
ListType (class in ydb)
LZ4 (ydb.Compression attribute)
M
make_directory() (ydb.SchemeClient method)
max_size (ydb.SessionPool property)
modify_permissions() (ydb.SchemeClient method)
module
ydb
N
name (ydb.Column property)
(ydb.DataQuery attribute)
(ydb.SchemeEntry attribute)
(ydb.TableSchemeEntry attribute)
need_rpc_auth (ydb.DescribeTableSettings attribute)
node_id (ydb.aio.QuerySession property)
(ydb.QuerySession property)
NodeConfig (class in ydb.coordination)
NONE (ydb.Compression attribute)
(ydb.QueryStatsMode attribute)
NotFound (class in ydb)
O
operation_timeout (ydb.DescribeTableSettings attribute)
OptionalType (class in ydb)
Overloaded (class in ydb)
owner (ydb.SchemeEntry attribute)
(ydb.TableSchemeEntry attribute)
P
parameters_types (ydb.DataQuery attribute)
PartitioningSettings (class in ydb)
pending_query() (ydb.Session method)
permissions (ydb.SchemeEntry attribute)
(ydb.TableSchemeEntry attribute)
PERS_QUEUE_GROUP (ydb.SchemeEntryType attribute)
precision (ydb.DecimalType property)
prepare() (ydb.Session method)
PrimitiveType (class in ydb)
PROFILE (ydb.QueryStatsMode attribute)
proto (ydb.BulkUpsertColumns property)
(ydb.DecimalType property)
(ydb.DictType property)
(ydb.ListType property)
(ydb.OptionalType property)
(ydb.PrimitiveType property)
(ydb.StructType property)
(ydb.TupleType property)
Q
query_client_settings (ydb.DriverConfig attribute)
QueryClientSettings (class in ydb)
QueryExplainResultFormat (class in ydb)
QueryOnlineReadOnly (class in ydb)
QueryResultSetFormat (class in ydb)
QuerySerializableReadWrite (class in ydb)
QuerySession (class in ydb)
(class in ydb.aio)
QuerySessionPool (class in ydb)
(class in ydb.aio)
QuerySnapshotReadOnly (class in ydb)
QuerySnapshotReadWrite (class in ydb)
QueryStaleReadOnly (class in ydb)
QueryStatsMode (class in ydb)
QueryTxContext (class in ydb)
(class in ydb.aio)
R
rate_limiter_counters_mode (ydb.coordination.NodeConfig attribute)
RateLimiterCountersMode (class in ydb.coordination)
read_consistency_mode (ydb.coordination.NodeConfig attribute)
read_table() (ydb.Session method)
reader() (ydb.TopicClient method)
RELAXED (ydb.coordination.ConsistencyMode attribute)
release() (ydb.aio.QuerySessionPool method)
(ydb.QuerySessionPool method)
(ydb.SessionPool method)
remove_directory() (ydb.SchemeClient method)
rename_tables() (ydb.Session method)
(ydb.TableClient method)
REPLICATION (ydb.SchemeEntryType attribute)
request_type (ydb.DescribeTableSettings attribute)
reset() (ydb.Session method)
RESOURCE_POOL (ydb.SchemeEntryType attribute)
retry_operation_async() (ydb.aio.QuerySessionPool method)
(ydb.QuerySessionPool method)
retry_operation_sync() (ydb.QuerySessionPool method)
(ydb.SessionPool method)
retry_tx_async() (ydb.aio.QuerySessionPool method)
(ydb.QuerySessionPool method)
retry_tx_sync() (ydb.QuerySessionPool method)
RetrySettings (class in ydb)
rollback() (ydb.aio.QueryTxContext method)
(ydb.QueryTxContext method)
(ydb.TxContext method)
rows (ydb.convert._ResultSet attribute)
RTMR_VOLUME (ydb.SchemeEntryType attribute)
S
scale (ydb.DecimalType property)
scan_query() (ydb.TableClient method)
scheme_client (ydb.Driver attribute)
SchemeClient (class in ydb)
SchemeEntry (class in ydb)
SchemeEntryType (class in ydb)
SchemeError (class in ydb)
self_check_period_millis (ydb.coordination.NodeConfig attribute)
SEQUENCE (ydb.SchemeEntryType attribute)
Session (class in ydb)
session (ydb.TxContext attribute)
session() (ydb.TableClient method)
session_grace_period_millis (ydb.coordination.NodeConfig attribute)
session_id (ydb.aio.QuerySession property)
(ydb.aio.QueryTxContext property)
(ydb.QuerySession property)
(ydb.QueryTxContext property)
(ydb.Session property)
(ydb.TxContext property)
SessionPool (class in ydb)
SessionPoolEmpty (class in ydb)
set_database() (ydb.DriverConfig method)
set_grpc_keep_alive_timeout() (ydb.DriverConfig method)
set_value() (ydb.PrimitiveType method)
size_bytes (ydb.SchemeEntry attribute)
(ydb.TableSchemeEntry attribute)
snapshot (ydb.convert._ResultSet attribute)
StaticCredentials (class in ydb)
status (ydb.Error attribute)
stop() (ydb.aio.Driver method)
(ydb.aio.QuerySessionPool method)
(ydb.Driver method)
(ydb.QuerySessionPool method)
(ydb.SessionPool method)
STR (ydb.QueryExplainResultFormat attribute)
STRICT (ydb.coordination.ConsistencyMode attribute)
String (ydb.PrimitiveType attribute)
StructType (class in ydb)
subscribe() (ydb.SessionPool method)
SYS_VIEW (ydb.SchemeEntryType attribute)
T
TABLE (ydb.SchemeEntryType attribute)
table_client (ydb.Driver attribute)
TableClient (class in ydb)
TableClientSettings (class in ydb)
TableDescription (class in ydb)
TableIndex (class in ydb)
TableSchemeEntry (class in ydb)
Timeout (class in ydb)
timeout (ydb.DescribeTableSettings attribute)
Timestamp (ydb.PrimitiveType attribute)
Timestamp64 (ydb.PrimitiveType attribute)
to_bound (ydb.KeyRange attribute)
to_pb() (ydb.ColumnFamily method)
(ydb.PartitioningSettings method)
(ydb.TableIndex method)
(ydb.TtlSettings method)
to_proto() (ydb.ArrowFormatSettings method)
(ydb.coordination.NodeConfig method)
TOPIC (ydb.SchemeEntryType attribute)
topic_client_settings (ydb.DriverConfig attribute)
TopicAutoPartitioningSettings (in module ydb)
TopicAutoPartitioningStrategy (in module ydb)
TopicClient (class in ydb)
TopicClientSettings (class in ydb)
TopicCodec (in module ydb)
TopicConsumer (in module ydb)
TopicReaderSelector (in module ydb)
TopicWriterMessage (in module ydb)
trace_id (ydb.DescribeTableSettings attribute)
tracer (ydb.DescribeTableSettings attribute)
(ydb.DriverConfig attribute)
transaction() (ydb.aio.QuerySession method)
(ydb.QuerySession method)
(ydb.Session method)
TRANSFER (ydb.SchemeEntryType attribute)
truncated (ydb.convert._ResultSet attribute)
TtlSettings (class in ydb)
TupleType (class in ydb)
tx_id (ydb.aio.QueryTxContext property)
(ydb.QueryTxContext property)
(ydb.TxContext property)
tx_writer() (ydb.TopicClient method)
TxContext (class in ydb)
type (ydb.Column property)
(ydb.KeyBound attribute)
(ydb.SchemeEntry attribute)
(ydb.TableSchemeEntry attribute)
type_pb (ydb.Column property)
TYPE_UNSPECIFIED (ydb.SchemeEntryType attribute)
TypedValue (class in ydb)
U
Uint16 (ydb.PrimitiveType attribute)
Uint32 (ydb.PrimitiveType attribute)
Uint64 (ydb.PrimitiveType attribute)
Uint8 (ydb.PrimitiveType attribute)
Unauthenticated (class in ydb)
Unauthorized (class in ydb)
Unavailable (class in ydb)
Undetermined (class in ydb)
UNIT_MICROSECONDS (ydb.ColumnUnit attribute)
UNIT_MILLISECONDS (ydb.ColumnUnit attribute)
UNIT_NANOSECONDS (ydb.ColumnUnit attribute)
UNIT_SECONDS (ydb.ColumnUnit attribute)
UNIT_UNSPECIFIED (ydb.ColumnUnit attribute)
UNSET (ydb.coordination.ConsistencyMode attribute)
(ydb.coordination.RateLimiterCountersMode attribute)
UNSPECIFIED (ydb.Compression attribute)
(ydb.FeatureFlag attribute)
(ydb.QueryResultSetFormat attribute)
(ydb.QueryStatsMode attribute)
unsubscribe() (ydb.SessionPool method)
Utf8 (ydb.PrimitiveType attribute)
UUID (ydb.PrimitiveType attribute)
V
value (ydb.KeyBound attribute)
VALUE (ydb.QueryResultSetFormat attribute)
value (ydb.TypedValue attribute)
value_type (ydb.TypedValue attribute)
VIEW (ydb.SchemeEntryType attribute)
W
wait() (ydb.aio.Driver method)
(ydb.Driver method)
waiters_count (ydb.SessionPool property)
with_allow_inconsistent_reads() (ydb.QueryOnlineReadOnly method)
with_allow_truncated_result() (ydb.TableClientSettings method)
with_attributes() (ydb.TableDescription method)
with_cancel_after() (ydb.BaseRequestSettings method)
with_client_query_cache() (ydb.TableClientSettings method)
with_column() (ydb.TableDescription method)
with_column_families() (ydb.TableDescription method)
with_column_family() (ydb.TableDescription method)
with_columns() (ydb.TableDescription method)
with_compaction_policy() (ydb.TableDescription method)
with_compression() (ydb.BaseRequestSettings method)
(ydb.ColumnFamily method)
with_data() (ydb.ColumnFamily method)
with_data_columns() (ydb.TableIndex method)
with_date_type_column() (ydb.TtlSettings method)
with_family() (ydb.Column method)
with_fast_backoff() (ydb.RetrySettings method)
with_global_async_index() (ydb.TableIndex method)
with_global_index() (ydb.TableIndex method)
with_header() (ydb.BaseRequestSettings method)
with_include_shard_key_bounds() (ydb.DescribeTableSettings method)
with_include_table_stats() (ydb.DescribeTableSettings method)
with_index() (ydb.TableDescription method)
with_index_columns() (ydb.TableIndex method)
with_indexes() (ydb.TableDescription method)
with_keep_in_memory() (ydb.ColumnFamily method)
with_key_bloom_filter() (ydb.TableDescription method)
with_lazy_result_sets() (ydb.TableClientSettings method)
with_max_partitions_count() (ydb.PartitioningSettings method)
with_min_partitions_count() (ydb.PartitioningSettings method)
with_name() (ydb.ColumnFamily method)
with_native_date_in_result_sets() (ydb.QueryClientSettings method)
(ydb.TableClientSettings method)
with_native_datetime_in_result_sets() (ydb.QueryClientSettings method)
(ydb.TableClientSettings method)
with_native_interval_in_result_sets() (ydb.QueryClientSettings method)
(ydb.TableClientSettings method)
with_native_json_in_result_sets() (ydb.QueryClientSettings method)
(ydb.TableClientSettings method)
with_native_timestamp_in_result_sets() (ydb.QueryClientSettings method)
(ydb.TableClientSettings method)
with_need_rpc_auth() (ydb.BaseRequestSettings method)
with_operation_timeout() (ydb.BaseRequestSettings method)
with_partition_at_keys() (ydb.TableDescription method)
with_partition_size_mb() (ydb.PartitioningSettings method)
with_partitioning_by_load() (ydb.PartitioningSettings method)
with_partitioning_by_size() (ydb.PartitioningSettings method)
with_partitioning_settings() (ydb.TableDescription method)
with_primary_key() (ydb.TableDescription method)
with_primary_keys() (ydb.TableDescription method)
with_profile() (ydb.TableDescription method)
with_read_replicas_settings() (ydb.TableDescription method)
with_request_type() (ydb.BaseRequestSettings method)
with_slow_backoff() (ydb.RetrySettings method)
with_storage_settings() (ydb.TableDescription method)
with_timeout() (ydb.BaseRequestSettings method)
with_trace_id() (ydb.BaseRequestSettings method)
with_ttl() (ydb.TableDescription method)
with_uniform_partitions() (ydb.TableDescription method)
with_value_since_unix_epoch() (ydb.TtlSettings method)
writer() (ydb.TopicClient method)
Y
ydb
module
yql_text (ydb.DataQuery attribute)
Yson (ydb.PrimitiveType attribute)