ydb-python-sdk の API リファレンス
ydb-python-sdk (ydb-platform/ydb-python-sdk) の公開 API 86 件 —— クラス 44、関数 5、メソッド 37。実際のソースを静的解析して抽出した正確なシグネチャを掲載しています。
リポジトリ: ydb-platform/ydb-python-sdk
| 種別 | 件数 |
|---|---|
| クラス | 44 |
| 関数 | 5 |
| メソッド | 37 |
API 一覧
class
ydb._grpc.grpcwrapper.ydb_query_public_types.ArrowFormatSettingsSettings for Arrow format result sets.
class
ydb._grpc.grpcwrapper.ydb_query_public_types.BaseQueryTxModeAbstract class for Query Transaction Modes.
class
ydb._grpc.grpcwrapper.ydb_topic.OffsetsRangehalf-opened interval, include [start, end) offsets
class
ydb._grpc.grpcwrapper.ydb_topic_public_types.PublicCodecCodec value may contain any int number.
class
ydb._grpc.v3.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceService for managing cluster in bridge mode
class
ydb._grpc.v3.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceServicerService for managing cluster in bridge mode
class
ydb._grpc.v3.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceStubService for managing cluster in bridge mode
class
ydb._grpc.v3.ydb_cms_v1_pb2_grpc.CmsServiceCMS stands for Cluster Management System.
class
ydb._grpc.v3.ydb_cms_v1_pb2_grpc.CmsServiceServicerCMS stands for Cluster Management System.
method
ydb._grpc.v3.ydb_cms_v1_pb2_grpc.CmsServiceServicer.ListDatabases(request, context)List all databases.
method
ydb._grpc.v3.ydb_cms_v1_pb2_grpc.CmsServiceServicer.RemoveDatabase(request, context)Remove database.
class
ydb._grpc.v3.ydb_cms_v1_pb2_grpc.CmsServiceStubCMS stands for Cluster Management System.
method
ydb._grpc.v3.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToS3(request, context)Exports data to S3.
method
ydb._grpc.v3.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToYt(request, context)Exports data to YT.
method
ydb._grpc.v3.ydb_topic_v1_pb2_grpc.TopicServiceServicer.AlterTopic(request, context)Alter topic command.
method
ydb._grpc.v3.ydb_topic_v1_pb2_grpc.TopicServiceServicer.CreateTopic(request, context)Create topic command.
method
ydb._grpc.v3.ydb_topic_v1_pb2_grpc.TopicServiceServicer.DropTopic(request, context)Drop topic command.
class
ydb._grpc.v4.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceService for managing cluster in bridge mode
class
ydb._grpc.v4.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceServicerService for managing cluster in bridge mode
class
ydb._grpc.v4.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceStubService for managing cluster in bridge mode
class
ydb._grpc.v4.ydb_cms_v1_pb2_grpc.CmsServiceCMS stands for Cluster Management System.
class
ydb._grpc.v4.ydb_cms_v1_pb2_grpc.CmsServiceServicerCMS stands for Cluster Management System.
method
ydb._grpc.v4.ydb_cms_v1_pb2_grpc.CmsServiceServicer.ListDatabases(request, context)List all databases.
method
ydb._grpc.v4.ydb_cms_v1_pb2_grpc.CmsServiceServicer.RemoveDatabase(request, context)Remove database.
class
ydb._grpc.v4.ydb_cms_v1_pb2_grpc.CmsServiceStubCMS stands for Cluster Management System.
method
ydb._grpc.v4.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToS3(request, context)Exports data to S3.
method
ydb._grpc.v4.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToYt(request, context)Exports data to YT.
method
ydb._grpc.v4.ydb_topic_v1_pb2_grpc.TopicServiceServicer.AlterTopic(request, context)Alter topic command.
method
ydb._grpc.v4.ydb_topic_v1_pb2_grpc.TopicServiceServicer.CreateTopic(request, context)Create topic command.
method
ydb._grpc.v4.ydb_topic_v1_pb2_grpc.TopicServiceServicer.DropTopic(request, context)Drop topic command.
class
ydb._grpc.v5.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceService for managing cluster in bridge mode
class
ydb._grpc.v5.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceServicerService for managing cluster in bridge mode
class
ydb._grpc.v5.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceStubService for managing cluster in bridge mode
class
ydb._grpc.v5.ydb_cms_v1_pb2_grpc.CmsServiceCMS stands for Cluster Management System.
class
ydb._grpc.v5.ydb_cms_v1_pb2_grpc.CmsServiceServicerCMS stands for Cluster Management System.
method
ydb._grpc.v5.ydb_cms_v1_pb2_grpc.CmsServiceServicer.ListDatabases(request, context)List all databases.
method
ydb._grpc.v5.ydb_cms_v1_pb2_grpc.CmsServiceServicer.RemoveDatabase(request, context)Remove database.
class
ydb._grpc.v5.ydb_cms_v1_pb2_grpc.CmsServiceStubCMS stands for Cluster Management System.
method
ydb._grpc.v5.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToS3(request, context)Exports data to S3.
method
ydb._grpc.v5.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToYt(request, context)Exports data to YT.
method
ydb._grpc.v5.ydb_topic_v1_pb2_grpc.TopicServiceServicer.AlterTopic(request, context)Alter topic command.
method
ydb._grpc.v5.ydb_topic_v1_pb2_grpc.TopicServiceServicer.CreateTopic(request, context)Create topic command.
method
ydb._grpc.v5.ydb_topic_v1_pb2_grpc.TopicServiceServicer.DropTopic(request, context)Drop topic command.
class
ydb._grpc.v6.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceService for managing cluster in bridge mode
class
ydb._grpc.v6.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceServicerService for managing cluster in bridge mode
class
ydb._grpc.v6.draft.ydb_bridge_v1_pb2_grpc.BridgeServiceStubService for managing cluster in bridge mode
class
ydb._grpc.v6.ydb_cms_v1_pb2_grpc.CmsServiceCMS stands for Cluster Management System.
class
ydb._grpc.v6.ydb_cms_v1_pb2_grpc.CmsServiceServicerCMS stands for Cluster Management System.
method
ydb._grpc.v6.ydb_cms_v1_pb2_grpc.CmsServiceServicer.ListDatabases(request, context)List all databases.
method
ydb._grpc.v6.ydb_cms_v1_pb2_grpc.CmsServiceServicer.RemoveDatabase(request, context)Remove database.
class
ydb._grpc.v6.ydb_cms_v1_pb2_grpc.CmsServiceStubCMS stands for Cluster Management System.
method
ydb._grpc.v6.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToS3(request, context)Exports data to S3.
method
ydb._grpc.v6.ydb_export_v1_pb2_grpc.ExportServiceServicer.ExportToYt(request, context)Exports data to YT.
method
ydb._grpc.v6.ydb_topic_v1_pb2_grpc.TopicServiceServicer.AlterTopic(request, context)Alter topic command.
method
ydb._grpc.v6.ydb_topic_v1_pb2_grpc.TopicServiceServicer.CreateTopic(request, context)Create topic command.
method
ydb._grpc.v6.ydb_topic_v1_pb2_grpc.TopicServiceServicer.DropTopic(request, context)Drop topic command.
class
ydb._topic_writer.topic_writer.PublicWriterSettingsSettings for topic writer.
func
ydb._tx_ctx_impl.commit_request_factory(session_state, tx_state)Constructs commit request
class
ydb._typing.GrpcStreamCallType for gRPC streaming call response.
func
ydb._utilities.try_connect(endpoint:'resolver.EndpointInfo') -> Optional['resolver.EndpointInfo']Try to connect to endpoint and return it if successful.
method
ydb.aio.connection.Connection.connection_ready(ready_timeout:float=10) -> NoneAwaits until channel is ready :return: None
class
ydb.aio.query.base.AsyncResponseContextIteratorAsync ExecuteQuery result stream.
class
ydb.aio.query.session.QuerySessionSession object for Query Service.
class
ydb.aio.query.transaction.QueryTxContextAsynchronous transaction context.
class
ydb.credentials.AbstractCredentialsAn abstract class that provides auth metadata
class
ydb.driver.RPCCompressionIndicates the compression method to be used for an RPC.
func
ydb.observability.disable_tracing() -> NoneReset the tracing backend to Noop.
func
ydb.observability.enable_metrics(provider:MetricsProvider) -> NoneInstall *provider* as the active metrics backend.
func
ydb.observability.enable_tracing(provider:TracingProvider) -> NoneInstall *provider* as the active tracing backend.
class
ydb.observability.metrics.MetricsProviderPluggable metrics backend.
class
ydb.observability.tracing.NoopSpanSpan implementation used while no provider is enabled.
class
ydb.observability.tracing.SpanMinimal span surface the SDK relies on.
class
ydb.observability.tracing.SpanNameCanonical span names used across the YDB SDK.
class
ydb.observability.tracing.TracingProviderPluggable tracing backend.
method
ydb.pool.ConnectionPool.async_wait(fail_fast:bool=False) -> 'futures.Future[None]'Returns a future to subscribe on endpoints availability.
method
ydb.pool.ConnectionPool.discovery_debug_details() -> strReturns debug string about last errors :return: str
class
ydb.query.base.SyncResponseContextIteratorStreams ExecuteQuery results.
class
ydb.query.session.QuerySessionSession object for Query Service.
class
ydb.query.transaction.QueryTxContextSynchronous transaction context.
class
ydb.scheme.SchemeEntryTypeEnumerates all available entry types.
method
ydb.table.BaseSession.closing()Returns True if session is closing.
method
ydb.table.BaseSession.create_table(path, table_description, settings=None)Create a YDB table.
method
ydb.table.BaseSession.explain(yql_text, settings=None)Expiremental API.
method
ydb.table.BaseSession.session_id()Return session_id.
method
ydb.tracing.Tracer.default(tracer:Any) -> 'Tracer'Create default tracer :param tracer: :return: new tracer
method
ydb.types.StructType.add_member(name:str, member_type:typing.Union[AbstractTypeBuilder, PrimitiveType]) -> 'StructType':param name: :param member_type: :return:
この情報について
掲載しているシグネチャは ydb-platform/ydb-python-sdk の公開ソースコードを
Python の ast モジュールで静的解析し、引数名・デフォルト値・
型注釈・戻り値型をそのまま抽出したものです。実装コードは保存していません。
詳しくは仕組みの解説をご覧ください。