forked from googleapis/google-cloud-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathsnippets.py
More file actions
1032 lines (798 loc) · 34.6 KB
/
Copy pathsnippets.py
File metadata and controls
1032 lines (798 loc) · 34.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Copyright 2016 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.
"""Testable usage examples for Google BigQuery API wrapper
Each example function takes a ``client`` argument (which must be an instance
of :class:`google.cloud.bigquery.client.Client`) and uses it to perform a task
with the API.
To facilitate running the examples as system tests, each example is also passed
a ``to_delete`` list; the function adds to the list any objects created which
need to be deleted during teardown.
"""
import json
import time
import pytest
import six
from google.cloud import bigquery
ORIGINAL_FRIENDLY_NAME = 'Original friendly name'
ORIGINAL_DESCRIPTION = 'Original description'
LOCALLY_CHANGED_FRIENDLY_NAME = 'Locally-changed friendly name'
LOCALLY_CHANGED_DESCRIPTION = 'Locally-changed description'
UPDATED_FRIENDLY_NAME = 'Updated friendly name'
UPDATED_DESCRIPTION = 'Updated description'
SCHEMA = [
bigquery.SchemaField('full_name', 'STRING', mode='required'),
bigquery.SchemaField('age', 'INTEGER', mode='required'),
]
ROWS = [
('Phred Phlyntstone', 32),
('Bharney Rhubble', 33),
('Wylma Phlyntstone', 29),
('Bhettye Rhubble', 27),
]
QUERY = (
'SELECT name FROM `bigquery-public-data.usa_names.usa_1910_2013` '
'WHERE state = "TX"')
@pytest.fixture(scope='module')
def client():
return bigquery.Client()
@pytest.fixture
def to_delete(client):
doomed = []
yield doomed
for item in doomed:
if isinstance(item, (bigquery.Dataset, bigquery.DatasetReference)):
client.delete_dataset(item, delete_contents=True)
elif isinstance(item, (bigquery.Table, bigquery.TableReference)):
client.delete_table(item)
else:
item.delete()
def _millis():
return int(time.time() * 1000)
class _CloseOnDelete(object):
def __init__(self, wrapped):
self._wrapped = wrapped
def delete(self):
self._wrapped.close()
def test_client_list_datasets(client):
"""List datasets for a project."""
def do_something_with(_):
pass
# [START client_list_datasets]
for dataset in client.list_datasets(): # API request(s)
do_something_with(dataset)
# [END client_list_datasets]
def test_create_dataset(client, to_delete):
"""Create a dataset."""
DATASET_ID = 'create_dataset_{}'.format(_millis())
# [START create_dataset]
# DATASET_ID = 'dataset_ids_are_strings'
dataset_ref = client.dataset(DATASET_ID)
dataset = bigquery.Dataset(dataset_ref)
dataset.description = 'my dataset'
dataset = client.create_dataset(dataset) # API request
# [END create_dataset]
to_delete.append(dataset)
def test_get_dataset(client, to_delete):
"""Reload a dataset's metadata."""
DATASET_ID = 'get_dataset_{}'.format(_millis())
dataset_ref = client.dataset(DATASET_ID)
dataset = bigquery.Dataset(dataset_ref)
dataset.description = ORIGINAL_DESCRIPTION
dataset = client.create_dataset(dataset) # API request
to_delete.append(dataset)
# [START get_dataset]
assert dataset.description == ORIGINAL_DESCRIPTION
dataset.description = LOCALLY_CHANGED_DESCRIPTION
assert dataset.description == LOCALLY_CHANGED_DESCRIPTION
dataset = client.get_dataset(dataset) # API request
assert dataset.description == ORIGINAL_DESCRIPTION
# [END get_dataset]
# [START bigquery_dataset_exists]
def dataset_exists(client, dataset_reference):
"""Return if a dataset exists.
Args:
client (google.cloud.bigquery.client.Client):
A client to connect to the BigQuery API.
dataset_reference (google.cloud.bigquery.dataset.DatasetReference):
A reference to the dataset to look for.
Returns:
bool: ``True`` if the dataset exists, ``False`` otherwise.
"""
from google.cloud.exceptions import NotFound
try:
client.get_dataset(dataset_reference)
return True
except NotFound:
return False
# [END bigquery_dataset_exists]
def test_dataset_exists(client, to_delete):
"""Determine if a dataset exists."""
DATASET_ID = 'get_table_dataset_{}'.format(_millis())
dataset_ref = client.dataset(DATASET_ID)
dataset = bigquery.Dataset(dataset_ref)
dataset = client.create_dataset(dataset)
to_delete.append(dataset)
assert dataset_exists(client, dataset_ref)
assert not dataset_exists(client, client.dataset('i_dont_exist'))
def test_update_dataset_simple(client, to_delete):
"""Update a dataset's metadata."""
DATASET_ID = 'update_dataset_simple_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
dataset.description = ORIGINAL_DESCRIPTION
client.create_dataset(dataset)
to_delete.append(dataset)
# [START update_dataset_simple]
assert dataset.description == ORIGINAL_DESCRIPTION
dataset.description = UPDATED_DESCRIPTION
dataset = client.update_dataset(dataset, ['description']) # API request
assert dataset.description == UPDATED_DESCRIPTION
# [END update_dataset_simple]
def test_update_dataset_multiple_properties(client, to_delete):
"""Update a dataset's metadata."""
DATASET_ID = 'update_dataset_multiple_properties_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
dataset.description = ORIGINAL_DESCRIPTION
dataset = client.create_dataset(dataset)
to_delete.append(dataset)
# [START update_dataset_multiple_properties]
assert dataset.description == ORIGINAL_DESCRIPTION
assert dataset.default_table_expiration_ms is None
ONE_DAY_MS = 24 * 60 * 60 * 1000 # in milliseconds
dataset.description = UPDATED_DESCRIPTION
dataset.default_table_expiration_ms = ONE_DAY_MS
dataset = client.update_dataset(
dataset,
['description', 'default_table_expiration_ms']
) # API request
assert dataset.description == UPDATED_DESCRIPTION
assert dataset.default_table_expiration_ms == ONE_DAY_MS
# [END update_dataset_multiple_properties]
def test_update_dataset_access(client, to_delete):
"""Update a dataset's metadata."""
DATASET_ID = 'update_dataset_access_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
dataset = client.create_dataset(dataset)
to_delete.append(dataset)
# [START bigquery_update_dataset_access]
entry = bigquery.AccessEntry(
role='READER',
entity_type='userByEmail',
entity_id='sample.bigquery.dev@gmail.com')
assert entry not in dataset.access_entries
entries = list(dataset.access_entries)
entries.append(entry)
dataset.access_entries = entries
dataset = client.update_dataset(dataset, ['access_entries']) # API request
assert entry in dataset.access_entries
# [END bigquery_update_dataset_access]
def test_delete_dataset(client):
"""Delete a dataset."""
DATASET_ID = 'delete_dataset_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
client.create_dataset(dataset)
# [START delete_dataset]
from google.cloud.exceptions import NotFound
client.delete_dataset(dataset) # API request
with pytest.raises(NotFound):
client.get_dataset(dataset) # API request
# [END delete_dataset]
def test_list_tables(client, to_delete):
"""List tables within a dataset."""
DATASET_ID = 'list_tables_dataset_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
dataset = client.create_dataset(dataset)
to_delete.append(dataset)
# [START list_tables]
tables = list(client.list_tables(dataset)) # API request(s)
assert len(tables) == 0
table_ref = dataset.table('my_table')
table = bigquery.Table(table_ref)
table.view_query = QUERY
client.create_table(table) # API request
tables = list(client.list_tables(dataset)) # API request(s)
assert len(tables) == 1
assert tables[0].table_id == 'my_table'
# [END list_tables]
to_delete.insert(0, table)
def test_create_table(client, to_delete):
"""Create a table."""
DATASET_ID = 'create_table_dataset_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
client.create_dataset(dataset)
to_delete.append(dataset)
# [START create_table]
SCHEMA = [
bigquery.SchemaField('full_name', 'STRING', mode='required'),
bigquery.SchemaField('age', 'INTEGER', mode='required'),
]
table_ref = dataset.table('my_table')
table = bigquery.Table(table_ref, schema=SCHEMA)
table = client.create_table(table) # API request
assert table.table_id == 'my_table'
# [END create_table]
to_delete.insert(0, table)
def test_create_table_cmek(client, to_delete):
DATASET_ID = 'create_table_cmek_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
client.create_dataset(dataset)
to_delete.append(dataset)
# [START bigquery_create_table_cmek]
table_ref = dataset.table('my_table')
table = bigquery.Table(table_ref)
# Set the encryption key to use for the table.
# TODO: Replace this key with a key you have created in Cloud KMS.
kms_key_name = 'projects/{}/locations/{}/keyRings/{}/cryptoKeys/{}'.format(
'cloud-samples-tests', 'us-central1', 'test', 'test')
table.encryption_configuration = bigquery.EncryptionConfiguration(
kms_key_name=kms_key_name)
table = client.create_table(table) # API request
assert table.encryption_configuration.kms_key_name == kms_key_name
# [END bigquery_create_table_cmek]
def test_get_table(client, to_delete):
"""Reload a table's metadata."""
DATASET_ID = 'get_table_dataset_{}'.format(_millis())
TABLE_ID = 'get_table_table_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
dataset = client.create_dataset(dataset)
to_delete.append(dataset)
table = bigquery.Table(dataset.table(TABLE_ID), schema=SCHEMA)
table.description = ORIGINAL_DESCRIPTION
table = client.create_table(table)
to_delete.insert(0, table)
# [START get_table]
assert table.description == ORIGINAL_DESCRIPTION
table.description = LOCALLY_CHANGED_DESCRIPTION
table = client.get_table(table) # API request
assert table.description == ORIGINAL_DESCRIPTION
# [END get_table]
# [START bigquery_table_exists]
def table_exists(client, table_reference):
"""Return if a table exists.
Args:
client (google.cloud.bigquery.client.Client):
A client to connect to the BigQuery API.
table_reference (google.cloud.bigquery.table.TableReference):
A reference to the table to look for.
Returns:
bool: ``True`` if the table exists, ``False`` otherwise.
"""
from google.cloud.exceptions import NotFound
try:
client.get_table(table_reference)
return True
except NotFound:
return False
# [END bigquery_table_exists]
def test_table_exists(client, to_delete):
"""Determine if a table exists."""
DATASET_ID = 'get_table_dataset_{}'.format(_millis())
TABLE_ID = 'get_table_table_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
dataset = client.create_dataset(dataset)
to_delete.append(dataset)
table_ref = dataset.table(TABLE_ID)
table = bigquery.Table(table_ref, schema=SCHEMA)
table = client.create_table(table)
to_delete.insert(0, table)
assert table_exists(client, table_ref)
assert not table_exists(client, dataset.table('i_dont_exist'))
def test_update_table_simple(client, to_delete):
"""Patch a table's metadata."""
DATASET_ID = 'update_table_simple_dataset_{}'.format(_millis())
TABLE_ID = 'update_table_simple_table_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
dataset.description = ORIGINAL_DESCRIPTION
client.create_dataset(dataset)
to_delete.append(dataset)
table = bigquery.Table(dataset.table(TABLE_ID), schema=SCHEMA)
table.description = ORIGINAL_DESCRIPTION
table = client.create_table(table)
to_delete.insert(0, table)
# [START update_table_simple]
assert table.description == ORIGINAL_DESCRIPTION
table.description = UPDATED_DESCRIPTION
table = client.update_table(table, ['description']) # API request
assert table.description == UPDATED_DESCRIPTION
# [END update_table_simple]
def test_update_table_multiple_properties(client, to_delete):
"""Update a table's metadata."""
DATASET_ID = 'update_table_multiple_properties_dataset_{}'.format(
_millis())
TABLE_ID = 'update_table_multiple_properties_table_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
dataset.description = ORIGINAL_DESCRIPTION
client.create_dataset(dataset)
to_delete.append(dataset)
table = bigquery.Table(dataset.table(TABLE_ID), schema=SCHEMA)
table.friendly_name = ORIGINAL_FRIENDLY_NAME
table.description = ORIGINAL_DESCRIPTION
table = client.create_table(table)
to_delete.insert(0, table)
# [START update_table_multiple_properties]
assert table.friendly_name == ORIGINAL_FRIENDLY_NAME
assert table.description == ORIGINAL_DESCRIPTION
NEW_SCHEMA = list(table.schema)
NEW_SCHEMA.append(bigquery.SchemaField('phone', 'STRING'))
table.friendly_name = UPDATED_FRIENDLY_NAME
table.description = UPDATED_DESCRIPTION
table.schema = NEW_SCHEMA
table = client.update_table(
table,
['schema', 'friendly_name', 'description']
) # API request
assert table.friendly_name == UPDATED_FRIENDLY_NAME
assert table.description == UPDATED_DESCRIPTION
assert table.schema == NEW_SCHEMA
# [END update_table_multiple_properties]
def test_update_table_cmek(client, to_delete):
"""Patch a table's metadata."""
dataset_id = 'update_table_cmek_{}'.format(_millis())
table_id = 'update_table_cmek_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(dataset_id))
client.create_dataset(dataset)
to_delete.append(dataset)
table = bigquery.Table(dataset.table(table_id))
original_kms_key_name = (
'projects/{}/locations/{}/keyRings/{}/cryptoKeys/{}'.format(
'cloud-samples-tests', 'us-central1', 'test', 'test'))
table.encryption_configuration = bigquery.EncryptionConfiguration(
kms_key_name=original_kms_key_name)
table = client.create_table(table)
to_delete.insert(0, table)
# [START bigquery_update_table_cmek]
assert table.encryption_configuration.kms_key_name == original_kms_key_name
# Set a new encryption key to use for the destination.
# TODO: Replace this key with a key you have created in KMS.
updated_kms_key_name = (
'projects/cloud-samples-tests/locations/us-central1/'
'keyRings/test/cryptoKeys/otherkey')
table.encryption_configuration = bigquery.EncryptionConfiguration(
kms_key_name=updated_kms_key_name)
table = client.update_table(
table, ['encryption_configuration']) # API request
assert table.encryption_configuration.kms_key_name == updated_kms_key_name
assert original_kms_key_name != updated_kms_key_name
# [END bigquery_update_table_cmek]
def test_table_insert_rows(client, to_delete):
"""Insert / fetch table data."""
dataset_id = 'table_insert_rows_dataset_{}'.format(_millis())
table_id = 'table_insert_rows_table_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(dataset_id))
dataset = client.create_dataset(dataset)
to_delete.append(dataset)
table = bigquery.Table(dataset.table(table_id), schema=SCHEMA)
table = client.create_table(table)
to_delete.insert(0, table)
# [START table_insert_rows]
rows_to_insert = [
(u'Phred Phlyntstone', 32),
(u'Wylma Phlyntstone', 29),
]
errors = client.insert_rows(table, rows_to_insert) # API request
assert errors == []
# [END table_insert_rows]
def test_load_table_from_file(client, to_delete):
"""Upload table data from a CSV file."""
DATASET_ID = 'table_upload_from_file_dataset_{}'.format(_millis())
TABLE_ID = 'table_upload_from_file_table_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
client.create_dataset(dataset)
to_delete.append(dataset)
# [START load_table_from_file]
csv_file = six.BytesIO(b"""full_name,age
Phred Phlyntstone,32
Wylma Phlyntstone,29
""")
table_ref = dataset.table(TABLE_ID)
job_config = bigquery.LoadJobConfig()
job_config.source_format = 'CSV'
job_config.skip_leading_rows = 1
job_config.autodetect = True
job = client.load_table_from_file(
csv_file, table_ref, job_config=job_config) # API request
job.result() # Waits for table load to complete.
# [END load_table_from_file]
table = client.get_table(table_ref)
to_delete.insert(0, table)
found_rows = []
def do_something(row):
found_rows.append(row)
# [START table_list_rows]
for row in client.list_rows(table): # API request
do_something(row)
# [END table_list_rows]
assert len(found_rows) == 2
# [START table_list_rows_iterator_properties]
iterator = client.list_rows(table) # API request
page = six.next(iterator.pages)
rows = list(page)
total = iterator.total_rows
token = iterator.next_page_token
# [END table_list_rows_iterator_properties]
assert len(rows) == total == 2
assert token is None
# Order is not preserved, so compare individually
row1 = bigquery.Row(('Wylma Phlyntstone', 29), {'full_name': 0, 'age': 1})
assert row1 in rows
row2 = bigquery.Row(('Phred Phlyntstone', 32), {'full_name': 0, 'age': 1})
assert row2 in rows
def test_load_table_from_uri(client, to_delete):
dataset_id = 'load_table_dataset_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(dataset_id))
client.create_dataset(dataset)
to_delete.append(dataset)
# [START bigquery_load_table_gcs_json]
# dataset_id = 'my_dataset'
dataset_ref = client.dataset(dataset_id)
job_config = bigquery.LoadJobConfig()
job_config.schema = [
bigquery.SchemaField('name', 'STRING'),
bigquery.SchemaField('post_abbr', 'STRING')
]
job_config.source_format = 'NEWLINE_DELIMITED_JSON'
load_job = client.load_table_from_uri(
'gs://cloud-samples-data/bigquery/us-states/us-states.json',
dataset_ref.table('us_states'),
job_config=job_config) # API request
assert load_job.job_type == 'load'
load_job.result() # Waits for table load to complete.
assert load_job.state == 'DONE'
assert client.get_table(dataset_ref.table('us_states')).num_rows > 0
# [END bigquery_load_table_gcs_json]
def test_load_table_from_uri_cmek(client, to_delete):
dataset_id = 'load_table_from_uri_cmek_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(dataset_id))
client.create_dataset(dataset)
to_delete.append(dataset)
# [START bigquery_load_table_gcs_json_cmek]
# dataset_id = 'my_dataset'
dataset_ref = client.dataset(dataset_id)
job_config = bigquery.LoadJobConfig()
job_config.autodetect = True
job_config.source_format = 'NEWLINE_DELIMITED_JSON'
# Set the encryption key to use for the destination.
# TODO: Replace this key with a key you have created in KMS.
kms_key_name = 'projects/{}/locations/{}/keyRings/{}/cryptoKeys/{}'.format(
'cloud-samples-tests', 'us-central1', 'test', 'test')
encryption_config = bigquery.EncryptionConfiguration(
kms_key_name=kms_key_name)
job_config.destination_encryption_configuration = encryption_config
load_job = client.load_table_from_uri(
'gs://cloud-samples-data/bigquery/us-states/us-states.json',
dataset_ref.table('us_states'),
job_config=job_config) # API request
assert load_job.job_type == 'load'
load_job.result() # Waits for table load to complete.
assert load_job.state == 'DONE'
table = client.get_table(dataset_ref.table('us_states'))
assert table.encryption_configuration.kms_key_name == kms_key_name
# [END bigquery_load_table_gcs_json_cmek]
def test_load_table_from_uri_autodetect(client, to_delete):
dataset_id = 'load_table_dataset_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(dataset_id))
client.create_dataset(dataset)
to_delete.append(dataset)
# [START bigquery_load_table_gcs_json_autodetect]
# dataset_id = 'my_dataset'
dataset_ref = client.dataset(dataset_id)
job_config = bigquery.LoadJobConfig()
job_config.autodetect = True
job_config.source_format = 'NEWLINE_DELIMITED_JSON'
load_job = client.load_table_from_uri(
'gs://cloud-samples-data/bigquery/us-states/us-states.json',
dataset_ref.table('us_states'),
job_config=job_config) # API request
assert load_job.job_type == 'load'
load_job.result() # Waits for table load to complete.
assert load_job.state == 'DONE'
assert client.get_table(dataset_ref.table('us_states')).num_rows > 0
# [END bigquery_load_table_gcs_json_autodetect]
def test_load_table_from_uri_append(client, to_delete):
dataset_id = 'load_table_dataset_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(dataset_id))
client.create_dataset(dataset)
to_delete.append(dataset)
job_config = bigquery.LoadJobConfig()
job_config.schema = [
bigquery.SchemaField('name', 'STRING'),
bigquery.SchemaField('post_abbr', 'STRING')
]
table_ref = dataset.table('us_states')
body = six.StringIO('Washington,WA')
client.load_table_from_file(
body, table_ref, job_config=job_config).result()
# [START bigquery_load_table_gcs_json_append]
# table_ref = client.dataset('my_dataset').table('existing_table')
previous_rows = client.get_table(table_ref).num_rows
job_config = bigquery.LoadJobConfig()
job_config.source_format = 'NEWLINE_DELIMITED_JSON'
job_config.write_disposition = 'WRITE_APPEND'
load_job = client.load_table_from_uri(
'gs://cloud-samples-data/bigquery/us-states/us-states.json',
table_ref,
job_config=job_config) # API request
assert load_job.job_type == 'load'
load_job.result() # Waits for table load to complete.
assert load_job.state == 'DONE'
assert client.get_table(table_ref).num_rows == previous_rows + 50
# [END bigquery_load_table_gcs_json_append]
def test_load_table_from_uri_truncate(client, to_delete):
dataset_id = 'load_table_dataset_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(dataset_id))
client.create_dataset(dataset)
to_delete.append(dataset)
job_config = bigquery.LoadJobConfig()
job_config.schema = [
bigquery.SchemaField('name', 'STRING'),
bigquery.SchemaField('post_abbr', 'STRING')
]
table_ref = dataset.table('us_states')
body = six.StringIO('Washington,WA')
client.load_table_from_file(
body, table_ref, job_config=job_config).result()
# [START bigquery_load_table_gcs_json_truncate]
# table_ref = client.dataset('my_dataset').table('existing_table')
previous_rows = client.get_table(table_ref).num_rows
assert previous_rows > 0
job_config = bigquery.LoadJobConfig()
job_config.source_format = 'NEWLINE_DELIMITED_JSON'
job_config.write_disposition = 'WRITE_TRUNCATE'
load_job = client.load_table_from_uri(
'gs://cloud-samples-data/bigquery/us-states/us-states.json',
table_ref,
job_config=job_config) # API request
assert load_job.job_type == 'load'
load_job.result() # Waits for table load to complete.
assert load_job.state == 'DONE'
assert client.get_table(table_ref).num_rows == 50
# [END bigquery_load_table_gcs_json_truncate]
def _write_csv_to_storage(bucket_name, blob_name, header_row, data_rows):
import csv
from google.cloud._testing import _NamedTemporaryFile
from google.cloud.storage import Client as StorageClient
storage_client = StorageClient()
# In the **very** rare case the bucket name is reserved, this
# fails with a ConnectionError.
bucket = storage_client.create_bucket(bucket_name)
blob = bucket.blob(blob_name)
with _NamedTemporaryFile() as temp:
with open(temp.name, 'w') as csv_write:
writer = csv.writer(csv_write)
writer.writerow(header_row)
writer.writerows(data_rows)
with open(temp.name, 'rb') as csv_read:
blob.upload_from_file(csv_read, content_type='text/csv')
return bucket, blob
def test_copy_table(client, to_delete):
dataset_id = 'copy_table_dataset_{}'.format(_millis())
dest_dataset = bigquery.Dataset(client.dataset(dataset_id))
dest_dataset = client.create_dataset(dest_dataset)
to_delete.append(dest_dataset)
# [START copy_table]
source_dataset = bigquery.DatasetReference(
'bigquery-public-data', 'samples')
source_table_ref = source_dataset.table('shakespeare')
# dataset_id = 'my_dataset'
dest_table_ref = dest_dataset.table('destination_table')
job = client.copy_table(source_table_ref, dest_table_ref) # API request
job.result() # Waits for job to complete.
assert job.state == 'DONE'
dest_table = client.get_table(dest_table_ref) # API request
assert dest_table.table_id == 'destination_table'
# [END copy_table]
to_delete.insert(0, dest_table)
def test_copy_table_cmek(client, to_delete):
dataset_id = 'copy_table_cmek_{}'.format(_millis())
dest_dataset = bigquery.Dataset(client.dataset(dataset_id))
dest_dataset = client.create_dataset(dest_dataset)
to_delete.append(dest_dataset)
# [START bigquery_copy_table_cmek]
source_dataset = bigquery.DatasetReference(
'bigquery-public-data', 'samples')
source_table_ref = source_dataset.table('shakespeare')
# dataset_id = 'my_dataset'
dest_dataset_ref = client.dataset(dataset_id)
dest_table_ref = dest_dataset_ref.table('destination_table')
# Set the encryption key to use for the destination.
# TODO: Replace this key with a key you have created in KMS.
kms_key_name = 'projects/{}/locations/{}/keyRings/{}/cryptoKeys/{}'.format(
'cloud-samples-tests', 'us-central1', 'test', 'test')
encryption_config = bigquery.EncryptionConfiguration(
kms_key_name=kms_key_name)
job_config = bigquery.CopyJobConfig()
job_config.destination_encryption_configuration = encryption_config
job = client.copy_table(
source_table_ref, dest_table_ref, job_config=job_config) # API request
job.result() # Waits for job to complete.
assert job.state == 'DONE'
dest_table = client.get_table(dest_table_ref)
assert dest_table.encryption_configuration.kms_key_name == kms_key_name
# [END bigquery_copy_table_cmek]
to_delete.insert(0, dest_table)
def test_extract_table(client, to_delete):
DATASET_ID = 'export_data_dataset_{}'.format(_millis())
dataset = bigquery.Dataset(client.dataset(DATASET_ID))
client.create_dataset(dataset)
to_delete.append(dataset)
table_ref = dataset.table('person_ages')
to_insert = [
{'full_name': name, 'age': age}
for name, age in ROWS
]
rows = [json.dumps(row) for row in to_insert]
body = six.StringIO('{}\n'.format('\n'.join(rows)))
job_config = bigquery.LoadJobConfig()
job_config.write_disposition = 'WRITE_TRUNCATE'
job_config.source_format = 'NEWLINE_DELIMITED_JSON'
job_config.schema = SCHEMA
to_delete.insert(0, table_ref)
# Load a table using a local JSON file from memory.
client.load_table_from_file(
body, table_ref, job_config=job_config).result()
bucket_name = 'extract_person_ages_job_{}'.format(_millis())
# [START extract_table]
from google.cloud.storage import Client as StorageClient
storage_client = StorageClient()
bucket = storage_client.create_bucket(bucket_name) # API request
destination_blob_name = 'person_ages_out.csv'
destination = bucket.blob(destination_blob_name)
destination_uri = 'gs://{}/{}'.format(bucket_name, destination_blob_name)
extract_job = client.extract_table(
table_ref, destination_uri) # API request
extract_job.result(timeout=100) # Waits for job to complete.
got = destination.download_as_string().decode('utf-8') # API request
assert 'Bharney Rhubble' in got
# [END extract_table]
to_delete.append(bucket)
to_delete.insert(0, destination)
def test_delete_table(client, to_delete):
"""Delete a table."""
DATASET_ID = 'delete_table_dataset_{}'.format(_millis())
TABLE_ID = 'delete_table_table_{}'.format(_millis())
dataset_ref = client.dataset(DATASET_ID)
dataset = client.create_dataset(bigquery.Dataset(dataset_ref))
to_delete.append(dataset)
table_ref = dataset.table(TABLE_ID)
table = bigquery.Table(table_ref, schema=SCHEMA)
client.create_table(table)
# [START delete_table]
from google.cloud.exceptions import NotFound
client.delete_table(table) # API request
with pytest.raises(NotFound):
client.get_table(table) # API request
# [END delete_table]
def test_client_simple_query(client):
"""Run a simple query."""
# [START client_simple_query]
QUERY = (
'SELECT name FROM `bigquery-public-data.usa_names.usa_1910_2013` '
'WHERE state = "TX" '
'LIMIT 100')
query_job = client.query(QUERY)
for row in query_job: # API request
# Row values can be accessed by field name or index
assert row[0] == row.name == row['name']
# [END client_simple_query]
def test_client_query(client):
"""Run a query"""
# [START client_query]
QUERY = (
'SELECT name FROM `bigquery-public-data.usa_names.usa_1910_2013` '
'WHERE state = "TX" '
'LIMIT 100')
TIMEOUT = 30 # in seconds
query_job = client.query(QUERY) # API request - starts the query
# Waits for the query to finish
iterator = query_job.result(timeout=TIMEOUT)
rows = list(iterator)
assert query_job.state == 'DONE'
assert len(rows) == 100
row = rows[0]
assert row[0] == row.name == row['name']
# [END client_query]
def test_client_query_destination_table(client, to_delete):
"""Run a query"""
dataset_id = 'query_destination_table_{}'.format(_millis())
dataset_ref = client.dataset(dataset_id)
to_delete.append(dataset_ref)
client.create_dataset(bigquery.Dataset(dataset_ref))
to_delete.insert(0, dataset_ref.table('your_table_id'))
# [START bigquery_query_destination_table]
job_config = bigquery.QueryJobConfig()
# Set the destination table. Here, dataset_id is a string, such as:
# dataset_id = 'your_dataset_id'
table_ref = client.dataset(dataset_id).table('your_table_id')
job_config.destination = table_ref
# The write_disposition specifies the behavior when writing query results
# to a table that already exists. With WRITE_TRUNCATE, any existing rows
# in the table are overwritten by the query results.
job_config.write_disposition = 'WRITE_TRUNCATE'
# Start the query, passing in the extra configuration.
query_job = client.query(
'SELECT 17 AS my_col;', job_config=job_config)
rows = list(query_job) # Waits for the query to finish
assert len(rows) == 1
row = rows[0]
assert row[0] == row.my_col == 17
# In addition to using the results from the query, you can read the rows
# from the destination table directly.
iterator = client.list_rows(
table_ref, selected_fields=[bigquery.SchemaField('my_col', 'INT64')])
rows = list(iterator)
assert len(rows) == 1
row = rows[0]
assert row[0] == row.my_col == 17
# [END bigquery_query_destination_table]
def test_client_query_destination_table_cmek(client, to_delete):
"""Run a query"""
dataset_id = 'query_destination_table_{}'.format(_millis())
dataset_ref = client.dataset(dataset_id)
to_delete.append(dataset_ref)
client.create_dataset(bigquery.Dataset(dataset_ref))
to_delete.insert(0, dataset_ref.table('your_table_id'))
# [START bigquery_query_destination_table_cmek]
job_config = bigquery.QueryJobConfig()
# Set the destination table. Here, dataset_id is a string, such as:
# dataset_id = 'your_dataset_id'
table_ref = client.dataset(dataset_id).table('your_table_id')
job_config.destination = table_ref
# Set the encryption key to use for the destination.
# TODO: Replace this key with a key you have created in KMS.
kms_key_name = 'projects/{}/locations/{}/keyRings/{}/cryptoKeys/{}'.format(
'cloud-samples-tests', 'us-central1', 'test', 'test')
encryption_config = bigquery.EncryptionConfiguration(
kms_key_name=kms_key_name)
job_config.destination_encryption_configuration = encryption_config
# Start the query, passing in the extra configuration.
query_job = client.query(
'SELECT 17 AS my_col;', job_config=job_config)
query_job.result()
# The destination table is written using the encryption configuration.
table = client.get_table(table_ref)
assert table.encryption_configuration.kms_key_name == kms_key_name
# [END bigquery_query_destination_table_cmek]
def test_client_query_w_param(client):
"""Run a query using a query parameter"""
# [START client_query_w_param]
QUERY_W_PARAM = (
'SELECT name, state '
'FROM `bigquery-public-data.usa_names.usa_1910_2013` '
'WHERE state = @state '
'LIMIT 100')
TIMEOUT = 30 # in seconds
param = bigquery.ScalarQueryParameter('state', 'STRING', 'TX')