diff --git a/spanner/change_streams/src/spanner_change_streams/set_exclude_txn_from_change_streams.py b/spanner/change_streams/src/spanner_change_streams/set_exclude_txn_from_change_streams.py new file mode 100644 index 0000000000..ede602f698 --- /dev/null +++ b/spanner/change_streams/src/spanner_change_streams/set_exclude_txn_from_change_streams.py @@ -0,0 +1,105 @@ +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# [START spanner_set_exclude_txn_from_change_streams] +import sys + +from google.api_core import exceptions +from google.cloud import spanner +from google.cloud import spanner_v1 + + +def set_exclude_txn_from_change_streams( + project_id: str, instance_id: str, database_id: str +) -> None: + """Runs a read-write transaction excluded from change stream capture. + + Only change streams created or altered with `allow_txn_exclusion = true` + honor transaction-level exclusion. + + Args: + project_id: The Google Cloud project ID. + instance_id: The Spanner instance ID. + database_id: The Spanner database ID containing Singers and a change + stream with allow_txn_exclusion = true. + """ + client = spanner.Client(project=project_id) + database = client.instance(instance_id).database(database_id) + modified_statements = 0 + + def insert_and_update_singer(transaction: spanner_v1.Transaction) -> None: + nonlocal modified_statements + inserted = transaction.execute_update(""" + INSERT OR UPDATE Singers (SingerId, FirstName, LastName) + VALUES (101, ' Virginia', 'Watson') + """) + updated = transaction.execute_update( + "UPDATE Singers SET FirstName = 'Virginia' WHERE SingerId = 101" + ) + modified_statements = int(inserted) + int(updated) + + try: + database.run_in_transaction( + insert_and_update_singer, + exclude_txn_from_change_streams=True, + ) + except exceptions.NotFound as err: + print( + f"error: database '{database_id}' on instance '{instance_id}' " + f"was not found: {err.message}", + file=sys.stderr, + ) + except exceptions.GoogleAPICallError as err: + print( + f"error: change-stream excluded transaction failed on database " + f"'{database_id}' in instance '{instance_id}': {err.message}", + file=sys.stderr, + ) + else: + print(f"Resource ID: {database_id}") + print(f"Modified Statements: {modified_statements}") + + +# [END spanner_set_exclude_txn_from_change_streams] + + +if __name__ == "__main__": + import argparse + import os + + parser = argparse.ArgumentParser( + description="Exclude a read-write Spanner transaction from change streams." + ) + parser.add_argument( + "--project-id", + default=os.environ.get("GOOGLE_CLOUD_PROJECT", "example-project-id"), + help="Google Cloud project ID (default: $GOOGLE_CLOUD_PROJECT)", + ) + parser.add_argument( + "--instance-id", + default=os.environ.get("SPANNER_INSTANCE_ID", "example-instance"), + help="Spanner instance ID (default: $SPANNER_INSTANCE_ID)", + ) + parser.add_argument( + "--database-id", + default=os.environ.get("SPANNER_DATABASE_ID", "example-db"), + help="Spanner database ID (default: $SPANNER_DATABASE_ID)", + ) + args = parser.parse_args() + + set_exclude_txn_from_change_streams( + project_id=args.project_id, + instance_id=args.instance_id, + database_id=args.database_id, + ) diff --git a/spanner/change_streams/tests/set_exclude_txn_from_change_streams_test.py b/spanner/change_streams/tests/set_exclude_txn_from_change_streams_test.py new file mode 100644 index 0000000000..89ae9089a3 --- /dev/null +++ b/spanner/change_streams/tests/set_exclude_txn_from_change_streams_test.py @@ -0,0 +1,155 @@ +# Copyright 2026 Google LLC +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from collections.abc import Callable +import runpy +from unittest import mock + +from google.api_core import exceptions +from google.cloud import spanner +from google.cloud.spanner_v1 import KeySet +import pytest +from spanner_change_streams import set_exclude_txn_from_change_streams + +from . import conftest + +PROJECT_ID = "example-project-id" +INSTANCE_ID = "example-instance" +DATABASE_ID = "example-db" +DATABASE_NAME = f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" +SPANNER_CLIENT = "google.cloud.spanner.Client" + + +@mock.patch(SPANNER_CLIENT) +def test_set_exclude_txn_from_change_streams_success( + mock_client_class: mock.MagicMock, capsys: pytest.CaptureFixture[str] +) -> None: + database = ( + mock_client_class.return_value.instance.return_value.database.return_value + ) + database.name = DATABASE_NAME + transaction = mock.MagicMock() + transaction.execute_update.side_effect = [1, 1] + + def run_txn( + fn: Callable[[mock.MagicMock], None], + exclude_txn_from_change_streams: bool = False, + ) -> None: + assert exclude_txn_from_change_streams is True + fn(transaction) + + database.run_in_transaction.side_effect = run_txn + + set_exclude_txn_from_change_streams.set_exclude_txn_from_change_streams( + PROJECT_ID, INSTANCE_ID, DATABASE_ID + ) + + out, err = capsys.readouterr() + assert f"Resource ID: {DATABASE_ID}" in out + assert PROJECT_ID not in out + assert "Modified Statements: 2" in out + assert err == "" + + +@pytest.mark.parametrize( + "error, expected_prefix", + [ + ( + exceptions.NotFound("db missing"), + "error: database 'example-db' on instance 'example-instance'", + ), + ( + exceptions.Aborted("aborted"), + "error: change-stream excluded transaction failed", + ), + ], +) +@mock.patch(SPANNER_CLIENT) +def test_set_exclude_txn_from_change_streams_errors( + mock_client_class: mock.MagicMock, + capsys: pytest.CaptureFixture[str], + error: Exception, + expected_prefix: str, +) -> None: + database = ( + mock_client_class.return_value.instance.return_value.database.return_value + ) + database.run_in_transaction.side_effect = error + + set_exclude_txn_from_change_streams.set_exclude_txn_from_change_streams( + PROJECT_ID, INSTANCE_ID, DATABASE_ID + ) + + out, err = capsys.readouterr() + assert out == "" + assert err.startswith(expected_prefix) + assert PROJECT_ID not in err + assert PROJECT_ID not in err + + +@mock.patch(SPANNER_CLIENT) +def test_set_exclude_txn_from_change_streams_cli_entrypoint( + mock_client_class: mock.MagicMock, + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + database = ( + mock_client_class.return_value.instance.return_value.database.return_value + ) + database.name = DATABASE_NAME + transaction = mock.MagicMock() + transaction.execute_update.side_effect = [1, 1] + database.run_in_transaction.side_effect = lambda fn, **_kw: fn(transaction) + monkeypatch.setattr( + "sys.argv", + [ + "set_exclude_txn_from_change_streams.py", + "--project-id", + PROJECT_ID, + "--instance-id", + INSTANCE_ID, + "--database-id", + DATABASE_ID, + ], + ) + + runpy.run_module( + "spanner_change_streams.set_exclude_txn_from_change_streams", + run_name="__main__", + ) + + assert "Modified Statements: 2" in capsys.readouterr().out + + +@conftest.live_only +def test_set_exclude_txn_from_change_streams_live( + capsys: pytest.CaptureFixture[str], +) -> None: + client = spanner.Client(project=conftest.LIVE_PROJECT_ID) + database = client.instance(conftest.LIVE_INSTANCE_ID).database( + conftest.LIVE_DATABASE_ID + ) + try: + set_exclude_txn_from_change_streams.set_exclude_txn_from_change_streams( + conftest.LIVE_PROJECT_ID, + conftest.LIVE_INSTANCE_ID, + conftest.LIVE_DATABASE_ID, + ) + out, err = capsys.readouterr() + assert err == "" + assert conftest.LIVE_PROJECT_ID not in out + assert "Modified Statements: 2" in out + finally: + with database.batch() as batch: + batch.delete(table="Singers", keyset=KeySet(keys=[[101]]))