Repository navigation
feat(spanner): Add PostgreSQL bit-reversed sequence creation sample #14939
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.
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
base: feat/spanner-postgresql-dml-last-statement
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,124 @@ | ||
| # 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 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: | ||
|
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Missing to handle Timeout error: except TimeoutError as err:
print(
f"error: timed out waiting to drop PostgreSQL sequence "
f"'{sequence_name}' on database '{database_id}' in instance "
f"'{instance_id}': {err}",
file=sys.stderr,
)
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Good catch, thank you! Added an |
||
| 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)}") | ||
|
Comment on lines
+51
to
+90
Contributor
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. There are two main areas of improvement in this block:
def insert_customers(transaction: spanner_v1.transaction.Transaction) -> list[int]:
rows = list(
transaction.execute_sql(
"INSERT INTO Customers (CustomerName) VALUES "
"('Alice'), ('David'), ('Marc') "
"RETURNING CustomerId"
)
)
return [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)
except Exception as err:
print(
f"error: failed to create PostgreSQL sequence on database "
f"'{database_id}' in instance '{instance_id}': {err}",
file=sys.stderr,
)
return
try:
customer_ids = database.run_in_transaction(insert_customers)
except Exception as err:
print(
f"error: failed to insert customers on database "
f"'{database_id}' in instance '{instance_id}': {err}",
file=sys.stderr,
)
return
print(f"Resource ID: {database_id}")
for cid in customer_ids:
print(f"Customer ID: {cid}")
print(f"Inserted Customers: {len(customer_ids)}")References
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Thanks! Keeping the current structure: the sample catches specific |
||
|
|
||
|
|
||
| # [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, | ||
| ) | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,188 @@ | ||
| # 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", | ||
| ), | ||
| ( | ||
| TimeoutError("deadline"), | ||
| "error: timed out waiting to create PostgreSQL sequence 'Seq'", | ||
| ), | ||
| ( | ||
| 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) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I believe this is a redundant import, we could just call the client like
spanner_v1.Client(project=project_id)There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the suggestion! I'm going to keep this one as is: the samples in this set consistently create the client through
spanner.Client, which is the entry point used in the product documentation, andspanner_v1is only imported here for the transaction callback's type annotation. Switching just this sample tospanner_v1.Clientwould make it the odd one out.