Skip to content
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.

Sign up for GitHub

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

Jump to bottom

docs: use autogenerated methods to get names from admin samples #1110

Merged
merged 3 commits into from
Mar 4, 2024
Merged

docs: use autogenerated methods to get names from admin samples #1110

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f46f323
docs: use autogenerated methods the fetch names from admin samples
rahul2393 Mar 4, 2024
9ee3911
use database_admin_api for instance_path
rahul2393 Mar 4, 2024
4723108
incorporate changes
rahul2393 Mar 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
138 changes: 90 additions & 48 deletions samples/samples/backup_sample.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,23 +35,24 @@ def create_backup(instance_id, database_id, backup_id, version_time):
backup as backup_pb

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
database = instance.database(database_id)
database_admin_api = spanner_client.database_admin_api

# Create a backup
expire_time = datetime.utcnow() + timedelta(days=14)

request = backup_pb.CreateBackupRequest(
parent=instance.name,
parent=database_admin_api.instance_path(spanner_client.project, instance_id),
backup_id=backup_id,
backup=backup_pb.Backup(
database=database.name,
database=database_admin_api.database_path(
spanner_client.project, instance_id, database_id
),
expire_time=expire_time,
version_time=version_time,
),
)

operation = spanner_client.database_admin_api.create_backup(request)
operation = database_admin_api.create_backup(request)

# Wait for backup operation to complete.
backup = operation.result(2100)
Expand Down Expand Up @@ -81,8 +82,7 @@ def create_backup_with_encryption_key(
backup as backup_pb

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
database = instance.database(database_id)
database_admin_api = spanner_client.database_admin_api

# Create a backup
expire_time = datetime.utcnow() + timedelta(days=14)
Expand All @@ -91,15 +91,17 @@ def create_backup_with_encryption_key(
"kms_key_name": kms_key_name,
}
request = backup_pb.CreateBackupRequest(
parent=instance.name,
parent=database_admin_api.instance_path(spanner_client.project, instance_id),
backup_id=backup_id,
backup=backup_pb.Backup(
database=database.name,
database=database_admin_api.database_path(
spanner_client.project, instance_id, database_id
),
expire_time=expire_time,
),
encryption_config=encryption_config,
)
operation = spanner_client.database_admin_api.create_backup(request)
operation = database_admin_api.create_backup(request)

# Wait for backup operation to complete.
backup = operation.result(2100)
Expand All @@ -124,13 +126,16 @@ def restore_database(instance_id, new_database_id, backup_id):
from google.cloud.spanner_admin_database_v1 import RestoreDatabaseRequest

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
instance_admin_api = spanner_client.instance_admin_api

# Start restoring an existing backup to a new database.
request = RestoreDatabaseRequest(
parent=instance.name,
parent=instance_admin_api.instance_path(spanner_client.project, instance_id),
database_id=new_database_id,
backup="{}/backups/{}".format(instance.name, backup_id),
backup="{}/backups/{}".format(
instance_admin_api.instance_path(spanner_client.project, instance_id),
backup_id,
),
)
operation = spanner_client.database_admin_api.restore_database(request)

Expand Down Expand Up @@ -161,7 +166,7 @@ def restore_database_with_encryption_key(
RestoreDatabaseEncryptionConfig, RestoreDatabaseRequest)

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
instance_admin_api = spanner_client.instance_admin_api

# Start restoring an existing backup to a new database.
encryption_config = {
Expand All @@ -170,9 +175,12 @@ def restore_database_with_encryption_key(
}

request = RestoreDatabaseRequest(
parent=instance.name,
parent=instance_admin_api.instance_path(spanner_client.project, instance_id),
database_id=new_database_id,
backup="{}/backups/{}".format(instance.name, backup_id),
backup="{}/backups/{}".format(
instance_admin_api.instance_path(spanner_client.project, instance_id),
backup_id,
),
encryption_config=encryption_config,
)
operation = spanner_client.database_admin_api.restore_database(request)
Expand Down Expand Up @@ -201,43 +209,52 @@ def cancel_backup(instance_id, database_id, backup_id):
backup as backup_pb

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
database = instance.database(database_id)
database_admin_api = spanner_client.database_admin_api

expire_time = datetime.utcnow() + timedelta(days=30)

# Create a backup.
request = backup_pb.CreateBackupRequest(
parent=instance.name,
parent=database_admin_api.instance_path(spanner_client.project, instance_id),
backup_id=backup_id,
backup=backup_pb.Backup(
database=database.name,
database=database_admin_api.database_path(
spanner_client.project, instance_id, database_id
),
expire_time=expire_time,
),
)

operation = spanner_client.database_admin_api.create_backup(request)
operation = database_admin_api.create_backup(request)
# Cancel backup creation.
operation.cancel()

# Cancel operations are best effort so either it will complete or
# Cancel operations are the best effort so either it will complete or
# be cancelled.
while not operation.done():
time.sleep(300) # 5 mins

try:
spanner_client.database_admin_api.get_backup(
database_admin_api.get_backup(
backup_pb.GetBackupRequest(
name="{}/backups/{}".format(instance.name, backup_id)
name="{}/backups/{}".format(
database_admin_api.instance_path(
spanner_client.project, instance_id
),
backup_id,
)
)
)
except NotFound:
print("Backup creation was successfully cancelled.")
return
print("Backup was created before the cancel completed.")
spanner_client.database_admin_api.delete_backup(
database_admin_api.delete_backup(
backup_pb.DeleteBackupRequest(
name="{}/backups/{}".format(instance.name, backup_id)
name="{}/backups/{}".format(
database_admin_api.instance_path(spanner_client.project, instance_id),
backup_id,
)
)
)
print("Backup deleted.")
Expand All @@ -252,7 +269,7 @@ def list_backup_operations(instance_id, database_id, backup_id):
backup as backup_pb

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
instance_admin_api = spanner_client.instance_admin_api

# List the CreateBackup operations.
filter_ = (
Expand All @@ -261,7 +278,8 @@ def list_backup_operations(instance_id, database_id, backup_id):
"AND (metadata.database:{})"
).format(database_id)
request = backup_pb.ListBackupOperationsRequest(
parent=instance.name, filter=filter_
parent=instance_admin_api.instance_path(spanner_client.project, instance_id),
filter=filter_,
)
operations = spanner_client.database_admin_api.list_backup_operations(request)
for op in operations:
Expand All @@ -280,7 +298,8 @@ def list_backup_operations(instance_id, database_id, backup_id):
"AND (metadata.source_backup:{})"
).format(backup_id)
request = backup_pb.ListBackupOperationsRequest(
parent=instance.name, filter=filter_
parent=instance_admin_api.instance_path(spanner_client.project, instance_id),
filter=filter_,
)
operations = spanner_client.database_admin_api.list_backup_operations(request)
for op in operations:
Expand All @@ -305,15 +324,16 @@ def list_database_operations(instance_id):
spanner_database_admin

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
instance_admin_api = spanner_client.instance_admin_api

# List the progress of restore.
filter_ = (
"(metadata.@type:type.googleapis.com/"
"google.spanner.admin.database.v1.OptimizeRestoredDatabaseMetadata)"
)
request = spanner_database_admin.ListDatabaseOperationsRequest(
parent=instance.name, filter=filter_
parent=instance_admin_api.instance_path(spanner_client.project, instance_id),
filter=filter_,
)
operations = spanner_client.database_admin_api.list_database_operations(request)
for op in operations:
Expand All @@ -336,19 +356,23 @@ def list_backups(instance_id, database_id, backup_id):
backup as backup_pb

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
instance_admin_api = spanner_client.instance_admin_api

# List all backups.
print("All backups:")
request = backup_pb.ListBackupsRequest(parent=instance.name, filter="")
request = backup_pb.ListBackupsRequest(
parent=instance_admin_api.instance_path(spanner_client.project, instance_id),
filter="",
)
operations = spanner_client.database_admin_api.list_backups(request)
for backup in operations:
print(backup.name)

# List all backups that contain a name.
print('All backups with backup name containing "{}":'.format(backup_id))
request = backup_pb.ListBackupsRequest(
parent=instance.name, filter="name:{}".format(backup_id)
parent=instance_admin_api.instance_path(spanner_client.project, instance_id),
filter="name:{}".format(backup_id),
)
operations = spanner_client.database_admin_api.list_backups(request)
for backup in operations:
Expand All @@ -357,7 +381,8 @@ def list_backups(instance_id, database_id, backup_id):
# List all backups for a database that contains a name.
print('All backups with database name containing "{}":'.format(database_id))
request = backup_pb.ListBackupsRequest(
parent=instance.name, filter="database:{}".format(database_id)
parent=instance_admin_api.instance_path(spanner_client.project, instance_id),
filter="database:{}".format(database_id),
)
operations = spanner_client.database_admin_api.list_backups(request)
for backup in operations:
Expand All @@ -371,7 +396,7 @@ def list_backups(instance_id, database_id, backup_id):
)
)
request = backup_pb.ListBackupsRequest(
parent=instance.name,
parent=instance_admin_api.instance_path(spanner_client.project, instance_id),
filter='expire_time < "{}-{}-{}T{}:{}:{}Z"'.format(*expire_time.timetuple()),
)
operations = spanner_client.database_admin_api.list_backups(request)
Expand All @@ -381,7 +406,8 @@ def list_backups(instance_id, database_id, backup_id):
# List all backups with a size greater than some bytes.
print("All backups with backup size more than 100 bytes:")
request = backup_pb.ListBackupsRequest(
parent=instance.name, filter="size_bytes > 100"
parent=instance_admin_api.instance_path(spanner_client.project, instance_id),
filter="size_bytes > 100",
)
operations = spanner_client.database_admin_api.list_backups(request)
for backup in operations:
Expand All @@ -395,7 +421,7 @@ def list_backups(instance_id, database_id, backup_id):
)
)
request = backup_pb.ListBackupsRequest(
parent=instance.name,
parent=instance_admin_api.instance_path(spanner_client.project, instance_id),
filter='create_time >= "{}-{}-{}T{}:{}:{}Z" AND state:READY'.format(
*create_time.timetuple()
),
Expand All @@ -408,7 +434,10 @@ def list_backups(instance_id, database_id, backup_id):
# If there are multiple pages, additional ``ListBackup``
# requests will be made as needed while iterating.
paged_backups = set()
request = backup_pb.ListBackupsRequest(parent=instance.name, page_size=2)
request = backup_pb.ListBackupsRequest(
parent=instance_admin_api.instance_path(spanner_client.project, instance_id),
page_size=2,
)
operations = spanner_client.database_admin_api.list_backups(request)
for backup in operations:
paged_backups.add(backup.name)
Expand All @@ -425,10 +454,13 @@ def delete_backup(instance_id, backup_id):
backup as backup_pb

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
instance_admin_api = spanner_client.instance_admin_api
backup = spanner_client.database_admin_api.get_backup(
backup_pb.GetBackupRequest(
name="{}/backups/{}".format(instance.name, backup_id)
name="{}/backups/{}".format(
rahul2393 marked this conversation as resolved.
Show resolved Hide resolved
instance_admin_api.instance_path(spanner_client.project, instance_id),
backup_id,
)
)
)

Expand All @@ -437,7 +469,12 @@ def delete_backup(instance_id, backup_id):
time.sleep(30)
backup = spanner_client.database_admin_api.get_backup(
backup_pb.GetBackupRequest(
name="{}/backups/{}".format(instance.name, backup_id)
name="{}/backups/{}".format(
instance_admin_api.instance_path(
spanner_client.project, instance_id
),
backup_id,
)
)
)

Expand Down Expand Up @@ -465,11 +502,14 @@ def update_backup(instance_id, backup_id):
backup as backup_pb

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
instance_admin_api = spanner_client.instance_admin_api

backup = spanner_client.database_admin_api.get_backup(
backup_pb.GetBackupRequest(
name="{}/backups/{}".format(instance.name, backup_id)
name="{}/backups/{}".format(
rahul2393 marked this conversation as resolved.
Show resolved Hide resolved
instance_admin_api.instance_path(spanner_client.project, instance_id),
backup_id,
)
)
)

Expand Down Expand Up @@ -503,7 +543,7 @@ def create_database_with_version_retention_period(
spanner_database_admin

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
instance_admin_api = spanner_client.instance_admin_api
ddl_statements = [
"CREATE TABLE Singers ("
+ " SingerId INT64 NOT NULL,"
Expand All @@ -524,7 +564,9 @@ def create_database_with_version_retention_period(
]
operation = spanner_client.database_admin_api.create_database(
request=spanner_database_admin.CreateDatabaseRequest(
parent=instance.name,
parent=instance_admin_api.instance_path(
spanner_client.project, instance_id
),
create_statement="CREATE DATABASE `{}`".format(database_id),
extra_statements=ddl_statements,
)
Expand Down Expand Up @@ -553,12 +595,12 @@ def copy_backup(instance_id, backup_id, source_backup_path):
backup as backup_pb

spanner_client = spanner.Client()
instance = spanner_client.instance(instance_id)
instance_admin_api = spanner_client.instance_admin_api

# Create a backup object and wait for copy backup operation to complete.
expire_time = datetime.utcnow() + timedelta(days=14)
request = backup_pb.CopyBackupRequest(
parent=instance.name,
parent=instance_admin_api.instance_path(spanner_client.project, instance_id),
backup_id=backup_id,
source_backup=source_backup_path,
expire_time=expire_time,
Expand Down