diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_query_with_parameter.py b/spanner/postgresql/src/spanner_postgresql/postgresql_query_with_parameter.py new file mode 100644 index 0000000000..0b47d39769 --- /dev/null +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_query_with_parameter.py @@ -0,0 +1,98 @@ +# 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_query_with_parameter] +import sys + +from google.api_core import exceptions +from google.cloud import spanner +from google.cloud.spanner_v1 import param_types + + +def query_postgresql_with_parameter( + project_id: str, instance_id: str, database_id: str +) -> None: + """Executes a parameterized PostgreSQL-dialect SQL query using $1 syntax. + + Args: + project_id: The Google Cloud project ID. + instance_id: The Spanner instance ID. + database_id: The PostgreSQL-dialect Spanner database ID. + """ + client = spanner.Client(project=project_id) + database = client.instance(instance_id).database(database_id) + + try: + with database.snapshot() as snapshot: + rows = list( + snapshot.execute_sql( + """ + SELECT singerid, firstname, lastname FROM singers + WHERE lastname = $1 + """, + params={"p1": "Garcia"}, + param_types={"p1": param_types.STRING}, + ) + ) + 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: parameterized PostgreSQL query failed on database " + f"'{database_id}' in instance '{instance_id}': {err.message}", + file=sys.stderr, + ) + else: + print(f"Resource ID: {database_id}") + print(f"Row Count: {len(rows)}") + for singer_id, first_name, last_name in rows: + print(f"Singer ID: {singer_id}, Name: {first_name} {last_name}") + + +# [END spanner_postgresql_query_with_parameter] + + +if __name__ == "__main__": + import argparse + import os + + parser = argparse.ArgumentParser( + description="Run a parameterized PostgreSQL-dialect SQL query using $1." + ) + 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() + + query_postgresql_with_parameter( + project_id=args.project_id, + instance_id=args.instance_id, + database_id=args.database_id, + ) diff --git a/spanner/postgresql/tests/postgresql_query_with_parameter_test.py b/spanner/postgresql/tests/postgresql_query_with_parameter_test.py new file mode 100644 index 0000000000..6b0e06fa25 --- /dev/null +++ b/spanner/postgresql/tests/postgresql_query_with_parameter_test.py @@ -0,0 +1,139 @@ +# 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 +import pytest +from spanner_postgresql import postgresql_query_with_parameter + +from . import conftest + +PROJECT_ID = "example-project-id" +INSTANCE_ID = "example-instance" +DATABASE_ID = "example-pg-db" +SPANNER_CLIENT = "google.cloud.spanner.Client" + + +@mock.patch(SPANNER_CLIENT) +def test_query_postgresql_with_parameter_success( + mock_client_class: mock.MagicMock, capsys: pytest.CaptureFixture[str] +) -> None: + snapshot = ( + mock_client_class.return_value.instance.return_value.database.return_value.snapshot.return_value.__enter__.return_value + ) + snapshot.execute_sql.return_value = [(10, "Catalina", "Garcia")] + + postgresql_query_with_parameter.query_postgresql_with_parameter( + PROJECT_ID, INSTANCE_ID, DATABASE_ID + ) + + assert snapshot.execute_sql.call_args.kwargs["params"] == {"p1": "Garcia"} + out, err = capsys.readouterr() + assert f"Resource ID: {DATABASE_ID}" in out + assert "Row Count: 1" in out + assert "Singer ID: 10, Name: Catalina Garcia" in out + assert PROJECT_ID not in out + assert err == "" + + +@pytest.mark.parametrize( + "error, expected_prefix", + [ + (exceptions.NotFound("missing"), "error: database 'example-pg-db'"), + ( + exceptions.InvalidArgument("bad param"), + "error: parameterized PostgreSQL query failed", + ), + ], +) +@mock.patch(SPANNER_CLIENT) +def test_query_postgresql_with_parameter_errors( + mock_client_class: mock.MagicMock, + capsys: pytest.CaptureFixture[str], + error: Exception, + expected_prefix: str, +) -> None: + snapshot = ( + mock_client_class.return_value.instance.return_value.database.return_value.snapshot.return_value.__enter__.return_value + ) + snapshot.execute_sql.side_effect = error + + postgresql_query_with_parameter.query_postgresql_with_parameter( + PROJECT_ID, INSTANCE_ID, DATABASE_ID + ) + + out, err = capsys.readouterr() + assert out == "" + assert err.startswith(expected_prefix) + assert PROJECT_ID not in err + + +@mock.patch(SPANNER_CLIENT) +def test_query_postgresql_with_parameter_cli_entrypoint( + mock_client_class: mock.MagicMock, + monkeypatch: pytest.MonkeyPatch, + capsys: pytest.CaptureFixture[str], +) -> None: + snapshot = ( + mock_client_class.return_value.instance.return_value.database.return_value.snapshot.return_value.__enter__.return_value + ) + snapshot.execute_sql.return_value = [(10, "Catalina", "Garcia")] + monkeypatch.setattr( + "sys.argv", + [ + "postgresql_query_with_parameter.py", + "--project-id", + PROJECT_ID, + "--instance-id", + INSTANCE_ID, + "--database-id", + DATABASE_ID, + ], + ) + + runpy.run_module( + "spanner_postgresql.postgresql_query_with_parameter", run_name="__main__" + ) + + assert "Row Count: 1" in capsys.readouterr().out + + +@conftest.live_only +def test_query_postgresql_with_parameter_live( + capsys: pytest.CaptureFixture[str], +) -> None: + client = spanner.Client(project=conftest.LIVE_PROJECT_ID) + db = client.instance(conftest.LIVE_INSTANCE_ID).database(conftest.LIVE_DATABASE_ID) + with db.batch() as batch: + batch.insert_or_update( + table="singers", + columns=("singerid", "firstname", "lastname"), + values=[(10, "Catalina", "Garcia")], + ) + try: + postgresql_query_with_parameter.query_postgresql_with_parameter( + 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 "Catalina Garcia" in out + finally: + with db.batch() as batch: + batch.delete("singers", spanner.KeySet(keys=[[10]]))