From db30bdebbbb186d4ef9e15302a672682b7158f83 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Wed, 18 Nov 2026 04:51:09 +0000 Subject: [PATCH 1/3] feat(spanner): Add PostgreSQL bit-reversed sequence creation sample PostgreSQL-dialect primary keys avoid write hotspots using BIT_REVERSED_POSITIVE sequences with nextval('Seq') defaults. Add spanner_postgresql_create_sequence creating Seq and inserting Customers. --- .../postgresql_create_sequence.py | 117 +++++++++++ .../tests/postgresql_create_sequence_test.py | 184 ++++++++++++++++++ 2 files changed, 301 insertions(+) create mode 100644 spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py create mode 100644 spanner/postgresql/tests/postgresql_create_sequence_test.py diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py b/spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py new file mode 100644 index 0000000000..f9d1b209d3 --- /dev/null +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py @@ -0,0 +1,117 @@ +# 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_postgresql_create_sequence] +import sys + +from google.api_core import exceptions +from google.cloud import spanner +from google.cloud import spanner_admin_database_v1 +from google.cloud import spanner_v1 + + +def create_postgresql_sequence( + project_id: str, instance_id: str, database_id: str +) -> None: + """Creates a bit-reversed PostgreSQL sequence and inserts rows via RETURNING. + + Args: + project_id: The Google Cloud project ID. + instance_id: The Spanner instance ID. + database_id: The PostgreSQL-dialect Spanner database ID. + """ + admin_client = spanner_admin_database_v1.DatabaseAdminClient() + database_path = admin_client.database_path(project_id, instance_id, database_id) + ddl_request = spanner_admin_database_v1.UpdateDatabaseDdlRequest( + database=database_path, + statements=[ + "CREATE SEQUENCE Seq BIT_REVERSED_POSITIVE", + "CREATE TABLE Customers (" + " CustomerId bigint DEFAULT nextval('Seq')," + " CustomerName character varying(1024)," + " PRIMARY KEY (CustomerId)" + ")", + ], + ) + client = spanner.Client(project=project_id) + database = client.instance(instance_id).database(database_id) + customer_ids: list[int] = [] + + def insert_customers(transaction: spanner_v1.transaction.Transaction) -> None: + nonlocal customer_ids + rows = list( + transaction.execute_sql( + "INSERT INTO Customers (CustomerName) VALUES " + "('Alice'), ('David'), ('Marc') " + "RETURNING CustomerId" + ) + ) + customer_ids = [int(row[0]) for row in rows] + + try: + operation = admin_client.update_database_ddl(request=ddl_request) + print(f"Waiting for PostgreSQL sequence 'Seq' creation on '{database_id}'...") + operation.result(timeout=300) + database.run_in_transaction(insert_customers) + except (exceptions.AlreadyExists, exceptions.FailedPrecondition) as err: + print( + f"error: sequence 'Seq' or table 'Customers' already exists on " + f"database '{database_id}' in instance '{instance_id}': {err.message}", + file=sys.stderr, + ) + except exceptions.GoogleAPICallError as err: + print( + f"error: failed to create PostgreSQL sequence on database " + f"'{database_id}' in instance '{instance_id}': {err.message}", + file=sys.stderr, + ) + else: + print(f"Resource ID: {database_id}") + for cid in customer_ids: + print(f"Customer ID: {cid}") + print(f"Inserted Customers: {len(customer_ids)}") + + +# [END spanner_postgresql_create_sequence] + + +if __name__ == "__main__": + import argparse + import os + + parser = argparse.ArgumentParser( + description="Create a bit-reversed PostgreSQL sequence and insert Customers rows." + ) + 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_PG_DATABASE_ID", "example-db"), + help="Spanner database ID", + ) + args = parser.parse_args() + + create_postgresql_sequence( + project_id=args.project_id, + instance_id=args.instance_id, + database_id=args.database_id, + ) diff --git a/spanner/postgresql/tests/postgresql_create_sequence_test.py b/spanner/postgresql/tests/postgresql_create_sequence_test.py new file mode 100644 index 0000000000..7cf0b41a95 --- /dev/null +++ b/spanner/postgresql/tests/postgresql_create_sequence_test.py @@ -0,0 +1,184 @@ +# 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. + +import runpy +from unittest import mock + +from google.api_core import exceptions +from google.cloud import spanner_admin_database_v1 +import pytest +from spanner_postgresql import postgresql_create_sequence +from spanner_postgresql import postgresql_drop_sequence + +from . import conftest + +PROJECT_ID = "example-project-id" +INSTANCE_ID = "example-instance" +DATABASE_ID = "example-pg-db" +ADMIN_CLIENT = "google.cloud.spanner_admin_database_v1.DatabaseAdminClient" +SPANNER_CLIENT = "google.cloud.spanner.Client" + + +def _setup_txn(mock_client_class: mock.MagicMock) -> mock.MagicMock: + database = ( + mock_client_class.return_value.instance.return_value.database.return_value + ) + txn = mock.MagicMock() + database.run_in_transaction.side_effect = lambda fn, *a, **kw: fn(txn) + return txn + + +@mock.patch(SPANNER_CLIENT) +@mock.patch(ADMIN_CLIENT) +def test_create_postgresql_sequence_success( + mock_admin_class: mock.MagicMock, + mock_client_class: mock.MagicMock, + capsys: pytest.CaptureFixture[str], +) -> None: + mock_admin_class.return_value.instance_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}" + ) + mock_admin_class.return_value.database_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" + ) + txn = _setup_txn(mock_client_class) + txn.execute_sql.return_value = [(101,), (202,), (303,)] + + postgresql_create_sequence.create_postgresql_sequence( + PROJECT_ID, INSTANCE_ID, DATABASE_ID + ) + + mock_admin_class.return_value.update_database_ddl.assert_called_once() + out, err = capsys.readouterr() + assert f"Resource ID: {DATABASE_ID}" in out + assert "Customer ID: 101" in out + assert "Inserted Customers: 3" in out + assert PROJECT_ID not in out + assert err == "" + + +@pytest.mark.parametrize( + "error, expected_prefix", + [ + ( + exceptions.FailedPrecondition("exists"), + "error: sequence 'Seq' or table 'Customers' already exists", + ), + ( + exceptions.PermissionDenied("denied"), + "error: failed to create PostgreSQL sequence", + ), + ], +) +@mock.patch(SPANNER_CLIENT) +@mock.patch(ADMIN_CLIENT) +def test_create_postgresql_sequence_errors( + mock_admin_class: mock.MagicMock, + mock_client_class: mock.MagicMock, + capsys: pytest.CaptureFixture[str], + error: Exception, + expected_prefix: str, +) -> None: + mock_admin_class.return_value.instance_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}" + ) + mock_admin_class.return_value.database_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" + ) + mock_admin_class.return_value.update_database_ddl.side_effect = error + + postgresql_create_sequence.create_postgresql_sequence( + PROJECT_ID, INSTANCE_ID, DATABASE_ID + ) + + _out, err = capsys.readouterr() + assert err.startswith(expected_prefix) + assert PROJECT_ID not in err + + +@mock.patch(SPANNER_CLIENT) +@mock.patch(ADMIN_CLIENT) +def test_create_postgresql_sequence_cli_entrypoint( + mock_admin_class: mock.MagicMock, + mock_client_class: mock.MagicMock, + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + mock_admin_class.return_value.instance_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}" + ) + mock_admin_class.return_value.database_path.return_value = ( + f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" + ) + txn = _setup_txn(mock_client_class) + txn.execute_sql.return_value = [(101,), (202,), (303,)] + monkeypatch.setattr( + "sys.argv", + [ + "postgresql_create_sequence.py", + "--project-id", + PROJECT_ID, + "--instance-id", + INSTANCE_ID, + "--database-id", + DATABASE_ID, + ], + ) + + runpy.run_module( + "spanner_postgresql.postgresql_create_sequence", run_name="__main__" + ) + + assert "Inserted Customers: 3" in capsys.readouterr().out + + +@conftest.live_only +def test_create_postgresql_sequence_live(capsys: pytest.CaptureFixture[str]) -> None: + admin = spanner_admin_database_v1.DatabaseAdminClient() + db_path = admin.database_path( + conftest.LIVE_PROJECT_ID, + conftest.LIVE_INSTANCE_ID, + conftest.LIVE_DATABASE_ID, + ) + admin.update_database_ddl( + request={ + "database": db_path, + "statements": [ + "DROP TABLE IF EXISTS Customers", + "DROP SEQUENCE IF EXISTS Seq", + ], + } + ).result(timeout=240) + try: + postgresql_create_sequence.create_postgresql_sequence( + 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 "Inserted Customers: 3" in out + finally: + postgresql_drop_sequence.drop_postgresql_sequence( + conftest.LIVE_PROJECT_ID, + conftest.LIVE_INSTANCE_ID, + conftest.LIVE_DATABASE_ID, + ) + admin.update_database_ddl( + request={ + "database": db_path, + "statements": ["DROP TABLE IF EXISTS Customers"], + } + ).result(timeout=240) From 8935efeddfc0750e3fe06d1363c81ba62cb1cc44 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Wed, 18 Nov 2026 21:42:49 +0000 Subject: [PATCH 2/3] fix(spanner): address review feedback for postgresql_create_sequence Problem: review of this sample identified correctness and robustness improvements in the sample and its tests. Solution: apply the accepted review suggestions and extend the tests to cover the updated behavior. Details are in the review thread replies. Files updated: - spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py - spanner/postgresql/tests/postgresql_create_sequence_test.py --- .../src/spanner_postgresql/postgresql_create_sequence.py | 7 +++++++ .../postgresql/tests/postgresql_create_sequence_test.py | 4 ++++ 2 files changed, 11 insertions(+) diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py b/spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py index f9d1b209d3..95fec5eaa2 100644 --- a/spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py @@ -70,6 +70,13 @@ def insert_customers(transaction: spanner_v1.transaction.Transaction) -> None: f"database '{database_id}' in instance '{instance_id}': {err.message}", file=sys.stderr, ) + except TimeoutError as err: + print( + f"error: timed out waiting to create PostgreSQL sequence 'Seq' on " + f"database '{database_id}' in instance '{instance_id}'; the " + f"operation may still be running: {err}", + file=sys.stderr, + ) except exceptions.GoogleAPICallError as err: print( f"error: failed to create PostgreSQL sequence on database " diff --git a/spanner/postgresql/tests/postgresql_create_sequence_test.py b/spanner/postgresql/tests/postgresql_create_sequence_test.py index 7cf0b41a95..090ff4839a 100644 --- a/spanner/postgresql/tests/postgresql_create_sequence_test.py +++ b/spanner/postgresql/tests/postgresql_create_sequence_test.py @@ -75,6 +75,10 @@ def test_create_postgresql_sequence_success( exceptions.FailedPrecondition("exists"), "error: sequence 'Seq' or table 'Customers' already exists", ), + ( + TimeoutError("deadline"), + "error: timed out waiting to create PostgreSQL sequence 'Seq'", + ), ( exceptions.PermissionDenied("denied"), "error: failed to create PostgreSQL sequence", From 096a23e046a00c0933cdef98f73b4bf5032e9be8 Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Thu, 19 Nov 2026 04:44:04 +0000 Subject: [PATCH 3/3] style(spanner): use triple-quoted SQL strings in postgresql_create_sequence Problem: multi-line SQL and DDL statements were written as adjacent string fragments. That style is easy to get wrong (a missing trailing space joins two SQL tokens) and is harder to read than the statement itself, and the samples in this set mixed it with triple-quoted SQL. Solution: write each multi-line statement as a single triple-quoted string, matching the layout already used by the other samples. Only whitespace between SQL tokens changes; the statements are otherwise identical. Files updated: - spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py --- .../postgresql_create_sequence.py | 24 +++++++++---------- 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py b/spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py index 95fec5eaa2..559c04807a 100644 --- a/spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_create_sequence.py @@ -37,11 +37,13 @@ def create_postgresql_sequence( database=database_path, statements=[ "CREATE SEQUENCE Seq BIT_REVERSED_POSITIVE", - "CREATE TABLE Customers (" - " CustomerId bigint DEFAULT nextval('Seq')," - " CustomerName character varying(1024)," - " PRIMARY KEY (CustomerId)" - ")", + """ + CREATE TABLE Customers ( + CustomerId bigint DEFAULT nextval('Seq'), + CustomerName character varying(1024), + PRIMARY KEY (CustomerId) + ) + """, ], ) client = spanner.Client(project=project_id) @@ -50,13 +52,11 @@ def create_postgresql_sequence( def insert_customers(transaction: spanner_v1.transaction.Transaction) -> None: nonlocal customer_ids - rows = list( - transaction.execute_sql( - "INSERT INTO Customers (CustomerName) VALUES " - "('Alice'), ('David'), ('Marc') " - "RETURNING CustomerId" - ) - ) + rows = list(transaction.execute_sql(""" + INSERT INTO Customers (CustomerName) VALUES + ('Alice'), ('David'), ('Marc') + RETURNING CustomerId + """)) customer_ids = [int(row[0]) for row in rows] try: