Skip to content
Open
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
111 changes: 111 additions & 0 deletions spanner/backups/src/spanner_backups/restore_backup.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
# 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_restore_backup]
import sys

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


def restore_backup(
project_id: str,
instance_id: str,
new_database_id: str,
backup_id: str,
) -> None:
"""Restores a Spanner backup into a newly created database.

Args:
project_id: The Google Cloud project ID.
instance_id: The Spanner instance ID.
new_database_id: The new target database ID to create.
backup_id: The source backup ID on the instance.
"""
client = spanner_admin_database_v1.DatabaseAdminClient()
parent = client.instance_path(project_id, instance_id)
backup_path = client.backup_path(project_id, instance_id, backup_id)
request = spanner_admin_database_v1.RestoreDatabaseRequest(
parent=parent,
database_id=new_database_id,
backup=backup_path,
)

try:
operation = client.restore_database(request=request)
print(
f"Waiting for restore of backup '{backup_id}' to " f"'{new_database_id}'..."
)
restored = operation.result(timeout=1600)
except exceptions.AlreadyExists as err:
print(
f"error: target database '{new_database_id}' already exists on "
f"instance '{instance_id}': {err.message}",
file=sys.stderr,
)
except TimeoutError as err:
print(
f"error: timed out waiting for the operation on "
f"new database '{new_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 restore backup '{backup_id}' to "
f"'{new_database_id}' on instance '{instance_id}': {err.message}",
file=sys.stderr,
)
else:
bkp_info = restored.restore_info.backup_info
source_db_id = bkp_info.source_database.split("/")[-1]
print(f"Resource ID: {new_database_id}")
print(f"Restored From Backup: {backup_id}")
print(f"Source Database ID: {source_db_id}")


# [END spanner_restore_backup]


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

parser = argparse.ArgumentParser(
description="Restore a Spanner database from a backup."
)
parser.add_argument(
"--project-id",
default=os.environ.get("GOOGLE_CLOUD_PROJECT", "example-project-id"),
)
parser.add_argument(
"--instance-id",
default=os.environ.get("SPANNER_INSTANCE_ID", "example-instance"),
)
parser.add_argument(
"--new-database-id",
default="example-restored-db",
)
parser.add_argument(
"--backup-id",
default=os.environ.get("SPANNER_BACKUP_ID", "example-backup"),
)
args = parser.parse_args()

restore_backup(
project_id=args.project_id,
instance_id=args.instance_id,
new_database_id=args.new_database_id,
backup_id=args.backup_id,
)
148 changes: 148 additions & 0 deletions spanner/backups/tests/restore_backup_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,148 @@
# 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 os
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_backups import restore_backup

from . import conftest

PROJECT_ID = "example-project-id"
INSTANCE_ID = "example-instance"
NEW_DB_ID = "example-restored-db"
BACKUP_ID = "example-backup"
ADMIN_CLIENT = "google.cloud.spanner_admin_database_v1.DatabaseAdminClient"


def _setup_admin(mock_client_class: mock.MagicMock) -> None:
client = mock_client_class.return_value
client.instance_path.return_value = f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}"
client.backup_path.return_value = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/backups/{BACKUP_ID}"
)
db_pb = mock.MagicMock()
db_pb.restore_info.backup_info.source_database = (
f"projects/{PROJECT_ID}/instances/{INSTANCE_ID}/databases/example-db"
)
client.restore_database.return_value.result.return_value = db_pb


@mock.patch(ADMIN_CLIENT)
def test_restore_backup_success(
mock_client_class: mock.MagicMock, capsys: pytest.CaptureFixture[str]
) -> None:
_setup_admin(mock_client_class)

restore_backup.restore_backup(PROJECT_ID, INSTANCE_ID, NEW_DB_ID, BACKUP_ID)

out, err = capsys.readouterr()
assert f"Resource ID: {NEW_DB_ID}" in out
assert f"Restored From Backup: {BACKUP_ID}" in out
assert "Source Database ID: example-db" 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.AlreadyExists("dup"),
"error: target database 'example-restored-db' already exists",
),
(
exceptions.NotFound("missing"),
"error: failed to restore backup 'example-backup'",
),
],
)
@mock.patch(ADMIN_CLIENT)
def test_restore_backup_errors(
mock_client_class: mock.MagicMock,
capsys: pytest.CaptureFixture[str],
error: Exception,
expected_prefix: str,
) -> None:
_setup_admin(mock_client_class)
mock_client_class.return_value.restore_database.side_effect = error

restore_backup.restore_backup(PROJECT_ID, INSTANCE_ID, NEW_DB_ID, BACKUP_ID)

_out, err = capsys.readouterr()
assert err.startswith(expected_prefix)
assert PROJECT_ID not in err


@mock.patch(ADMIN_CLIENT)
def test_restore_backup_cli_entrypoint(
mock_client_class: mock.MagicMock,
monkeypatch: pytest.MonkeyPatch,
capsys: pytest.CaptureFixture[str],
) -> None:
_setup_admin(mock_client_class)
monkeypatch.setattr(
"sys.argv",
[
"restore_backup.py",
"--project-id",
PROJECT_ID,
"--instance-id",
INSTANCE_ID,
"--new-database-id",
NEW_DB_ID,
"--backup-id",
BACKUP_ID,
],
)

runpy.run_module("spanner_backups.restore_backup", run_name="__main__")

assert "Source Database ID: example-db" in capsys.readouterr().out


@conftest.live_only
def test_restore_backup_live(capsys: pytest.CaptureFixture[str]) -> None:
required = ("SPANNER_BACKUP_ID",)
missing = [name for name in required if not os.environ.get(name)]
if missing:
pytest.skip(f"Set {', '.join(missing)} to run this live test.")
src_bkp = os.environ["SPANNER_BACKUP_ID"]
admin = spanner_admin_database_v1.DatabaseAdminClient()
new_db = f"example-rst-{uuid.uuid4().hex[:6]}"
db_path = admin.database_path(
conftest.LIVE_PROJECT_ID, conftest.LIVE_INSTANCE_ID, new_db
)
try:
restore_backup.restore_backup(
conftest.LIVE_PROJECT_ID,
conftest.LIVE_INSTANCE_ID,
new_db,
src_bkp,
)
out, err = capsys.readouterr()
assert err == ""
assert conftest.LIVE_PROJECT_ID not in out
assert f"Resource ID: {new_db}" in out
finally:
try:
admin.drop_database(database=db_path)
except exceptions.NotFound:
pass