Add query tx modes to docs

ydb-platform · Sep 10, 2024 · 2714e5a · 2714e5a
1 parent 3f81746
commit 2714e5a
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 1 deletion.
diff --git a/docs/apireference.rst b/docs/apireference.rst
@@ -128,6 +128,39 @@ QueryTxContext (AsyncIO)
     :undoc-members:
 
 
+Query Tx Mode
+^^^^^^^^^^^^^
+
+.. autoclass:: ydb.BaseQueryTxMode
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+
+.. autoclass:: ydb.QueryOnlineReadOnly
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+
+.. autoclass:: ydb.QuerySerializableReadWrite
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+
+.. autoclass:: ydb.QuerySnapshotReadOnly
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+
+.. autoclass:: ydb.QueryStaleReadOnly
+    :members:
+    :inherited-members:
+    :undoc-members:
+
+
 ------------------------
 
 Table Service

diff --git a/ydb/query/__init__.py b/ydb/query/__init__.py
@@ -1,10 +1,11 @@
 __all__ = [
+    "BaseQueryTxMode",
     "QueryOnlineReadOnly",
     "QuerySerializableReadWrite",
     "QuerySnapshotReadOnly",
     "QueryStaleReadOnly",
     "QuerySessionPool",
-    "QueryClientSync",
+    "QueryClientSettings",
     "QuerySession",
     "QueryTxContext",
 ]
@@ -20,6 +21,7 @@
 
 from .._grpc.grpcwrapper import common_utils
 from .._grpc.grpcwrapper.ydb_query_public_types import (
+    BaseQueryTxMode,
     QueryOnlineReadOnly,
     QuerySerializableReadWrite,
     QuerySnapshotReadOnly,