This repository was archived by the owner on Mar 6, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 326
Expand file tree
/
Copy pathexternal_config.py
More file actions
1304 lines (1034 loc) · 44.9 KB
/
external_config.py
File metadata and controls
1304 lines (1034 loc) · 44.9 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 2017 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.
"""Define classes that describe external data sources.
These are used for both Table.externalDataConfiguration and
Job.configuration.query.tableDefinitions.
"""
from __future__ import absolute_import, annotations
import base64
import copy
import typing
from typing import Any, Dict, FrozenSet, Iterable, Optional, Union
from google.cloud.bigquery._helpers import _to_bytes
from google.cloud.bigquery._helpers import _bytes_to_json
from google.cloud.bigquery._helpers import _int_or_none
from google.cloud.bigquery._helpers import _str_or_none
from google.cloud.bigquery import _helpers
from google.cloud.bigquery.enums import SourceColumnMatch
from google.cloud.bigquery.format_options import AvroOptions, ParquetOptions
from google.cloud.bigquery import schema
from google.cloud.bigquery.schema import SchemaField
class ExternalSourceFormat(object):
"""The format for external data files.
Note that the set of allowed values for external data sources is different
than the set used for loading data (see
:class:`~google.cloud.bigquery.job.SourceFormat`).
"""
CSV = "CSV"
"""Specifies CSV format."""
GOOGLE_SHEETS = "GOOGLE_SHEETS"
"""Specifies Google Sheets format."""
NEWLINE_DELIMITED_JSON = "NEWLINE_DELIMITED_JSON"
"""Specifies newline delimited JSON format."""
AVRO = "AVRO"
"""Specifies Avro format."""
DATASTORE_BACKUP = "DATASTORE_BACKUP"
"""Specifies datastore backup format"""
ORC = "ORC"
"""Specifies ORC format."""
PARQUET = "PARQUET"
"""Specifies Parquet format."""
BIGTABLE = "BIGTABLE"
"""Specifies Bigtable format."""
class BigtableColumn(object):
"""Options for a Bigtable column."""
def __init__(self):
self._properties = {}
@property
def encoding(self):
"""str: The encoding of the values when the type is not `STRING`
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.encoding
"""
return self._properties.get("encoding")
@encoding.setter
def encoding(self, value):
self._properties["encoding"] = value
@property
def field_name(self):
"""str: An identifier to use if the qualifier is not a valid BigQuery
field identifier
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.field_name
"""
return self._properties.get("fieldName")
@field_name.setter
def field_name(self, value):
self._properties["fieldName"] = value
@property
def only_read_latest(self):
"""bool: If this is set, only the latest version of value in this
column are exposed.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.only_read_latest
"""
return self._properties.get("onlyReadLatest")
@only_read_latest.setter
def only_read_latest(self, value):
self._properties["onlyReadLatest"] = value
@property
def qualifier_encoded(self):
"""Union[str, bytes]: The qualifier encoded in binary.
The type is ``str`` (Python 2.x) or ``bytes`` (Python 3.x). The module
will handle base64 encoding for you.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.qualifier_encoded
"""
prop = self._properties.get("qualifierEncoded")
if prop is None:
return None
return base64.standard_b64decode(_to_bytes(prop))
@qualifier_encoded.setter
def qualifier_encoded(self, value):
self._properties["qualifierEncoded"] = _bytes_to_json(value)
@property
def qualifier_string(self):
"""str: A valid UTF-8 string qualifier
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.qualifier_string
"""
return self._properties.get("qualifierString")
@qualifier_string.setter
def qualifier_string(self, value):
self._properties["qualifierString"] = value
@property
def type_(self):
"""str: The type to convert the value in cells of this column.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumn.FIELDS.type
"""
return self._properties.get("type")
@type_.setter
def type_(self, value):
self._properties["type"] = value
def to_api_repr(self) -> dict:
"""Build an API representation of this object.
Returns:
Dict[str, Any]:
A dictionary in the format used by the BigQuery API.
"""
return copy.deepcopy(self._properties)
@classmethod
def from_api_repr(cls, resource: dict) -> "BigtableColumn":
"""Factory: construct a :class:`~.external_config.BigtableColumn`
instance given its API representation.
Args:
resource (Dict[str, Any]):
Definition of a :class:`~.external_config.BigtableColumn`
instance in the same representation as is returned from the
API.
Returns:
external_config.BigtableColumn: Configuration parsed from ``resource``.
"""
config = cls()
config._properties = copy.deepcopy(resource)
return config
class BigtableColumnFamily(object):
"""Options for a Bigtable column family."""
def __init__(self):
self._properties = {}
@property
def encoding(self):
"""str: The encoding of the values when the type is not `STRING`
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.encoding
"""
return self._properties.get("encoding")
@encoding.setter
def encoding(self, value):
self._properties["encoding"] = value
@property
def family_id(self):
"""str: Identifier of the column family.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.family_id
"""
return self._properties.get("familyId")
@family_id.setter
def family_id(self, value):
self._properties["familyId"] = value
@property
def only_read_latest(self):
"""bool: If this is set only the latest version of value are exposed
for all columns in this column family.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.only_read_latest
"""
return self._properties.get("onlyReadLatest")
@only_read_latest.setter
def only_read_latest(self, value):
self._properties["onlyReadLatest"] = value
@property
def type_(self):
"""str: The type to convert the value in cells of this column family.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.type
"""
return self._properties.get("type")
@type_.setter
def type_(self, value):
self._properties["type"] = value
@property
def columns(self):
"""List[BigtableColumn]: Lists of columns
that should be exposed as individual fields.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableColumnFamily.FIELDS.columns
"""
prop = self._properties.get("columns", [])
return [BigtableColumn.from_api_repr(col) for col in prop]
@columns.setter
def columns(self, value):
self._properties["columns"] = [col.to_api_repr() for col in value]
def to_api_repr(self) -> dict:
"""Build an API representation of this object.
Returns:
Dict[str, Any]:
A dictionary in the format used by the BigQuery API.
"""
return copy.deepcopy(self._properties)
@classmethod
def from_api_repr(cls, resource: dict) -> "BigtableColumnFamily":
"""Factory: construct a :class:`~.external_config.BigtableColumnFamily`
instance given its API representation.
Args:
resource (Dict[str, Any]):
Definition of a :class:`~.external_config.BigtableColumnFamily`
instance in the same representation as is returned from the
API.
Returns:
:class:`~.external_config.BigtableColumnFamily`:
Configuration parsed from ``resource``.
"""
config = cls()
config._properties = copy.deepcopy(resource)
return config
class BigtableOptions(object):
"""Options that describe how to treat Bigtable tables as BigQuery tables."""
_SOURCE_FORMAT = "BIGTABLE"
_RESOURCE_NAME = "bigtableOptions"
def __init__(self):
self._properties = {}
@property
def ignore_unspecified_column_families(self):
"""bool: If :data:`True`, ignore columns not specified in
:attr:`column_families` list. Defaults to :data:`False`.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableOptions.FIELDS.ignore_unspecified_column_families
"""
return self._properties.get("ignoreUnspecifiedColumnFamilies")
@ignore_unspecified_column_families.setter
def ignore_unspecified_column_families(self, value):
self._properties["ignoreUnspecifiedColumnFamilies"] = value
@property
def read_rowkey_as_string(self):
"""bool: If :data:`True`, rowkey column families will be read and
converted to string. Defaults to :data:`False`.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableOptions.FIELDS.read_rowkey_as_string
"""
return self._properties.get("readRowkeyAsString")
@read_rowkey_as_string.setter
def read_rowkey_as_string(self, value):
self._properties["readRowkeyAsString"] = value
@property
def column_families(self):
"""List[:class:`~.external_config.BigtableColumnFamily`]: List of
column families to expose in the table schema along with their types.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#BigtableOptions.FIELDS.column_families
"""
prop = self._properties.get("columnFamilies", [])
return [BigtableColumnFamily.from_api_repr(cf) for cf in prop]
@column_families.setter
def column_families(self, value):
self._properties["columnFamilies"] = [cf.to_api_repr() for cf in value]
def to_api_repr(self) -> dict:
"""Build an API representation of this object.
Returns:
Dict[str, Any]:
A dictionary in the format used by the BigQuery API.
"""
return copy.deepcopy(self._properties)
@classmethod
def from_api_repr(cls, resource: dict) -> "BigtableOptions":
"""Factory: construct a :class:`~.external_config.BigtableOptions`
instance given its API representation.
Args:
resource (Dict[str, Any]):
Definition of a :class:`~.external_config.BigtableOptions`
instance in the same representation as is returned from the
API.
Returns:
BigtableOptions: Configuration parsed from ``resource``.
"""
config = cls()
config._properties = copy.deepcopy(resource)
return config
class CSVOptions(object):
"""Options that describe how to treat CSV files as BigQuery tables."""
_SOURCE_FORMAT = "CSV"
_RESOURCE_NAME = "csvOptions"
def __init__(self):
self._properties = {}
@property
def allow_jagged_rows(self):
"""bool: If :data:`True`, BigQuery treats missing trailing columns as
null values. Defaults to :data:`False`.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.allow_jagged_rows
"""
return self._properties.get("allowJaggedRows")
@allow_jagged_rows.setter
def allow_jagged_rows(self, value):
self._properties["allowJaggedRows"] = value
@property
def allow_quoted_newlines(self):
"""bool: If :data:`True`, quoted data sections that contain newline
characters in a CSV file are allowed. Defaults to :data:`False`.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.allow_quoted_newlines
"""
return self._properties.get("allowQuotedNewlines")
@allow_quoted_newlines.setter
def allow_quoted_newlines(self, value):
self._properties["allowQuotedNewlines"] = value
@property
def encoding(self):
"""str: The character encoding of the data.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.encoding
"""
return self._properties.get("encoding")
@encoding.setter
def encoding(self, value):
self._properties["encoding"] = value
@property
def preserve_ascii_control_characters(self):
"""bool: Indicates if the embedded ASCII control characters
(the first 32 characters in the ASCII-table, from '\x00' to '\x1F') are preserved.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.preserve_ascii_control_characters
"""
return self._properties.get("preserveAsciiControlCharacters")
@preserve_ascii_control_characters.setter
def preserve_ascii_control_characters(self, value):
self._properties["preserveAsciiControlCharacters"] = value
@property
def field_delimiter(self):
"""str: The separator for fields in a CSV file. Defaults to comma (',').
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.field_delimiter
"""
return self._properties.get("fieldDelimiter")
@field_delimiter.setter
def field_delimiter(self, value):
self._properties["fieldDelimiter"] = value
@property
def quote_character(self):
"""str: The value that is used to quote data sections in a CSV file.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.quote
"""
return self._properties.get("quote")
@quote_character.setter
def quote_character(self, value):
self._properties["quote"] = value
@property
def skip_leading_rows(self):
"""int: The number of rows at the top of a CSV file.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.skip_leading_rows
"""
return _int_or_none(self._properties.get("skipLeadingRows"))
@skip_leading_rows.setter
def skip_leading_rows(self, value):
self._properties["skipLeadingRows"] = str(value)
@property
def source_column_match(self) -> Optional[SourceColumnMatch]:
"""Optional[google.cloud.bigquery.enums.SourceColumnMatch]: Controls the
strategy used to match loaded columns to the schema. If not set, a sensible
default is chosen based on how the schema is provided. If autodetect is
used, then columns are matched by name. Otherwise, columns are matched by
position. This is done to keep the behavior backward-compatible.
Acceptable values are:
SOURCE_COLUMN_MATCH_UNSPECIFIED: Unspecified column name match option.
POSITION: matches by position. This assumes that the columns are ordered
the same way as the schema.
NAME: matches by name. This reads the header row as column names and
reorders columns to match the field names in the schema.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.source_column_match
"""
value = self._properties.get("sourceColumnMatch")
return SourceColumnMatch(value) if value is not None else None
@source_column_match.setter
def source_column_match(self, value: Union[SourceColumnMatch, str, None]):
if value is not None and not isinstance(value, (SourceColumnMatch, str)):
raise TypeError(
"value must be a google.cloud.bigquery.enums.SourceColumnMatch, str, or None"
)
if isinstance(value, SourceColumnMatch):
value = value.value
self._properties["sourceColumnMatch"] = value if value else None
@property
def null_markers(self) -> Optional[Iterable[str]]:
"""Optional[Iterable[str]]: A list of strings represented as SQL NULL values in a CSV file.
.. note::
null_marker and null_markers can't be set at the same time.
If null_marker is set, null_markers has to be not set.
If null_markers is set, null_marker has to be not set.
If both null_marker and null_markers are set at the same time, a user error would be thrown.
Any strings listed in null_markers, including empty string would be interpreted as SQL NULL.
This applies to all column types.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#CsvOptions.FIELDS.null_markers
"""
return self._properties.get("nullMarkers")
@null_markers.setter
def null_markers(self, value: Optional[Iterable[str]]):
self._properties["nullMarkers"] = value
def to_api_repr(self) -> dict:
"""Build an API representation of this object.
Returns:
Dict[str, Any]: A dictionary in the format used by the BigQuery API.
"""
return copy.deepcopy(self._properties)
@classmethod
def from_api_repr(cls, resource: dict) -> "CSVOptions":
"""Factory: construct a :class:`~.external_config.CSVOptions` instance
given its API representation.
Args:
resource (Dict[str, Any]):
Definition of a :class:`~.external_config.CSVOptions`
instance in the same representation as is returned from the
API.
Returns:
CSVOptions: Configuration parsed from ``resource``.
"""
config = cls()
config._properties = copy.deepcopy(resource)
return config
class GoogleSheetsOptions(object):
"""Options that describe how to treat Google Sheets as BigQuery tables."""
_SOURCE_FORMAT = "GOOGLE_SHEETS"
_RESOURCE_NAME = "googleSheetsOptions"
def __init__(self):
self._properties = {}
@property
def skip_leading_rows(self):
"""int: The number of rows at the top of a sheet that BigQuery will
skip when reading the data.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#GoogleSheetsOptions.FIELDS.skip_leading_rows
"""
return _int_or_none(self._properties.get("skipLeadingRows"))
@skip_leading_rows.setter
def skip_leading_rows(self, value):
self._properties["skipLeadingRows"] = str(value)
@property
def range(self):
"""str: The range of a sheet that BigQuery will query from.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#GoogleSheetsOptions.FIELDS.range
"""
return _str_or_none(self._properties.get("range"))
@range.setter
def range(self, value):
self._properties["range"] = value
def to_api_repr(self) -> dict:
"""Build an API representation of this object.
Returns:
Dict[str, Any]: A dictionary in the format used by the BigQuery API.
"""
return copy.deepcopy(self._properties)
@classmethod
def from_api_repr(cls, resource: dict) -> "GoogleSheetsOptions":
"""Factory: construct a :class:`~.external_config.GoogleSheetsOptions`
instance given its API representation.
Args:
resource (Dict[str, Any]):
Definition of a :class:`~.external_config.GoogleSheetsOptions`
instance in the same representation as is returned from the
API.
Returns:
GoogleSheetsOptions: Configuration parsed from ``resource``.
"""
config = cls()
config._properties = copy.deepcopy(resource)
return config
_OPTION_CLASSES = (
AvroOptions,
BigtableOptions,
CSVOptions,
GoogleSheetsOptions,
ParquetOptions,
)
OptionsType = Union[
AvroOptions,
BigtableOptions,
CSVOptions,
GoogleSheetsOptions,
ParquetOptions,
]
class HivePartitioningOptions(object):
"""Options that configure hive partitioning.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#HivePartitioningOptions
"""
def __init__(self) -> None:
self._properties: Dict[str, Any] = {}
@property
def mode(self):
"""Optional[str]: When set, what mode of hive partitioning to use when reading data.
Two modes are supported: "AUTO" and "STRINGS".
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#HivePartitioningOptions.FIELDS.mode
"""
return self._properties.get("mode")
@mode.setter
def mode(self, value):
self._properties["mode"] = value
@property
def source_uri_prefix(self):
"""Optional[str]: When hive partition detection is requested, a common prefix for
all source URIs is required.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#HivePartitioningOptions.FIELDS.source_uri_prefix
"""
return self._properties.get("sourceUriPrefix")
@source_uri_prefix.setter
def source_uri_prefix(self, value):
self._properties["sourceUriPrefix"] = value
@property
def require_partition_filter(self):
"""Optional[bool]: If set to true, queries over the partitioned table require a
partition filter that can be used for partition elimination to be
specified.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#HivePartitioningOptions.FIELDS.mode
"""
return self._properties.get("requirePartitionFilter")
@require_partition_filter.setter
def require_partition_filter(self, value):
self._properties["requirePartitionFilter"] = value
def to_api_repr(self) -> dict:
"""Build an API representation of this object.
Returns:
Dict[str, Any]: A dictionary in the format used by the BigQuery API.
"""
return copy.deepcopy(self._properties)
@classmethod
def from_api_repr(cls, resource: dict) -> "HivePartitioningOptions":
"""Factory: construct a :class:`~.external_config.HivePartitioningOptions`
instance given its API representation.
Args:
resource (Dict[str, Any]):
Definition of a :class:`~.external_config.HivePartitioningOptions`
instance in the same representation as is returned from the
API.
Returns:
HivePartitioningOptions: Configuration parsed from ``resource``.
"""
config = cls()
config._properties = copy.deepcopy(resource)
return config
class ExternalConfig(object):
"""Description of an external data source.
Args:
source_format (ExternalSourceFormat):
See :attr:`source_format`.
"""
def __init__(self, source_format) -> None:
self._properties = {"sourceFormat": source_format}
@property
def source_format(self):
""":class:`~.external_config.ExternalSourceFormat`:
Format of external source.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.source_format
"""
return self._properties["sourceFormat"]
@property
def options(self) -> Optional[OptionsType]:
"""Source-specific options."""
for optcls in _OPTION_CLASSES:
# The code below is too much magic for mypy to handle.
if self.source_format == optcls._SOURCE_FORMAT: # type: ignore
options: OptionsType = optcls() # type: ignore
options._properties = self._properties.setdefault(
optcls._RESOURCE_NAME, {} # type: ignore
)
return options
# No matching source format found.
return None
@property
def autodetect(self):
"""bool: If :data:`True`, try to detect schema and format options
automatically.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.autodetect
"""
return self._properties.get("autodetect")
@autodetect.setter
def autodetect(self, value):
self._properties["autodetect"] = value
@property
def compression(self):
"""str: The compression type of the data source.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.compression
"""
return self._properties.get("compression")
@compression.setter
def compression(self, value):
self._properties["compression"] = value
@property
def decimal_target_types(self) -> Optional[FrozenSet[str]]:
"""Possible SQL data types to which the source decimal values are converted.
See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.decimal_target_types
.. versionadded:: 2.21.0
"""
prop = self._properties.get("decimalTargetTypes")
if prop is not None:
prop = frozenset(prop)
return prop
@decimal_target_types.setter
def decimal_target_types(self, value: Optional[Iterable[str]]):
if value is not None:
self._properties["decimalTargetTypes"] = list(value)
else:
if "decimalTargetTypes" in self._properties:
del self._properties["decimalTargetTypes"]
@property
def hive_partitioning(self):
"""Optional[:class:`~.external_config.HivePartitioningOptions`]: When set, \
it configures hive partitioning support.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.hive_partitioning_options
"""
prop = self._properties.get("hivePartitioningOptions")
if prop is None:
return None
return HivePartitioningOptions.from_api_repr(prop)
@hive_partitioning.setter
def hive_partitioning(self, value):
prop = value.to_api_repr() if value is not None else None
self._properties["hivePartitioningOptions"] = prop
@property
def reference_file_schema_uri(self):
"""Optional[str]:
When creating an external table, the user can provide a reference file with the
table schema. This is enabled for the following formats:
AVRO, PARQUET, ORC
"""
return self._properties.get("referenceFileSchemaUri")
@reference_file_schema_uri.setter
def reference_file_schema_uri(self, value):
self._properties["referenceFileSchemaUri"] = value
@property
def ignore_unknown_values(self):
"""bool: If :data:`True`, extra values that are not represented in the
table schema are ignored. Defaults to :data:`False`.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.ignore_unknown_values
"""
return self._properties.get("ignoreUnknownValues")
@ignore_unknown_values.setter
def ignore_unknown_values(self, value):
self._properties["ignoreUnknownValues"] = value
@property
def max_bad_records(self):
"""int: The maximum number of bad records that BigQuery can ignore when
reading data.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.max_bad_records
"""
return self._properties.get("maxBadRecords")
@max_bad_records.setter
def max_bad_records(self, value):
self._properties["maxBadRecords"] = value
@property
def source_uris(self):
"""List[str]: URIs that point to your data in Google Cloud.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.source_uris
"""
return self._properties.get("sourceUris", [])
@source_uris.setter
def source_uris(self, value):
self._properties["sourceUris"] = value
@property
def schema(self):
"""List[:class:`~google.cloud.bigquery.schema.SchemaField`]: The schema
for the data.
See
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.schema
"""
prop: Dict[str, Any] = typing.cast(
Dict[str, Any], self._properties.get("schema", {})
)
return [SchemaField.from_api_repr(field) for field in prop.get("fields", [])]
@schema.setter
def schema(self, value):
prop = value
if value is not None:
prop = {"fields": [field.to_api_repr() for field in value]}
self._properties["schema"] = prop
@property
def date_format(self) -> Optional[str]:
"""Optional[str]: Format used to parse DATE values. Supports C-style and SQL-style values.
See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.date_format
"""
result = self._properties.get("dateFormat")
return typing.cast(str, result)
@date_format.setter
def date_format(self, value: Optional[str]):
self._properties["dateFormat"] = value
@property
def datetime_format(self) -> Optional[str]:
"""Optional[str]: Format used to parse DATETIME values. Supports C-style
and SQL-style values.
See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.datetime_format
"""
result = self._properties.get("datetimeFormat")
return typing.cast(str, result)
@datetime_format.setter
def datetime_format(self, value: Optional[str]):
self._properties["datetimeFormat"] = value
@property
def time_zone(self) -> Optional[str]:
"""Optional[str]: Time zone used when parsing timestamp values that do not
have specific time zone information (e.g. 2024-04-20 12:34:56). The expected
format is an IANA timezone string (e.g. America/Los_Angeles).
See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.time_zone
"""
result = self._properties.get("timeZone")
return typing.cast(str, result)
@time_zone.setter
def time_zone(self, value: Optional[str]):
self._properties["timeZone"] = value
@property
def time_format(self) -> Optional[str]:
"""Optional[str]: Format used to parse TIME values. Supports C-style and SQL-style values.
See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.time_format
"""
result = self._properties.get("timeFormat")
return typing.cast(str, result)
@time_format.setter
def time_format(self, value: Optional[str]):
self._properties["timeFormat"] = value
@property
def timestamp_format(self) -> Optional[str]:
"""Optional[str]: Format used to parse TIMESTAMP values. Supports C-style and SQL-style values.
See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.timestamp_format
"""
result = self._properties.get("timestampFormat")
return typing.cast(str, result)
@timestamp_format.setter
def timestamp_format(self, value: Optional[str]):
self._properties["timestampFormat"] = value
@property
def connection_id(self):
"""Optional[str]: ID of a BigQuery Connection API
resource.
"""
return self._properties.get("connectionId")
@connection_id.setter
def connection_id(self, value):
self._properties["connectionId"] = value
@property
def avro_options(self) -> Optional[AvroOptions]:
"""Additional properties to set if ``sourceFormat`` is set to AVRO.
See:
https://cloud.google.com/bigquery/docs/reference/rest/v2/tables#ExternalDataConfiguration.FIELDS.avro_options
"""
if self.source_format == ExternalSourceFormat.AVRO:
self._properties.setdefault(AvroOptions._RESOURCE_NAME, {})
resource = self._properties.get(AvroOptions._RESOURCE_NAME)
if resource is None:
return None
options = AvroOptions()
options._properties = resource
return options
@avro_options.setter
def avro_options(self, value):