Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -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_drop_sequence]
import sys

from google.api_core import exceptions
from google.cloud import spanner_admin_database_v1


def drop_postgresql_sequence(
project_id: str, instance_id: str, database_id: str
) -> None:
"""Detaches a column DEFAULT and drops a PostgreSQL sequence via DDL.

Args:
project_id: The Google Cloud project ID.
instance_id: The Spanner instance ID.
database_id: The PostgreSQL-dialect Spanner database ID with Seq.
"""
client = spanner_admin_database_v1.DatabaseAdminClient()
database_path = client.database_path(project_id, instance_id, database_id)
sequence_name = "Seq"
request = spanner_admin_database_v1.UpdateDatabaseDdlRequest(
database=database_path,
statements=[
"ALTER TABLE Customers ALTER COLUMN CustomerId DROP DEFAULT",
f"DROP SEQUENCE {sequence_name}",
],
)

try:
operation = client.update_database_ddl(request=request)
print(
f"Waiting for PostgreSQL sequence '{sequence_name}' drop on "
f"'{database_id}'..."
)
operation.result(timeout=300)
except exceptions.FailedPrecondition as err:
print(
f"error: sequence '{sequence_name}' is still referenced or missing "
f"on database '{database_id}' in instance '{instance_id}': {err.message}",
file=sys.stderr,
)
except exceptions.GoogleAPICallError as err:

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should the timeout error be caught as well?

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,
        )

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, good catch, thank you! Since this PR was already merged into its base branch, I added the except TimeoutError handler and a unit test as a follow-up commit there (43569d5, part of #14851). The message notes that only the wait timed out and the operation may still be running, because the timeout does not cancel the schema change.

print(
f"error: failed to drop PostgreSQL sequence '{sequence_name}' on "
f"database '{database_id}' in instance '{instance_id}': {err.message}",
file=sys.stderr,
)
else:
print(f"Resource ID: {database_id}")
print(f"Dropped Sequence: {sequence_name}")


# [END spanner_postgresql_drop_sequence]


if __name__ == "__main__":
import argparse
import os

parser = argparse.ArgumentParser(
description="Detach column default and drop a PostgreSQL sequence."
)
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()

drop_postgresql_sequence(
project_id=args.project_id,
instance_id=args.instance_id,
database_id=args.database_id,
)
164 changes: 164 additions & 0 deletions spanner/postgresql/tests/postgresql_drop_sequence_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,164 @@
# 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"


@mock.patch(ADMIN_CLIENT)
def test_drop_postgresql_sequence_success(
mock_client_class: mock.MagicMock, capsys: pytest.CaptureFixture[str]
) -> None:
mock_client_class.return_value.instance_path.return_value = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}"
)
mock_client_class.return_value.database_path.return_value = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}"
)
postgresql_drop_sequence.drop_postgresql_sequence(
PROJECT_ID, INSTANCE_ID, DATABASE_ID
)

req = mock_client_class.return_value.update_database_ddl.call_args.kwargs["request"]
assert len(req.statements) == 2
out, err = capsys.readouterr()
assert f"Resource ID: {DATABASE_ID}" in out
assert "Dropped Sequence: Seq" in out
assert PROJECT_ID not in out
assert err == ""


@pytest.mark.parametrize(
"error, expected_prefix",
[
(
exceptions.FailedPrecondition("in use"),
"error: sequence 'Seq' is still referenced or missing",
),
(
exceptions.PermissionDenied("denied"),
"error: failed to drop PostgreSQL sequence 'Seq'",
),
],
)
@mock.patch(ADMIN_CLIENT)
def test_drop_postgresql_sequence_errors(
mock_client_class: mock.MagicMock,
capsys: pytest.CaptureFixture[str],
error: Exception,
expected_prefix: str,
) -> None:
mock_client_class.return_value.instance_path.return_value = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}"
)
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

postgresql_drop_sequence.drop_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(ADMIN_CLIENT)
def test_drop_postgresql_sequence_cli_entrypoint(
mock_client_class: mock.MagicMock,
monkeypatch: pytest.MonkeyPatch,
capsys: pytest.CaptureFixture[str],
) -> None:
mock_client_class.return_value.instance_path.return_value = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}"
)
mock_client_class.return_value.database_path.return_value = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/{DATABASE_ID}"
)
monkeypatch.setattr(
"sys.argv",
[
"postgresql_drop_sequence.py",
"--project-id",
PROJECT_ID,
"--instance-id",
INSTANCE_ID,
"--database-id",
DATABASE_ID,
],
)

runpy.run_module("spanner_postgresql.postgresql_drop_sequence", run_name="__main__")

assert "Dropped Sequence: Seq" in capsys.readouterr().out


@conftest.live_only
def test_drop_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,
)
capsys.readouterr()
postgresql_drop_sequence.drop_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 "Dropped Sequence: Seq" in out
finally:
admin.update_database_ddl(
request={
"database": db_path,
"statements": [
"DROP TABLE IF EXISTS Customers",
"DROP SEQUENCE IF EXISTS Seq",
],
}
).result(timeout=240)