Skip to content

Commit e3d499e

Browse files
committed
try to combine sync and async api ref
1 parent 1850b73 commit e3d499e

File tree

1 file changed

+32
-15
lines changed

1 file changed

+32
-15
lines changed

docs/apireference.rst

Lines changed: 32 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,20 @@ YDB API Reference
1010
Driver
1111
------
1212

13-
Driver object
14-
~~~~~~~~~~~~~
15-
1613
.. autoclass:: ydb.Driver
1714
:members:
1815
:inherited-members:
1916
:undoc-members:
2017

2118

22-
Driver object (AsyncIO)
19+
.. autoclass:: ydb.DriverConfig
20+
:members:
21+
:inherited-members:
22+
:undoc-members:
23+
: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
24+
25+
26+
AsyncIO
2327
~~~~~~~~~~~~~
2428

2529
.. autoclass:: ydb.aio.Driver
@@ -28,44 +32,57 @@ Driver object (AsyncIO)
2832
:undoc-members:
2933

3034

31-
DriverConfig
32-
~~~~~~~~~~~~
35+
------------------------
3336

34-
.. autoclass:: ydb.DriverConfig
37+
Common
38+
-------------
39+
40+
.. autoclass:: ydb.BaseRequestSettings
3541
:members:
3642
:inherited-members:
3743
:undoc-members:
38-
: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
3944

4045
------------------------
4146

4247
Query Service
4348
-------------
4449

45-
QuerySessionPool
46-
~~~~~~~~~~~~~~~~
47-
4850
.. autoclass:: ydb.QuerySessionPool
4951
:members:
5052
:inherited-members:
5153
:undoc-members:
5254

53-
QuerySession
54-
~~~~~~~~~~~~~~~~
5555

5656
.. autoclass:: ydb.QuerySession
5757
:members:
5858
:inherited-members:
5959
:undoc-members:
6060

61-
QueryTxContext
62-
~~~~~~~~~~~~~~~~~~
6361

6462
.. autoclass:: ydb.QueryTxContext
6563
:members:
6664
:inherited-members:
6765
:undoc-members:
6866

67+
68+
AsyncIO
69+
~~~~~~~
70+
71+
.. autoclass:: ydb.aio.QuerySessionPool
72+
:members:
73+
:inherited-members:
74+
:undoc-members:
75+
76+
.. autoclass:: ydb.aio.QuerySession
77+
:members:
78+
:inherited-members:
79+
:undoc-members:
80+
81+
.. autoclass:: ydb.aio.QueryTxContext
82+
:members:
83+
:inherited-members:
84+
:undoc-members:
85+
6986
------------------------
7087

7188
Table Service

0 commit comments

Comments
 (0)