Skip to content

Commit 58e2406

Browse files
docs: Add snippet for Repeatable Read configuration at client and transaction (#1326)
* chore: snapshot isolation sample * updated the sample * lint samples * 🦉 Updates from OwlBot post-processor See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md --------- Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
1 parent af8e973 commit 58e2406

File tree

7 files changed

+188
-112
lines changed

7 files changed

+188
-112
lines changed

samples/samples/backup_sample.py

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,7 @@ def create_backup_with_encryption_key(
116116

117117
# [END spanner_create_backup_with_encryption_key]
118118

119+
119120
# [START spanner_create_backup_with_MR_CMEK]
120121
def create_backup_with_multiple_kms_keys(
121122
instance_id, database_id, backup_id, kms_key_names
@@ -246,6 +247,7 @@ def restore_database_with_encryption_key(
246247

247248
# [END spanner_restore_backup_with_encryption_key]
248249

250+
249251
# [START spanner_restore_backup_with_MR_CMEK]
250252
def restore_database_with_multiple_kms_keys(
251253
instance_id, new_database_id, backup_id, kms_key_names
@@ -697,6 +699,7 @@ def copy_backup(instance_id, backup_id, source_backup_path):
697699

698700
# [END spanner_copy_backup]
699701

702+
700703
# [START spanner_copy_backup_with_MR_CMEK]
701704
def copy_backup_with_multiple_kms_keys(
702705
instance_id, backup_id, source_backup_path, kms_key_names

samples/samples/backup_sample_test.py

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,7 @@ def test_create_backup_with_encryption_key(
9393
assert kms_key_name in out
9494

9595

96-
@pytest.mark.skip(reason="skipped since the KMS keys are not added on test "
97-
"project")
96+
@pytest.mark.skip(reason="skipped since the KMS keys are not added on test " "project")
9897
@pytest.mark.dependency(name="create_backup_with_multiple_kms_keys")
9998
def test_create_backup_with_multiple_kms_keys(
10099
capsys,
@@ -116,8 +115,7 @@ def test_create_backup_with_multiple_kms_keys(
116115
assert kms_key_names[2] in out
117116

118117

119-
@pytest.mark.skip(reason="skipped since the KMS keys are not added on test "
120-
"project")
118+
@pytest.mark.skip(reason="skipped since the KMS keys are not added on test " "project")
121119
@pytest.mark.dependency(depends=["create_backup_with_multiple_kms_keys"])
122120
def test_copy_backup_with_multiple_kms_keys(
123121
capsys, multi_region_instance_id, spanner_client, kms_key_names
@@ -164,8 +162,7 @@ def test_restore_database_with_encryption_key(
164162
assert kms_key_name in out
165163

166164

167-
@pytest.mark.skip(reason="skipped since the KMS keys are not added on test "
168-
"project")
165+
@pytest.mark.skip(reason="skipped since the KMS keys are not added on test " "project")
169166
@pytest.mark.dependency(depends=["create_backup_with_multiple_kms_keys"])
170167
@RetryErrors(exception=DeadlineExceeded, max_tries=2)
171168
def test_restore_database_with_multiple_kms_keys(

samples/samples/backup_schedule_samples.py

Lines changed: 52 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -24,25 +24,26 @@
2424

2525
# [START spanner_create_full_backup_schedule]
2626
def create_full_backup_schedule(
27-
instance_id: str,
28-
database_id: str,
29-
schedule_id: str,
27+
instance_id: str,
28+
database_id: str,
29+
schedule_id: str,
3030
) -> None:
3131
from datetime import timedelta
3232
from google.cloud import spanner
33-
from google.cloud.spanner_admin_database_v1.types import \
34-
backup_schedule as backup_schedule_pb
35-
from google.cloud.spanner_admin_database_v1.types import \
36-
CreateBackupEncryptionConfig, FullBackupSpec
33+
from google.cloud.spanner_admin_database_v1.types import (
34+
backup_schedule as backup_schedule_pb,
35+
)
36+
from google.cloud.spanner_admin_database_v1.types import (
37+
CreateBackupEncryptionConfig,
38+
FullBackupSpec,
39+
)
3740

3841
client = spanner.Client()
3942
database_admin_api = client.database_admin_api
4043

4144
request = backup_schedule_pb.CreateBackupScheduleRequest(
4245
parent=database_admin_api.database_path(
43-
client.project,
44-
instance_id,
45-
database_id
46+
client.project, instance_id, database_id
4647
),
4748
backup_schedule_id=schedule_id,
4849
backup_schedule=backup_schedule_pb.BackupSchedule(
@@ -62,30 +63,32 @@ def create_full_backup_schedule(
6263
response = database_admin_api.create_backup_schedule(request)
6364
print(f"Created full backup schedule: {response}")
6465

66+
6567
# [END spanner_create_full_backup_schedule]
6668

6769

6870
# [START spanner_create_incremental_backup_schedule]
6971
def create_incremental_backup_schedule(
70-
instance_id: str,
71-
database_id: str,
72-
schedule_id: str,
72+
instance_id: str,
73+
database_id: str,
74+
schedule_id: str,
7375
) -> None:
7476
from datetime import timedelta
7577
from google.cloud import spanner
76-
from google.cloud.spanner_admin_database_v1.types import \
77-
backup_schedule as backup_schedule_pb
78-
from google.cloud.spanner_admin_database_v1.types import \
79-
CreateBackupEncryptionConfig, IncrementalBackupSpec
78+
from google.cloud.spanner_admin_database_v1.types import (
79+
backup_schedule as backup_schedule_pb,
80+
)
81+
from google.cloud.spanner_admin_database_v1.types import (
82+
CreateBackupEncryptionConfig,
83+
IncrementalBackupSpec,
84+
)
8085

8186
client = spanner.Client()
8287
database_admin_api = client.database_admin_api
8388

8489
request = backup_schedule_pb.CreateBackupScheduleRequest(
8590
parent=database_admin_api.database_path(
86-
client.project,
87-
instance_id,
88-
database_id
91+
client.project, instance_id, database_id
8992
),
9093
backup_schedule_id=schedule_id,
9194
backup_schedule=backup_schedule_pb.BackupSchedule(
@@ -105,14 +108,16 @@ def create_incremental_backup_schedule(
105108
response = database_admin_api.create_backup_schedule(request)
106109
print(f"Created incremental backup schedule: {response}")
107110

111+
108112
# [END spanner_create_incremental_backup_schedule]
109113

110114

111115
# [START spanner_list_backup_schedules]
112116
def list_backup_schedules(instance_id: str, database_id: str) -> None:
113117
from google.cloud import spanner
114-
from google.cloud.spanner_admin_database_v1.types import \
115-
backup_schedule as backup_schedule_pb
118+
from google.cloud.spanner_admin_database_v1.types import (
119+
backup_schedule as backup_schedule_pb,
120+
)
116121

117122
client = spanner.Client()
118123
database_admin_api = client.database_admin_api
@@ -128,18 +133,20 @@ def list_backup_schedules(instance_id: str, database_id: str) -> None:
128133
for backup_schedule in database_admin_api.list_backup_schedules(request):
129134
print(f"Backup schedule: {backup_schedule}")
130135

136+
131137
# [END spanner_list_backup_schedules]
132138

133139

134140
# [START spanner_get_backup_schedule]
135141
def get_backup_schedule(
136-
instance_id: str,
137-
database_id: str,
138-
schedule_id: str,
142+
instance_id: str,
143+
database_id: str,
144+
schedule_id: str,
139145
) -> None:
140146
from google.cloud import spanner
141-
from google.cloud.spanner_admin_database_v1.types import \
142-
backup_schedule as backup_schedule_pb
147+
from google.cloud.spanner_admin_database_v1.types import (
148+
backup_schedule as backup_schedule_pb,
149+
)
143150

144151
client = spanner.Client()
145152
database_admin_api = client.database_admin_api
@@ -156,21 +163,24 @@ def get_backup_schedule(
156163
response = database_admin_api.get_backup_schedule(request)
157164
print(f"Backup schedule: {response}")
158165

166+
159167
# [END spanner_get_backup_schedule]
160168

161169

162170
# [START spanner_update_backup_schedule]
163171
def update_backup_schedule(
164-
instance_id: str,
165-
database_id: str,
166-
schedule_id: str,
172+
instance_id: str,
173+
database_id: str,
174+
schedule_id: str,
167175
) -> None:
168176
from datetime import timedelta
169177
from google.cloud import spanner
170-
from google.cloud.spanner_admin_database_v1.types import \
171-
backup_schedule as backup_schedule_pb
172-
from google.cloud.spanner_admin_database_v1.types import \
173-
CreateBackupEncryptionConfig
178+
from google.cloud.spanner_admin_database_v1.types import (
179+
backup_schedule as backup_schedule_pb,
180+
)
181+
from google.cloud.spanner_admin_database_v1.types import (
182+
CreateBackupEncryptionConfig,
183+
)
174184
from google.protobuf.field_mask_pb2 import FieldMask
175185

176186
client = spanner.Client()
@@ -206,18 +216,20 @@ def update_backup_schedule(
206216
response = database_admin_api.update_backup_schedule(request)
207217
print(f"Updated backup schedule: {response}")
208218

219+
209220
# [END spanner_update_backup_schedule]
210221

211222

212223
# [START spanner_delete_backup_schedule]
213224
def delete_backup_schedule(
214-
instance_id: str,
215-
database_id: str,
216-
schedule_id: str,
225+
instance_id: str,
226+
database_id: str,
227+
schedule_id: str,
217228
) -> None:
218229
from google.cloud import spanner
219-
from google.cloud.spanner_admin_database_v1.types import \
220-
backup_schedule as backup_schedule_pb
230+
from google.cloud.spanner_admin_database_v1.types import (
231+
backup_schedule as backup_schedule_pb,
232+
)
221233

222234
client = spanner.Client()
223235
database_admin_api = client.database_admin_api
@@ -234,6 +246,7 @@ def delete_backup_schedule(
234246
database_admin_api.delete_backup_schedule(request)
235247
print("Deleted backup schedule")
236248

249+
237250
# [END spanner_delete_backup_schedule]
238251

239252

samples/samples/backup_schedule_samples_test.py

Lines changed: 30 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ def database_id():
3333

3434
@pytest.mark.dependency(name="create_full_backup_schedule")
3535
def test_create_full_backup_schedule(
36-
capsys,
37-
sample_instance,
38-
sample_database,
36+
capsys,
37+
sample_instance,
38+
sample_database,
3939
) -> None:
4040
samples.create_full_backup_schedule(
4141
sample_instance.instance_id,
@@ -53,9 +53,9 @@ def test_create_full_backup_schedule(
5353

5454
@pytest.mark.dependency(name="create_incremental_backup_schedule")
5555
def test_create_incremental_backup_schedule(
56-
capsys,
57-
sample_instance,
58-
sample_database,
56+
capsys,
57+
sample_instance,
58+
sample_database,
5959
) -> None:
6060
samples.create_incremental_backup_schedule(
6161
sample_instance.instance_id,
@@ -71,14 +71,16 @@ def test_create_incremental_backup_schedule(
7171
) in out
7272

7373

74-
@pytest.mark.dependency(depends=[
75-
"create_full_backup_schedule",
76-
"create_incremental_backup_schedule",
77-
])
74+
@pytest.mark.dependency(
75+
depends=[
76+
"create_full_backup_schedule",
77+
"create_incremental_backup_schedule",
78+
]
79+
)
7880
def test_list_backup_schedules(
79-
capsys,
80-
sample_instance,
81-
sample_database,
81+
capsys,
82+
sample_instance,
83+
sample_database,
8284
) -> None:
8385
samples.list_backup_schedules(
8486
sample_instance.instance_id,
@@ -99,9 +101,9 @@ def test_list_backup_schedules(
99101

100102
@pytest.mark.dependency(depends=["create_full_backup_schedule"])
101103
def test_get_backup_schedule(
102-
capsys,
103-
sample_instance,
104-
sample_database,
104+
capsys,
105+
sample_instance,
106+
sample_database,
105107
) -> None:
106108
samples.get_backup_schedule(
107109
sample_instance.instance_id,
@@ -118,9 +120,9 @@ def test_get_backup_schedule(
118120

119121
@pytest.mark.dependency(depends=["create_full_backup_schedule"])
120122
def test_update_backup_schedule(
121-
capsys,
122-
sample_instance,
123-
sample_database,
123+
capsys,
124+
sample_instance,
125+
sample_database,
124126
) -> None:
125127
samples.update_backup_schedule(
126128
sample_instance.instance_id,
@@ -136,14 +138,16 @@ def test_update_backup_schedule(
136138
) in out
137139

138140

139-
@pytest.mark.dependency(depends=[
140-
"create_full_backup_schedule",
141-
"create_incremental_backup_schedule",
142-
])
141+
@pytest.mark.dependency(
142+
depends=[
143+
"create_full_backup_schedule",
144+
"create_incremental_backup_schedule",
145+
]
146+
)
143147
def test_delete_backup_schedule(
144-
capsys,
145-
sample_instance,
146-
sample_database,
148+
capsys,
149+
sample_instance,
150+
sample_database,
147151
) -> None:
148152
samples.delete_backup_schedule(
149153
sample_instance.instance_id,

0 commit comments

Comments
 (0)