Skip to content

Commit 8dce7d1

Browse files
tswasttswast
authored
Use a valid email address in access control snippets. (googleapis#4458)
* Use a valid email address in access control snippets. Splits out access control sample for datasets into a standalone snippet for use in cloud.google.com docs. * Use .format() for dataset IDs in snippets.
1 parent 83865c2 commit 8dce7d1

2 files changed

Lines changed: 56 additions & 33 deletions

File tree

‎docs/bigquery/snippets.py‎

Lines changed: 50 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ def to_delete(client):
7373

7474

7575
def _millis():
76-
return time.time() * 1000
76+
return int(time.time() * 1000)
7777

7878

7979
class _CloseOnDelete(object):
@@ -99,7 +99,7 @@ def do_something_with(_):
9999

100100
def test_create_dataset(client, to_delete):
101101
"""Create a dataset."""
102-
DATASET_ID = 'create_dataset_%d' % (_millis(),)
102+
DATASET_ID = 'create_dataset_{}'.format(_millis())
103103

104104
# [START create_dataset]
105105
# DATASET_ID = 'dataset_ids_are_strings'
@@ -114,7 +114,7 @@ def test_create_dataset(client, to_delete):
114114

115115
def test_get_dataset(client, to_delete):
116116
"""Reload a dataset's metadata."""
117-
DATASET_ID = 'get_dataset_%d' % (_millis(),)
117+
DATASET_ID = 'get_dataset_{}'.format(_millis())
118118
dataset_ref = client.dataset(DATASET_ID)
119119
dataset = bigquery.Dataset(dataset_ref)
120120
dataset.description = ORIGINAL_DESCRIPTION
@@ -132,7 +132,7 @@ def test_get_dataset(client, to_delete):
132132

133133
def test_update_dataset_simple(client, to_delete):
134134
"""Update a dataset's metadata."""
135-
DATASET_ID = 'update_dataset_simple_%d' % (_millis(),)
135+
DATASET_ID = 'update_dataset_simple_{}'.format(_millis())
136136
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
137137
dataset.description = ORIGINAL_DESCRIPTION
138138
client.create_dataset(dataset)
@@ -150,7 +150,7 @@ def test_update_dataset_simple(client, to_delete):
150150

151151
def test_update_dataset_multiple_properties(client, to_delete):
152152
"""Update a dataset's metadata."""
153-
DATASET_ID = 'update_dataset_multiple_properties_%d' % (_millis(),)
153+
DATASET_ID = 'update_dataset_multiple_properties_{}'.format(_millis())
154154
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
155155
dataset.description = ORIGINAL_DESCRIPTION
156156
dataset = client.create_dataset(dataset)
@@ -159,30 +159,46 @@ def test_update_dataset_multiple_properties(client, to_delete):
159159
# [START update_dataset_multiple_properties]
160160
assert dataset.description == ORIGINAL_DESCRIPTION
161161
assert dataset.default_table_expiration_ms is None
162-
entry = bigquery.AccessEntry(
163-
role='READER', entity_type='domain', entity_id='example.com')
164-
assert entry not in dataset.access_entries
165162
ONE_DAY_MS = 24 * 60 * 60 * 1000 # in milliseconds
166163
dataset.description = UPDATED_DESCRIPTION
167164
dataset.default_table_expiration_ms = ONE_DAY_MS
168-
entries = list(dataset.access_entries)
169-
entries.append(entry)
170-
dataset.access_entries = entries
171165

172166
dataset = client.update_dataset(
173167
dataset,
174-
['description', 'default_table_expiration_ms', 'access_entries']
168+
['description', 'default_table_expiration_ms']
175169
) # API request
176170

177171
assert dataset.description == UPDATED_DESCRIPTION
178172
assert dataset.default_table_expiration_ms == ONE_DAY_MS
179-
assert entry in dataset.access_entries
180173
# [END update_dataset_multiple_properties]
181174

182175

176+
def test_update_dataset_access(client, to_delete):
177+
"""Update a dataset's metadata."""
178+
DATASET_ID = 'update_dataset_access_{}'.format(_millis())
179+
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
180+
dataset = client.create_dataset(dataset)
181+
to_delete.append(dataset)
182+
183+
# [START bigquery_update_dataset_access]
184+
entry = bigquery.AccessEntry(
185+
role='READER',
186+
entity_type='userByEmail',
187+
entity_id='sample.bigquery.dev@gmail.com')
188+
assert entry not in dataset.access_entries
189+
entries = list(dataset.access_entries)
190+
entries.append(entry)
191+
dataset.access_entries = entries
192+
193+
dataset = client.update_dataset(dataset, ['access_entries']) # API request
194+
195+
assert entry in dataset.access_entries
196+
# [END bigquery_update_dataset_access]
197+
198+
183199
def test_delete_dataset(client):
184200
"""Delete a dataset."""
185-
DATASET_ID = 'delete_dataset_%d' % (_millis(),)
201+
DATASET_ID = 'delete_dataset_{}'.format(_millis())
186202
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
187203
client.create_dataset(dataset)
188204

@@ -198,7 +214,7 @@ def test_delete_dataset(client):
198214

199215
def test_list_dataset_tables(client, to_delete):
200216
"""List tables within a dataset."""
201-
DATASET_ID = 'list_dataset_tables_dataset_%d' % (_millis(),)
217+
DATASET_ID = 'list_dataset_tables_dataset_{}'.format(_millis())
202218
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
203219
dataset = client.create_dataset(dataset)
204220
to_delete.append(dataset)
@@ -222,7 +238,7 @@ def test_list_dataset_tables(client, to_delete):
222238

223239
def test_create_table(client, to_delete):
224240
"""Create a table."""
225-
DATASET_ID = 'create_table_dataset_%d' % (_millis(),)
241+
DATASET_ID = 'create_table_dataset_{}'.format(_millis())
226242
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
227243
client.create_dataset(dataset)
228244
to_delete.append(dataset)
@@ -244,8 +260,8 @@ def test_create_table(client, to_delete):
244260

245261
def test_get_table(client, to_delete):
246262
"""Reload a table's metadata."""
247-
DATASET_ID = 'get_table_dataset_%d' % (_millis(),)
248-
TABLE_ID = 'get_table_table_%d' % (_millis(),)
263+
DATASET_ID = 'get_table_dataset_{}'.format(_millis())
264+
TABLE_ID = 'get_table_table_{}'.format(_millis())
249265
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
250266
dataset = client.create_dataset(dataset)
251267
to_delete.append(dataset)
@@ -265,8 +281,8 @@ def test_get_table(client, to_delete):
265281

266282
def test_update_table_simple(client, to_delete):
267283
"""Patch a table's metadata."""
268-
DATASET_ID = 'update_table_simple_dataset_%d' % (_millis(),)
269-
TABLE_ID = 'update_table_simple_table_%d' % (_millis(),)
284+
DATASET_ID = 'update_table_simple_dataset_{}'.format(_millis())
285+
TABLE_ID = 'update_table_simple_table_{}'.format(_millis())
270286
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
271287
dataset.description = ORIGINAL_DESCRIPTION
272288
client.create_dataset(dataset)
@@ -289,8 +305,9 @@ def test_update_table_simple(client, to_delete):
289305

290306
def test_update_table_multiple_properties(client, to_delete):
291307
"""Update a table's metadata."""
292-
DATASET_ID = 'update_table_multiple_properties_dataset_%d' % (_millis(),)
293-
TABLE_ID = 'update_table_multiple_properties_table_%d' % (_millis(),)
308+
DATASET_ID = 'update_table_multiple_properties_dataset_{}'.format(
309+
_millis())
310+
TABLE_ID = 'update_table_multiple_properties_table_{}'.format(_millis())
294311
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
295312
dataset.description = ORIGINAL_DESCRIPTION
296313
client.create_dataset(dataset)
@@ -324,8 +341,8 @@ def test_update_table_multiple_properties(client, to_delete):
324341

325342
def test_table_create_rows(client, to_delete):
326343
"""Insert / fetch table data."""
327-
DATASET_ID = 'table_create_rows_dataset_%d' % (_millis(),)
328-
TABLE_ID = 'table_create_rows_table_%d' % (_millis(),)
344+
DATASET_ID = 'table_create_rows_dataset_{}'.format(_millis())
345+
TABLE_ID = 'table_create_rows_table_{}'.format(_millis())
329346
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
330347
dataset = client.create_dataset(dataset)
331348
to_delete.append(dataset)
@@ -348,8 +365,8 @@ def test_table_create_rows(client, to_delete):
348365

349366
def test_load_table_from_file(client, to_delete):
350367
"""Upload table data from a CSV file."""
351-
DATASET_ID = 'table_upload_from_file_dataset_%d' % (_millis(),)
352-
TABLE_ID = 'table_upload_from_file_table_%d' % (_millis(),)
368+
DATASET_ID = 'table_upload_from_file_dataset_{}'.format(_millis())
369+
TABLE_ID = 'table_upload_from_file_table_{}'.format(_millis())
353370
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
354371
client.create_dataset(dataset)
355372
to_delete.append(dataset)
@@ -409,12 +426,12 @@ def test_load_table_from_uri(client, to_delete):
409426
('Bhettye Rhubble', 27),
410427
]
411428
HEADER_ROW = ('Full Name', 'Age')
412-
bucket_name = 'gs_bq_load_test_%d' % (_millis(),)
429+
bucket_name = 'gs_bq_load_test_{}'.format(_millis())
413430
blob_name = 'person_ages.csv'
414431
bucket, blob = _write_csv_to_storage(
415432
bucket_name, blob_name, HEADER_ROW, ROWS)
416433
to_delete.extend((blob, bucket))
417-
DATASET_ID = 'delete_table_dataset_%d' % (_millis(),)
434+
DATASET_ID = 'delete_table_dataset_{}'.format(_millis())
418435
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
419436
client.create_dataset(dataset)
420437
to_delete.append(dataset)
@@ -476,7 +493,7 @@ def _write_csv_to_storage(bucket_name, blob_name, header_row, data_rows):
476493

477494

478495
def test_copy_table(client, to_delete):
479-
DATASET_ID = 'copy_table_dataset_%d' % (_millis(),)
496+
DATASET_ID = 'copy_table_dataset_{}'.format(_millis())
480497
# [START copy_table]
481498
source_dataset = bigquery.DatasetReference(
482499
'bigquery-public-data', 'samples')
@@ -501,7 +518,7 @@ def test_copy_table(client, to_delete):
501518

502519

503520
def test_extract_table(client, to_delete):
504-
DATASET_ID = 'export_data_dataset_%d' % (_millis(),)
521+
DATASET_ID = 'export_data_dataset_{}'.format(_millis())
505522
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
506523
client.create_dataset(dataset)
507524
to_delete.append(dataset)
@@ -511,7 +528,7 @@ def test_extract_table(client, to_delete):
511528
to_delete.insert(0, table)
512529
client.create_rows(table, ROWS)
513530

514-
bucket_name = 'extract_person_ages_job_%d' % (_millis(),)
531+
bucket_name = 'extract_person_ages_job_{}'.format(_millis())
515532
# [START extract_table]
516533
from google.cloud.storage import Client as StorageClient
517534

@@ -534,8 +551,8 @@ def test_extract_table(client, to_delete):
534551

535552
def test_delete_table(client, to_delete):
536553
"""Delete a table."""
537-
DATASET_ID = 'delete_table_dataset_%d' % (_millis(),)
538-
TABLE_ID = 'delete_table_table_%d' % (_millis(),)
554+
DATASET_ID = 'delete_table_dataset_{}'.format(_millis())
555+
TABLE_ID = 'delete_table_table_{}'.format(_millis())
539556
dataset_ref = client.dataset(DATASET_ID)
540557
dataset = client.create_dataset(bigquery.Dataset(dataset_ref))
541558
to_delete.append(dataset)

‎docs/bigquery/usage.rst‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -110,6 +110,12 @@ Update multiple properties in a dataset's metadata:
110110
:start-after: [START update_dataset_multiple_properties]
111111
:end-before: [END update_dataset_multiple_properties]
112112

113+
Modify user permissions on a dataset:
114+
115+
.. literalinclude:: snippets.py
116+
:start-after: [START bigquery_update_dataset_access]
117+
:end-before: [END bigquery_update_dataset_access]
118+
113119
Delete a dataset:
114120

115121
.. literalinclude:: snippets.py

0 commit comments

Comments
 (0)