Repository navigation
feat(spanner): Add GoogleSQL online ALTER TABLE ADD COLUMN sample #14951
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
Open
iennae
wants to merge
2
commits into
feat/spanner-create-database
Choose a base branch
from
feat/spanner-add-column
base: feat/spanner-create-database
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
97 changes: 97 additions & 0 deletions
97
spanner/database_admin/src/spanner_database_admin/add_column.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| # 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_add_column] | ||
| import sys | ||
|
|
||
| from google.api_core import exceptions | ||
| from google.cloud import spanner_admin_database_v1 | ||
|
|
||
|
|
||
| def add_column(project_id: str, instance_id: str, database_id: str) -> None: | ||
| """Adds a MarketingBudget INT64 column to the Albums table online via DDL. | ||
|
|
||
| Args: | ||
| project_id: The Google Cloud project ID. | ||
| instance_id: The Spanner instance ID. | ||
| database_id: The Spanner database ID containing Albums. | ||
| """ | ||
| client = spanner_admin_database_v1.DatabaseAdminClient() | ||
| database_path = client.database_path(project_id, instance_id, database_id) | ||
| column_name = "MarketingBudget" | ||
| request = spanner_admin_database_v1.UpdateDatabaseDdlRequest( | ||
| database=database_path, | ||
| statements=[f"ALTER TABLE Albums ADD COLUMN {column_name} INT64"], | ||
| ) | ||
|
|
||
| try: | ||
| operation = client.update_database_ddl(request=request) | ||
| print(f"Waiting for column '{column_name}' addition on '{database_id}'...") | ||
| operation.result(timeout=300) | ||
| except (exceptions.AlreadyExists, exceptions.FailedPrecondition) as err: | ||
| print( | ||
| f"error: column '{column_name}' already exists or preconditions " | ||
| f"failed on database '{database_id}' in instance '{instance_id}': " | ||
| f"{err.message}", | ||
| file=sys.stderr, | ||
| ) | ||
| except TimeoutError as err: | ||
| print( | ||
| f"error: timed out waiting for the operation on database '{database_id}' " | ||
| f"to complete; the operation may still be running: {err}", | ||
| file=sys.stderr, | ||
| ) | ||
| except exceptions.GoogleAPICallError as err: | ||
| print( | ||
| f"error: failed to add column '{column_name}' on database " | ||
| f"'{database_id}' in instance '{instance_id}': {err.message}", | ||
| file=sys.stderr, | ||
| ) | ||
| else: | ||
| print(f"Resource ID: {database_id}") | ||
| print(f"Added Column: {column_name}") | ||
|
|
||
|
|
||
| # [END spanner_add_column] | ||
|
|
||
|
|
||
| if __name__ == "__main__": | ||
| import argparse | ||
| import os | ||
|
|
||
| parser = argparse.ArgumentParser( | ||
| description="Add an INT64 MarketingBudget column to Albums via DDL." | ||
| ) | ||
| 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_DATABASE_ID", "example-db"), | ||
| help="Spanner database ID (default: $SPANNER_DATABASE_ID)", | ||
| ) | ||
| args = parser.parse_args() | ||
|
|
||
| add_column( | ||
| project_id=args.project_id, | ||
| instance_id=args.instance_id, | ||
| database_id=args.database_id, | ||
| ) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,137 @@ | ||
| # 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 | ||
| import uuid | ||
|
|
||
| from google.api_core import exceptions | ||
| from google.cloud import spanner_admin_database_v1 | ||
| import pytest | ||
| from spanner_database_admin import add_column | ||
| from spanner_database_admin import create_database | ||
|
|
||
| from . import conftest | ||
|
|
||
| PROJECT_ID = "example-project-id" | ||
| INSTANCE_ID = "example-instance" | ||
| DATABASE_ID = "example-db" | ||
| ADMIN_CLIENT = "google.cloud.spanner_admin_database_v1.DatabaseAdminClient" | ||
|
|
||
|
|
||
| @mock.patch(ADMIN_CLIENT) | ||
| def test_add_column_success( | ||
| mock_client_class: mock.MagicMock, capsys: pytest.CaptureFixture[str] | ||
| ) -> None: | ||
| mock_client_class.return_value.database_path.return_value = ( | ||
| f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" | ||
| ) | ||
|
|
||
| add_column.add_column(PROJECT_ID, INSTANCE_ID, DATABASE_ID) | ||
|
|
||
| client = mock_client_class.return_value | ||
| request = client.update_database_ddl.call_args.kwargs["request"] | ||
| assert request.database == client.database_path.return_value | ||
| assert request.statements == ["ALTER TABLE Albums ADD COLUMN MarketingBudget INT64"] | ||
| out, err = capsys.readouterr() | ||
| assert f"Resource ID: {DATABASE_ID}" in out | ||
| assert "Added Column: MarketingBudget" in out | ||
| assert PROJECT_ID not in out | ||
| assert err == "" | ||
|
|
||
|
|
||
| @pytest.mark.parametrize( | ||
| "error, expected_prefix", | ||
| [ | ||
| (TimeoutError("deadline"), "error: timed out waiting for the operation"), | ||
| ( | ||
| exceptions.FailedPrecondition("exists"), | ||
| "error: column 'MarketingBudget' already exists", | ||
| ), | ||
| ( | ||
| exceptions.PermissionDenied("denied"), | ||
| "error: failed to add column 'MarketingBudget'", | ||
| ), | ||
| ], | ||
| ) | ||
| @mock.patch(ADMIN_CLIENT) | ||
| def test_add_column_errors( | ||
| mock_client_class: mock.MagicMock, | ||
| capsys: pytest.CaptureFixture[str], | ||
| error: Exception, | ||
| expected_prefix: str, | ||
| ) -> None: | ||
| mock_client_class.return_value.database_path.return_value = ( | ||
| f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" | ||
| ) | ||
| mock_client_class.return_value.update_database_ddl.side_effect = error | ||
|
|
||
| add_column.add_column(PROJECT_ID, INSTANCE_ID, DATABASE_ID) | ||
|
|
||
| _out, err = capsys.readouterr() | ||
| assert err.startswith(expected_prefix) | ||
| assert PROJECT_ID not in err | ||
|
|
||
|
|
||
| @mock.patch(ADMIN_CLIENT) | ||
| def test_add_column_cli_entrypoint( | ||
| mock_client_class: mock.MagicMock, | ||
| monkeypatch: pytest.MonkeyPatch, | ||
| capsys: pytest.CaptureFixture[str], | ||
| ) -> None: | ||
| mock_client_class.return_value.database_path.return_value = ( | ||
| f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}" | ||
| ) | ||
| monkeypatch.setattr( | ||
| "sys.argv", | ||
| [ | ||
| "add_column.py", | ||
| "--project-id", | ||
| PROJECT_ID, | ||
| "--instance-id", | ||
| INSTANCE_ID, | ||
| "--database-id", | ||
| DATABASE_ID, | ||
| ], | ||
| ) | ||
|
|
||
| runpy.run_module("spanner_database_admin.add_column", run_name="__main__") | ||
|
|
||
| assert "Added Column: MarketingBudget" in capsys.readouterr().out | ||
|
|
||
|
|
||
| @conftest.live_only | ||
| def test_add_column_live(capsys: pytest.CaptureFixture[str]) -> None: | ||
| admin = spanner_admin_database_v1.DatabaseAdminClient() | ||
| temp_db_id = f"example-col-{uuid.uuid4().hex[:6]}" | ||
| db_path = admin.database_path( | ||
| conftest.LIVE_PROJECT_ID, conftest.LIVE_INSTANCE_ID, temp_db_id | ||
| ) | ||
| try: | ||
| create_database.create_database( | ||
| conftest.LIVE_PROJECT_ID, conftest.LIVE_INSTANCE_ID, temp_db_id | ||
| ) | ||
| capsys.readouterr() | ||
| add_column.add_column( | ||
| conftest.LIVE_PROJECT_ID, conftest.LIVE_INSTANCE_ID, temp_db_id | ||
| ) | ||
| out, err = capsys.readouterr() | ||
| assert err == "" | ||
| assert conftest.LIVE_PROJECT_ID not in out | ||
| assert "Added Column: MarketingBudget" in out | ||
| finally: | ||
| try: | ||
| admin.drop_database(database=db_path) | ||
| except exceptions.NotFound: | ||
| pass | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
The test currently only asserts the printed output but does not verify that the
update_database_ddlmethod was actually called with the correct parameters. Adding an assertion for the API call makes the test much more robust against accidental changes to the SQL statement or request parameters.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.
Good suggestion, done: the unit test now asserts the database path and DDL statement in the request (3c790f1).