Skip to content

Commit

Permalink
try to combine sync and async api ref
Browse files Browse the repository at this point in the history
  • Loading branch information
vgvoleg committed Sep 10, 2024
1 parent 1850b73 commit e3d499e
Showing 1 changed file with 32 additions and 15 deletions.
47 changes: 32 additions & 15 deletions docs/apireference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit e3d499e

Please sign in to comment.