From e3d499e0d00c586cff898e2940d24319d99d137d Mon Sep 17 00:00:00 2001 From: Oleg Ovcharuk Date: Tue, 10 Sep 2024 17:17:21 +0300 Subject: [PATCH] try to combine sync and async api ref --- docs/apireference.rst | 47 +++++++++++++++++++++++++++++-------------- 1 file changed, 32 insertions(+), 15 deletions(-) diff --git a/docs/apireference.rst b/docs/apireference.rst index 5e3ce93f..82960198 100644 --- a/docs/apireference.rst +++ b/docs/apireference.rst @@ -10,16 +10,20 @@ YDB API Reference Driver ------ -Driver object -~~~~~~~~~~~~~ - .. autoclass:: ydb.Driver :members: :inherited-members: :undoc-members: -Driver object (AsyncIO) +.. autoclass:: ydb.DriverConfig + :members: + :inherited-members: + :undoc-members: + :exclude-members: database, ca_cert, channel_options, secure_channel, endpoint, endpoints, credentials, use_all_nodes, root_certificates, certificate_chain, private_key, grpc_keep_alive_timeout, table_client_settings, primary_user_agent + + +AsyncIO ~~~~~~~~~~~~~ .. autoclass:: ydb.aio.Driver @@ -28,44 +32,57 @@ Driver object (AsyncIO) :undoc-members: -DriverConfig -~~~~~~~~~~~~ +------------------------ -.. autoclass:: ydb.DriverConfig +Common +------------- + +.. autoclass:: ydb.BaseRequestSettings :members: :inherited-members: :undoc-members: - :exclude-members: database, ca_cert, channel_options, secure_channel, endpoint, endpoints, credentials, use_all_nodes, root_certificates, certificate_chain, private_key, grpc_keep_alive_timeout, table_client_settings, primary_user_agent ------------------------ Query Service ------------- -QuerySessionPool -~~~~~~~~~~~~~~~~ - .. autoclass:: ydb.QuerySessionPool :members: :inherited-members: :undoc-members: -QuerySession -~~~~~~~~~~~~~~~~ .. autoclass:: ydb.QuerySession :members: :inherited-members: :undoc-members: -QueryTxContext -~~~~~~~~~~~~~~~~~~ .. autoclass:: ydb.QueryTxContext :members: :inherited-members: :undoc-members: + +AsyncIO +~~~~~~~ + +.. autoclass:: ydb.aio.QuerySessionPool + :members: + :inherited-members: + :undoc-members: + +.. autoclass:: ydb.aio.QuerySession + :members: + :inherited-members: + :undoc-members: + +.. autoclass:: ydb.aio.QueryTxContext + :members: + :inherited-members: + :undoc-members: + ------------------------ Table Service