samples: add a sample for the max commit delay feature (#1097)

* Add a sample

* Small addition.

* Change sample to a transactional sample.

* Comments

* feat(spanner): update snippet tag position

* fix test output

---------

Co-authored-by: Sri Harsha CH <[email protected]>
Co-authored-by: Sri Harsha CH <[email protected]>

Author: nginsberg-google

samples/samples/snippets.py

@@ -1527,6 +1527,29 @@ def insert_singers(transaction):
 # [END spanner_get_commit_stats]
 
 
+def set_max_commit_delay(instance_id, database_id):
+    """Inserts sample data and sets a max commit delay."""
+    # [START spanner_set_max_commit_delay]
+    # 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 insert_singers(transaction):
+        row_ct = transaction.execute_update(
+            "INSERT Singers (SingerId, FirstName, LastName) "
+            " VALUES (111, 'Grace', 'Bennis')"
+        )
+
+        print("{} record(s) inserted.".format(row_ct))
+
+    database.run_in_transaction(
+        insert_singers, max_commit_delay=datetime.timedelta(milliseconds=100)
+    )
+    # [END spanner_set_max_commit_delay]
+
+
 def update_data_with_dml(instance_id, database_id):
     """Updates sample data from the database using a DML statement."""
     # [START spanner_dml_standard_update]
@@ -3082,6 +3105,7 @@ def set_custom_timeout_and_retry(instance_id, database_id):
     subparsers.add_parser("read_stale_data", help=read_stale_data.__doc__)
     subparsers.add_parser("add_column", help=add_column.__doc__)
     subparsers.add_parser("update_data", help=update_data.__doc__)
+    subparsers.add_parser("set_max_commit_delay", help=set_max_commit_delay.__doc__)
     subparsers.add_parser(
         "query_data_with_new_column", help=query_data_with_new_column.__doc__
     )
@@ -3228,6 +3252,8 @@ def set_custom_timeout_and_retry(instance_id, database_id):
         add_column(args.instance_id, args.database_id)
     elif args.command == "update_data":
         update_data(args.instance_id, args.database_id)
+    elif args.command == "set_max_commit_delay":
+        set_max_commit_delay(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":

samples/samples/snippets_test.py

@@ -499,6 +499,13 @@ def test_log_commit_stats(capsys, instance_id, sample_database):
     assert "4 mutation(s) in transaction." in out
 
 
+@pytest.mark.dependency(name="set_max_commit_delay")
+def test_set_max_commit_delay(capsys, instance_id, sample_database):
+    snippets.set_max_commit_delay(instance_id, sample_database.database_id)
+    out, _ = capsys.readouterr()
+    assert "1 record(s) inserted." in out
+
+
 @pytest.mark.dependency(depends=["insert_data"])
 def test_update_data_with_dml(capsys, instance_id, sample_database):
     snippets.update_data_with_dml(instance_id, sample_database.database_id)
@@ -588,7 +595,7 @@ def update_data_with_partitioned_dml(capsys, instance_id, sample_database):
 def test_delete_data_with_partitioned_dml(capsys, instance_id, sample_database):
     snippets.delete_data_with_partitioned_dml(instance_id, sample_database.database_id)
     out, _ = capsys.readouterr()
-    assert "6 record(s) deleted" in out
+    assert "7 record(s) deleted" in out
 
 
 @pytest.mark.dependency(depends=["add_column"])