ydb-python-sdk API reference

86 public APIs from ydb-python-sdk (ydb-platform/ydb-python-sdk) — 44 classes, 5 functions, 37 methods. Signatures extracted by static analysis of the actual source.

Repository: ydb-platform/ydb-python-sdk

Kind	Count
Classes	44
Functions	5
Methods	37

API list

classydb._grpc.grpcwrapper.ydb_query_public_types.ArrowFormatSettings

Settings for Arrow format result sets.

classydb._grpc.grpcwrapper.ydb_query_public_types.BaseQueryTxMode

Abstract class for Query Transaction Modes.

classydb._grpc.grpcwrapper.ydb_topic.OffsetsRange

half-opened interval, include [start, end) offsets

classydb._grpc.grpcwrapper.ydb_topic_public_types.PublicCodec

Codec value may contain any int number.

classydb._grpc.v3.draft.ydb_bridge_v1_pb2_grpc.BridgeService

Service for managing cluster in bridge mode

classydb._grpc.v3.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceServicer

Service for managing cluster in bridge mode

classydb._grpc.v3.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceStub

Service for managing cluster in bridge mode

classydb._grpc.v3.ydb_cms_v1_pb2_grpc.CmsService

CMS stands for Cluster Management System.

classydb._grpc.v3.ydb_cms_v1_pb2_grpc.CmsServiceServicer

CMS stands for Cluster Management System.

methodydb._grpc.v3.ydb_cms_v1_pb2_grpc.CmsServiceServicer.ListDatabases(request, context)

List all databases.

methodydb._grpc.v3.ydb_cms_v1_pb2_grpc.CmsServiceServicer.RemoveDatabase(request, context)

Remove database.

classydb._grpc.v3.ydb_cms_v1_pb2_grpc.CmsServiceStub

CMS stands for Cluster Management System.

methodydb._grpc.v3.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToS3(request, context)

Exports data to S3.

methodydb._grpc.v3.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToYt(request, context)

Exports data to YT.

methodydb._grpc.v3.ydb_topic_v1_pb2_grpc.TopicServiceServicer.AlterTopic(request, context)

Alter topic command.

methodydb._grpc.v3.ydb_topic_v1_pb2_grpc.TopicServiceServicer.CreateTopic(request, context)

Create topic command.

methodydb._grpc.v3.ydb_topic_v1_pb2_grpc.TopicServiceServicer.DropTopic(request, context)

Drop topic command.

classydb._grpc.v4.draft.ydb_bridge_v1_pb2_grpc.BridgeService

Service for managing cluster in bridge mode

classydb._grpc.v4.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceServicer

Service for managing cluster in bridge mode

classydb._grpc.v4.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceStub

Service for managing cluster in bridge mode

classydb._grpc.v4.ydb_cms_v1_pb2_grpc.CmsService

CMS stands for Cluster Management System.

classydb._grpc.v4.ydb_cms_v1_pb2_grpc.CmsServiceServicer

CMS stands for Cluster Management System.

methodydb._grpc.v4.ydb_cms_v1_pb2_grpc.CmsServiceServicer.ListDatabases(request, context)

List all databases.

methodydb._grpc.v4.ydb_cms_v1_pb2_grpc.CmsServiceServicer.RemoveDatabase(request, context)

Remove database.

classydb._grpc.v4.ydb_cms_v1_pb2_grpc.CmsServiceStub

CMS stands for Cluster Management System.

methodydb._grpc.v4.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToS3(request, context)

Exports data to S3.

methodydb._grpc.v4.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToYt(request, context)

Exports data to YT.

methodydb._grpc.v4.ydb_topic_v1_pb2_grpc.TopicServiceServicer.AlterTopic(request, context)

Alter topic command.

methodydb._grpc.v4.ydb_topic_v1_pb2_grpc.TopicServiceServicer.CreateTopic(request, context)

Create topic command.

methodydb._grpc.v4.ydb_topic_v1_pb2_grpc.TopicServiceServicer.DropTopic(request, context)

Drop topic command.

classydb._grpc.v5.draft.ydb_bridge_v1_pb2_grpc.BridgeService

Service for managing cluster in bridge mode

classydb._grpc.v5.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceServicer

Service for managing cluster in bridge mode

classydb._grpc.v5.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceStub

Service for managing cluster in bridge mode

classydb._grpc.v5.ydb_cms_v1_pb2_grpc.CmsService

CMS stands for Cluster Management System.

classydb._grpc.v5.ydb_cms_v1_pb2_grpc.CmsServiceServicer

CMS stands for Cluster Management System.

methodydb._grpc.v5.ydb_cms_v1_pb2_grpc.CmsServiceServicer.ListDatabases(request, context)

List all databases.

methodydb._grpc.v5.ydb_cms_v1_pb2_grpc.CmsServiceServicer.RemoveDatabase(request, context)

Remove database.

classydb._grpc.v5.ydb_cms_v1_pb2_grpc.CmsServiceStub

CMS stands for Cluster Management System.

methodydb._grpc.v5.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToS3(request, context)

Exports data to S3.

methodydb._grpc.v5.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToYt(request, context)

Exports data to YT.

methodydb._grpc.v5.ydb_topic_v1_pb2_grpc.TopicServiceServicer.AlterTopic(request, context)

Alter topic command.

methodydb._grpc.v5.ydb_topic_v1_pb2_grpc.TopicServiceServicer.CreateTopic(request, context)

Create topic command.

methodydb._grpc.v5.ydb_topic_v1_pb2_grpc.TopicServiceServicer.DropTopic(request, context)

Drop topic command.

classydb._grpc.v6.draft.ydb_bridge_v1_pb2_grpc.BridgeService

Service for managing cluster in bridge mode

classydb._grpc.v6.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceServicer

Service for managing cluster in bridge mode

classydb._grpc.v6.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceStub

Service for managing cluster in bridge mode

classydb._grpc.v6.ydb_cms_v1_pb2_grpc.CmsService

CMS stands for Cluster Management System.

classydb._grpc.v6.ydb_cms_v1_pb2_grpc.CmsServiceServicer

CMS stands for Cluster Management System.

methodydb._grpc.v6.ydb_cms_v1_pb2_grpc.CmsServiceServicer.ListDatabases(request, context)

List all databases.

methodydb._grpc.v6.ydb_cms_v1_pb2_grpc.CmsServiceServicer.RemoveDatabase(request, context)

Remove database.

classydb._grpc.v6.ydb_cms_v1_pb2_grpc.CmsServiceStub

CMS stands for Cluster Management System.

methodydb._grpc.v6.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToS3(request, context)

Exports data to S3.

methodydb._grpc.v6.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToYt(request, context)

Exports data to YT.

methodydb._grpc.v6.ydb_topic_v1_pb2_grpc.TopicServiceServicer.AlterTopic(request, context)

Alter topic command.

methodydb._grpc.v6.ydb_topic_v1_pb2_grpc.TopicServiceServicer.CreateTopic(request, context)

Create topic command.

methodydb._grpc.v6.ydb_topic_v1_pb2_grpc.TopicServiceServicer.DropTopic(request, context)

Drop topic command.

classydb._topic_writer.topic_writer.PublicWriterSettings

Settings for topic writer.

funcydb._tx_ctx_impl.commit_request_factory(session_state, tx_state)

Constructs commit request

classydb._typing.GrpcStreamCall

Type for gRPC streaming call response.

funcydb._utilities.try_connect(endpoint:'resolver.EndpointInfo') -> Optional['resolver.EndpointInfo']

Try to connect to endpoint and return it if successful.

methodydb.aio.connection.Connection.connection_ready(ready_timeout:float=10) -> None

Awaits until channel is ready :return: None

classydb.aio.query.base.AsyncResponseContextIterator

Async ExecuteQuery result stream.

classydb.aio.query.session.QuerySession

Session object for Query Service.

classydb.aio.query.transaction.QueryTxContext

Asynchronous transaction context.

classydb.credentials.AbstractCredentials

An abstract class that provides auth metadata

classydb.driver.RPCCompression

Indicates the compression method to be used for an RPC.

funcydb.observability.disable_tracing() -> None

Reset the tracing backend to Noop.

funcydb.observability.enable_metrics(provider:MetricsProvider) -> None

Install *provider* as the active metrics backend.

funcydb.observability.enable_tracing(provider:TracingProvider) -> None

Install *provider* as the active tracing backend.

classydb.observability.metrics.MetricsProvider

Pluggable metrics backend.

classydb.observability.tracing.NoopSpan

Span implementation used while no provider is enabled.

classydb.observability.tracing.Span

Minimal span surface the SDK relies on.

classydb.observability.tracing.SpanName

Canonical span names used across the YDB SDK.

classydb.observability.tracing.TracingProvider

Pluggable tracing backend.

methodydb.pool.ConnectionPool.async_wait(fail_fast:bool=False) -> 'futures.Future[None]'

Returns a future to subscribe on endpoints availability.

methodydb.pool.ConnectionPool.discovery_debug_details() -> str

Returns debug string about last errors :return: str

classydb.query.base.SyncResponseContextIterator

Streams ExecuteQuery results.

classydb.query.session.QuerySession

Session object for Query Service.

classydb.query.transaction.QueryTxContext

Synchronous transaction context.

classydb.scheme.SchemeEntryType

Enumerates all available entry types.

methodydb.table.BaseSession.closing()

Returns True if session is closing.

methodydb.table.BaseSession.create_table(path, table_description, settings=None)

Create a YDB table.

methodydb.table.BaseSession.explain(yql_text, settings=None)

Expiremental API.

methodydb.table.BaseSession.session_id()

Return session_id.

methodydb.tracing.Tracer.default(tracer:Any) -> 'Tracer'

Create default tracer :param tracer: :return: new tracer

methodydb.types.StructType.add_member(name:str, member_type:typing.Union[AbstractTypeBuilder, PrimitiveType]) -> 'StructType'

:param name: :param member_type: :return:

About this data

These signatures were extracted from the public source of ydb-platform/ydb-python-sdk using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries