From b9bc4627e509cd88d9b0728afbc4daef66942d2a Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Wed, 18 Nov 2026 04:51:09 +0000 Subject: [PATCH 1/2] feat(spanner): Add PostgreSQL JSONB ->> parameter query sample PostgreSQL JSONB columns support field extraction via ->> combined with positional $1 query parameters. Add a standalone spanner_postgresql_jsonb_query_parameter sample querying venues. --- .../postgresql_jsonb_query_parameter.py | 96 +++++++++++ .../postgresql_jsonb_query_parameter_test.py | 154 ++++++++++++++++++ 2 files changed, 250 insertions(+) create mode 100644 spanner/postgresql/src/spanner_postgresql/postgresql_jsonb_query_parameter.py create mode 100644 spanner/postgresql/tests/postgresql_jsonb_query_parameter_test.py diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_jsonb_query_parameter.py b/spanner/postgresql/src/spanner_postgresql/postgresql_jsonb_query_parameter.py new file mode 100644 index 0000000000..30eaecaf3d --- /dev/null +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_jsonb_query_parameter.py @@ -0,0 +1,96 @@ +# 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_jsonb_query_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_jsonb_parameter( + project_id: str, instance_id: str, database_id: str +) -> None: + """Filters a PostgreSQL JSONB column using ->> extraction and $1 parameter. + + Args: + project_id: The Google Cloud project ID. + instance_id: The Spanner instance ID. + database_id: The PostgreSQL-dialect Spanner database ID with venues. + """ + 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 venueid, venuedetails FROM venues " + "WHERE CAST(venuedetails ->> 'rating' AS INTEGER) > $1", + params={"p1": 2}, + param_types={"p1": param_types.INT64}, + ) + ) + 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: PostgreSQL JSONB 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 venue_id, venue_details in rows: + print(f"Venue ID: {venue_id}, Details: {venue_details}") + + +# [END spanner_postgresql_jsonb_query_parameter] + + +if __name__ == "__main__": + import argparse + import os + + parser = argparse.ArgumentParser( + description="Filter a PostgreSQL JSONB column using a parameterized Spanner query." + ) + 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_jsonb_parameter( + project_id=args.project_id, + instance_id=args.instance_id, + database_id=args.database_id, + ) diff --git a/spanner/postgresql/tests/postgresql_jsonb_query_parameter_test.py b/spanner/postgresql/tests/postgresql_jsonb_query_parameter_test.py new file mode 100644 index 0000000000..f392961259 --- /dev/null +++ b/spanner/postgresql/tests/postgresql_jsonb_query_parameter_test.py @@ -0,0 +1,154 @@ +# 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 +from google.cloud import spanner_admin_database_v1 +from google.cloud.spanner_v1 import JsonObject +import pytest +from spanner_postgresql import postgresql_jsonb_query_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_jsonb_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 = [(19, '{"open": true, "rating": 9}')] + + postgresql_jsonb_query_parameter.query_postgresql_jsonb_parameter( + PROJECT_ID, INSTANCE_ID, DATABASE_ID + ) + + out, err = capsys.readouterr() + assert f"Resource ID: {DATABASE_ID}" in out + assert "Row Count: 1" in out + assert "Venue ID: 19" 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 jsonb"), + "error: PostgreSQL JSONB query failed", + ), + ], +) +@mock.patch(SPANNER_CLIENT) +def test_query_postgresql_jsonb_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_jsonb_query_parameter.query_postgresql_jsonb_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_jsonb_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 = [(19, '{"open": true, "rating": 9}')] + monkeypatch.setattr( + "sys.argv", + [ + "postgresql_jsonb_query_parameter.py", + "--project-id", + PROJECT_ID, + "--instance-id", + INSTANCE_ID, + "--database-id", + DATABASE_ID, + ], + ) + + runpy.run_module( + "spanner_postgresql.postgresql_jsonb_query_parameter", run_name="__main__" + ) + + assert "Venue ID: 19" in capsys.readouterr().out + + +@conftest.live_only +def test_query_postgresql_jsonb_parameter_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": [ + "CREATE TABLE IF NOT EXISTS venues (" + " venueid bigint NOT NULL," + " venuedetails jsonb," + " PRIMARY KEY (venueid)" + ")" + ], + } + ).result(timeout=240) + 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="venues", + columns=("venueid", "venuedetails"), + values=[(19, JsonObject(rating=9, open=True))], + ) + postgresql_jsonb_query_parameter.query_postgresql_jsonb_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 "Venue ID: 19" in out From d06da5c8ea245c71db6cf8246be0cfbfa4d5fa5d Mon Sep 17 00:00:00 2001 From: Jennifer Davis Date: Thu, 19 Nov 2026 04:44:01 +0000 Subject: [PATCH 2/2] style(spanner): use triple-quoted SQL strings in postgresql_jsonb_query_parameter 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_jsonb_query_parameter.py - spanner/postgresql/tests/postgresql_jsonb_query_parameter_test.py --- .../postgresql_jsonb_query_parameter.py | 6 ++++-- .../tests/postgresql_jsonb_query_parameter_test.py | 12 +++++++----- 2 files changed, 11 insertions(+), 7 deletions(-) diff --git a/spanner/postgresql/src/spanner_postgresql/postgresql_jsonb_query_parameter.py b/spanner/postgresql/src/spanner_postgresql/postgresql_jsonb_query_parameter.py index 30eaecaf3d..afdc19d117 100644 --- a/spanner/postgresql/src/spanner_postgresql/postgresql_jsonb_query_parameter.py +++ b/spanner/postgresql/src/spanner_postgresql/postgresql_jsonb_query_parameter.py @@ -37,8 +37,10 @@ def query_postgresql_jsonb_parameter( with database.snapshot() as snapshot: rows = list( snapshot.execute_sql( - "SELECT venueid, venuedetails FROM venues " - "WHERE CAST(venuedetails ->> 'rating' AS INTEGER) > $1", + """ + SELECT venueid, venuedetails FROM venues + WHERE CAST(venuedetails ->> 'rating' AS INTEGER) > $1 + """, params={"p1": 2}, param_types={"p1": param_types.INT64}, ) diff --git a/spanner/postgresql/tests/postgresql_jsonb_query_parameter_test.py b/spanner/postgresql/tests/postgresql_jsonb_query_parameter_test.py index f392961259..a8922da181 100644 --- a/spanner/postgresql/tests/postgresql_jsonb_query_parameter_test.py +++ b/spanner/postgresql/tests/postgresql_jsonb_query_parameter_test.py @@ -127,11 +127,13 @@ def test_query_postgresql_jsonb_parameter_live( request={ "database": db_path, "statements": [ - "CREATE TABLE IF NOT EXISTS venues (" - " venueid bigint NOT NULL," - " venuedetails jsonb," - " PRIMARY KEY (venueid)" - ")" + """ + CREATE TABLE IF NOT EXISTS venues ( + venueid bigint NOT NULL, + venuedetails jsonb, + PRIMARY KEY (venueid) + ) + """ ], } ).result(timeout=240)