Skip to content

chore: add sample to set statement timeout within a transaciton #1384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
surbhigarg92 merged 1 commit into from
Jun 4, 2025
Merged

chore: add sample to set statement timeout within a transaciton #1384

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions samples/samples/snippets.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2540,6 +2540,32 @@ def read_then_write(transaction):
# [END spanner_transaction_timeout]


def set_statement_timeout(instance_id, database_id):
"""Executes a transaction with a statement timeout."""
# [START spanner_set_statement_timeout]
# instance_id = "your-spanner-instance"
# database_id = "your-spanner-db-id"
spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
database = instance.database(database_id)

def write(transaction):
# Insert a record and configure the statement timeout to 60 seconds
# This timeout can however ONLY BE SHORTER than the default timeout
# for the RPC. If you set a timeout that is longer than the default timeout,
# then the default timeout will be used.
row_ct = transaction.execute_update(
"INSERT INTO Singers (SingerId, FirstName, LastName) "
" VALUES (110, 'George', 'Washington')",
timeout=60,
)
print("{} record(s) inserted.".format(row_ct))

database.run_in_transaction(write)

# [END spanner_set_statement_timeout]


def set_request_tag(instance_id, database_id):
"""Executes a snapshot read with a request tag."""
# [START spanner_set_request_tag]
Expand Down Expand Up @@ -3651,6 +3677,7 @@ def add_split_points(instance_id, database_id):
subparsers.add_parser(
"set_transaction_timeout", help=set_transaction_timeout.__doc__
)
subparsers.add_parser("set_statement_timeout", help=set_statement_timeout.__doc__)
subparsers.add_parser(
"query_data_with_new_column", help=query_data_with_new_column.__doc__
)
Expand Down Expand Up @@ -3819,6 +3846,8 @@ def add_split_points(instance_id, database_id):
set_max_commit_delay(args.instance_id, args.database_id)
elif args.command == "set_transaction_timeout":
set_transaction_timeout(args.instance_id, args.database_id)
elif args.command == "set_statement_timeout":
set_statement_timeout(args.instance_id, args.database_id)
elif args.command == "query_data_with_new_column":
query_data_with_new_column(args.instance_id, args.database_id)
elif args.command == "read_write_transaction":
Expand Down
7 changes: 7 additions & 0 deletions samples/samples/snippets_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -862,6 +862,13 @@ def test_set_transaction_timeout(capsys, instance_id, sample_database):
assert "1 record(s) inserted." in out


@pytest.mark.dependency(depends=["insert_datatypes_data"])
def test_set_statement_timeout(capsys, instance_id, sample_database):
snippets.set_statement_timeout(instance_id, sample_database.database_id)
out, _ = capsys.readouterr()
assert "1 record(s) inserted." in out


@pytest.mark.dependency(depends=["insert_data"])
def test_set_request_tag(capsys, instance_id, sample_database):
snippets.set_request_tag(instance_id, sample_database.database_id)
Expand Down