Merge pull request #88 from ydb-platform/snapshot-ro-tx

add support for snapshot_read_only transactions

Author: Valeria1235

CHANGELOG.md

@@ -1,4 +1,5 @@
 * Fixed error message while get token from metadata with asyncio iam
+* Add `SnapshotReadOnly` transaction mode support to `session.transaction`
 
 ## 2.11.1 ##
 * Regenerate protobuf code from public api protos (some private protobufs was removed)

tests/aio/test_tx.py

@@ -1,4 +1,6 @@
 import pytest
+from contextlib import suppress
+
 import ydb.aio.iam
 
 
@@ -49,3 +51,46 @@ async def test_credentials():
         raised = True
 
     assert raised
+
+
+@pytest.mark.asyncio
+async def test_tx_snapshot_ro(driver, database):
+    session = await driver.table_client.session().create()
+    description = (
+        ydb.TableDescription()
+        .with_primary_keys("key")
+        .with_columns(
+            ydb.Column("key", ydb.OptionalType(ydb.PrimitiveType.Uint64)),
+            ydb.Column("value", ydb.OptionalType(ydb.PrimitiveType.Uint64)),
+        )
+    )
+    tb_name = f"{database}/test"
+    with suppress(ydb.issues.SchemeError):
+        await session.drop_table(tb_name)
+    await session.create_table(tb_name, description)
+    await session.transaction(ydb.SerializableReadWrite()).execute(
+        """INSERT INTO `test` (`key`, `value`) VALUES (1, 1), (2, 2)""",
+        commit_tx=True,
+    )
+
+    ro_tx = session.transaction(tx_mode=ydb.SnapshotReadOnly())
+    data1 = await ro_tx.execute("SELECT value FROM `test` WHERE key = 1")
+
+    await session.transaction(ydb.SerializableReadWrite()).execute(
+        "UPDATE `test` SET value = value + 1", commit_tx=True
+    )
+
+    data2 = await ro_tx.execute("SELECT value FROM `test` WHERE key = 1")
+    assert data1[0].rows == data2[0].rows == [{"value": 1}]
+
+    await ro_tx.commit()
+
+    with pytest.raises(ydb.issues.GenericError) as exc_info:
+        await ro_tx.execute("UPDATE `test` SET value = value + 1")
+    assert "read only transaction" in exc_info.value.message
+
+    data = await session.transaction(tx_mode=ydb.SnapshotReadOnly()).execute(
+        "SELECT value FROM `test` WHERE key = 1",
+        commit_tx=True,
+    )
+    assert data[0].rows == [{"value": 2}]

ydb/table.py

@@ -780,6 +780,22 @@ def settings(self):
         pass
 
 
+class SnapshotReadOnly(AbstractTransactionModeBuilder):
+    __slots__ = ("_pb", "_name")
+
+    def __init__(self):
+        self._pb = _apis.ydb_table.SnapshotModeSettings()
+        self._name = "snapshot_read_only"
+
+    @property
+    def settings(self):
+        return self._pb
+
+    @property
+    def name(self):
+        return self._name
+
+
 class SerializableReadWrite(AbstractTransactionModeBuilder):
     __slots__ = ("_pb", "_name")