forked from hashicorp/terraform-provider-google
/
resource_big_query_job.go
2826 lines (2521 loc) · 111 KB
/
resource_big_query_job.go
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
// ----------------------------------------------------------------------------
//
// *** AUTO GENERATED CODE *** AUTO GENERATED CODE ***
//
// ----------------------------------------------------------------------------
//
// This file is automatically generated by Magic Modules and manual
// changes will be clobbered when the file is regenerated.
//
// Please read more about how to change this file in
// .github/CONTRIBUTING.md.
//
// ----------------------------------------------------------------------------
package google
import (
"fmt"
"log"
"reflect"
"regexp"
"strconv"
"time"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
"github.com/hashicorp/terraform-plugin-sdk/v2/helper/validation"
"google.golang.org/api/googleapi"
)
var (
bigqueryDatasetRegexp = regexp.MustCompile("projects/(.+)/datasets/(.+)")
bigqueryTableRegexp = regexp.MustCompile("projects/(.+)/datasets/(.+)/tables/(.+)")
)
func resourceBigQueryJob() *schema.Resource {
return &schema.Resource{
Create: resourceBigQueryJobCreate,
Read: resourceBigQueryJobRead,
Delete: resourceBigQueryJobDelete,
Importer: &schema.ResourceImporter{
State: resourceBigQueryJobImport,
},
Timeouts: &schema.ResourceTimeout{
Create: schema.DefaultTimeout(4 * time.Minute),
Delete: schema.DefaultTimeout(4 * time.Minute),
},
Schema: map[string]*schema.Schema{
"copy": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Copies a table.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"source_tables": {
Type: schema.TypeList,
Required: true,
ForceNew: true,
Description: `Source tables to copy.`,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"table_id": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
DiffSuppressFunc: compareSelfLinkRelativePaths,
Description: `The table. Can be specified '{{table_id}}' if 'project_id' and 'dataset_id' are also set,
or of the form 'projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}' if not.`,
},
"dataset_id": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The ID of the dataset containing this table.`,
},
"project_id": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The ID of the project containing this table.`,
},
},
},
},
"create_disposition": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
ValidateFunc: validation.StringInSlice([]string{"CREATE_IF_NEEDED", "CREATE_NEVER", ""}, false),
Description: `Specifies whether the job is allowed to create new tables. The following values are supported:
CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table.
CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result.
Creation, truncation and append actions occur as one atomic update upon job completion Default value: "CREATE_IF_NEEDED" Possible values: ["CREATE_IF_NEEDED", "CREATE_NEVER"]`,
Default: "CREATE_IF_NEEDED",
},
"destination_encryption_configuration": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Custom encryption configuration (e.g., Cloud KMS keys)`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"kms_key_name": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
Description: `Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table.
The BigQuery Service Account associated with your project requires access to this encryption key.`,
},
},
},
},
"destination_table": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `The destination table.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"table_id": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
DiffSuppressFunc: compareSelfLinkRelativePaths,
Description: `The table. Can be specified '{{table_id}}' if 'project_id' and 'dataset_id' are also set,
or of the form 'projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}' if not.`,
},
"dataset_id": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The ID of the dataset containing this table.`,
},
"project_id": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The ID of the project containing this table.`,
},
},
},
},
"write_disposition": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
ValidateFunc: validation.StringInSlice([]string{"WRITE_TRUNCATE", "WRITE_APPEND", "WRITE_EMPTY", ""}, false),
Description: `Specifies the action that occurs if the destination table already exists. The following values are supported:
WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result.
WRITE_APPEND: If the table already exists, BigQuery appends the data to the table.
WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result.
Each action is atomic and only occurs if BigQuery is able to complete the job successfully.
Creation, truncation and append actions occur as one atomic update upon job completion. Default value: "WRITE_EMPTY" Possible values: ["WRITE_TRUNCATE", "WRITE_APPEND", "WRITE_EMPTY"]`,
Default: "WRITE_EMPTY",
},
},
},
ExactlyOneOf: []string{},
},
"extract": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Configures an extract job.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"destination_uris": {
Type: schema.TypeList,
Required: true,
ForceNew: true,
Description: `A list of fully-qualified Google Cloud Storage URIs where the extracted table should be written.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"compression": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `The compression type to use for exported files. Possible values include GZIP, DEFLATE, SNAPPY, and NONE.
The default value is NONE. DEFLATE and SNAPPY are only supported for Avro.`,
Default: "NONE",
},
"destination_format": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The exported file format. Possible values include CSV, NEWLINE_DELIMITED_JSON and AVRO for tables and SAVED_MODEL for models.
The default value for tables is CSV. Tables with nested or repeated fields cannot be exported as CSV.
The default value for models is SAVED_MODEL.`,
},
"field_delimiter": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `When extracting data in CSV format, this defines the delimiter to use between fields in the exported data.
Default is ','`,
},
"print_header": {
Type: schema.TypeBool,
Optional: true,
ForceNew: true,
Description: `Whether to print out a header row in the results. Default is true.`,
Default: true,
},
"source_model": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `A reference to the model being exported.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"dataset_id": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
Description: `The ID of the dataset containing this model.`,
},
"model_id": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
Description: `The ID of the model.`,
},
"project_id": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
Description: `The ID of the project containing this model.`,
},
},
},
ExactlyOneOf: []string{},
},
"source_table": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `A reference to the table being exported.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"table_id": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
DiffSuppressFunc: compareSelfLinkRelativePaths,
Description: `The table. Can be specified '{{table_id}}' if 'project_id' and 'dataset_id' are also set,
or of the form 'projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}' if not.`,
},
"dataset_id": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The ID of the dataset containing this table.`,
},
"project_id": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The ID of the project containing this table.`,
},
},
},
ExactlyOneOf: []string{},
},
"use_avro_logical_types": {
Type: schema.TypeBool,
Optional: true,
ForceNew: true,
Description: `Whether to use logical types when extracting to AVRO format.`,
},
},
},
ExactlyOneOf: []string{},
},
"job_timeout_ms": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `Job timeout in milliseconds. If this time limit is exceeded, BigQuery may attempt to terminate the job.`,
},
"labels": {
Type: schema.TypeMap,
Optional: true,
ForceNew: true,
Description: `The labels associated with this job. You can use these to organize and group your jobs.`,
Elem: &schema.Schema{Type: schema.TypeString},
},
"load": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Configures a load job.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"destination_table": {
Type: schema.TypeList,
Required: true,
ForceNew: true,
Description: `The destination table to load the data into.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"table_id": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
DiffSuppressFunc: compareSelfLinkRelativePaths,
Description: `The table. Can be specified '{{table_id}}' if 'project_id' and 'dataset_id' are also set,
or of the form 'projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}' if not.`,
},
"dataset_id": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The ID of the dataset containing this table.`,
},
"project_id": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The ID of the project containing this table.`,
},
},
},
},
"source_uris": {
Type: schema.TypeList,
Required: true,
ForceNew: true,
Description: `The fully-qualified URIs that point to your data in Google Cloud.
For Google Cloud Storage URIs: Each URI can contain one '*' wildcard character
and it must come after the 'bucket' name. Size limits related to load jobs apply
to external data sources. For Google Cloud Bigtable URIs: Exactly one URI can be
specified and it has be a fully specified and valid HTTPS URL for a Google Cloud Bigtable table.
For Google Cloud Datastore backups: Exactly one URI can be specified. Also, the '*' wildcard character is not allowed.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"allow_jagged_rows": {
Type: schema.TypeBool,
Optional: true,
ForceNew: true,
Description: `Accept rows that are missing trailing optional columns. The missing values are treated as nulls.
If false, records with missing trailing columns are treated as bad records, and if there are too many bad records,
an invalid error is returned in the job result. The default value is false. Only applicable to CSV, ignored for other formats.`,
Default: false,
},
"allow_quoted_newlines": {
Type: schema.TypeBool,
Optional: true,
ForceNew: true,
Description: `Indicates if BigQuery should allow quoted data sections that contain newline characters in a CSV file.
The default value is false.`,
Default: false,
},
"autodetect": {
Type: schema.TypeBool,
Optional: true,
ForceNew: true,
Description: `Indicates if we should automatically infer the options and schema for CSV and JSON sources.`,
},
"create_disposition": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
ValidateFunc: validation.StringInSlice([]string{"CREATE_IF_NEEDED", "CREATE_NEVER", ""}, false),
Description: `Specifies whether the job is allowed to create new tables. The following values are supported:
CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table.
CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result.
Creation, truncation and append actions occur as one atomic update upon job completion Default value: "CREATE_IF_NEEDED" Possible values: ["CREATE_IF_NEEDED", "CREATE_NEVER"]`,
Default: "CREATE_IF_NEEDED",
},
"destination_encryption_configuration": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Custom encryption configuration (e.g., Cloud KMS keys)`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"kms_key_name": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
Description: `Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table.
The BigQuery Service Account associated with your project requires access to this encryption key.`,
},
},
},
},
"encoding": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `The character encoding of the data. The supported values are UTF-8 or ISO-8859-1.
The default value is UTF-8. BigQuery decodes the data after the raw, binary data
has been split using the values of the quote and fieldDelimiter properties.`,
Default: "UTF-8",
},
"field_delimiter": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The separator for fields in a CSV file. The separator can be any ISO-8859-1 single-byte character.
To use a character in the range 128-255, you must encode the character as UTF8. BigQuery converts
the string to ISO-8859-1 encoding, and then uses the first byte of the encoded string to split the
data in its raw, binary state. BigQuery also supports the escape sequence "\t" to specify a tab separator.
The default value is a comma (',').`,
},
"ignore_unknown_values": {
Type: schema.TypeBool,
Optional: true,
ForceNew: true,
Description: `Indicates if BigQuery should allow extra values that are not represented in the table schema.
If true, the extra values are ignored. If false, records with extra columns are treated as bad records,
and if there are too many bad records, an invalid error is returned in the job result.
The default value is false. The sourceFormat property determines what BigQuery treats as an extra value:
CSV: Trailing columns
JSON: Named values that don't match any column names`,
Default: false,
},
"max_bad_records": {
Type: schema.TypeInt,
Optional: true,
ForceNew: true,
Description: `The maximum number of bad records that BigQuery can ignore when running the job. If the number of bad records exceeds this value,
an invalid error is returned in the job result. The default value is 0, which requires that all records are valid.`,
Default: 0,
},
"null_marker": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `Specifies a string that represents a null value in a CSV file. For example, if you specify "\N", BigQuery interprets "\N" as a null value
when loading a CSV file. The default value is the empty string. If you set this property to a custom value, BigQuery throws an error if an
empty string is present for all data types except for STRING and BYTE. For STRING and BYTE columns, BigQuery interprets the empty string as
an empty value.`,
Default: "",
},
"projection_fields": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `If sourceFormat is set to "DATASTORE_BACKUP", indicates which entity properties to load into BigQuery from a Cloud Datastore backup.
Property names are case sensitive and must be top-level properties. If no properties are specified, BigQuery loads all properties.
If any named property isn't found in the Cloud Datastore backup, an invalid error is returned in the job result.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"quote": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The value that is used to quote data sections in a CSV file. BigQuery converts the string to ISO-8859-1 encoding,
and then uses the first byte of the encoded string to split the data in its raw, binary state.
The default value is a double-quote ('"'). If your data does not contain quoted sections, set the property value to an empty string.
If your data contains quoted newline characters, you must also set the allowQuotedNewlines property to true.`,
},
"schema_update_options": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Allows the schema of the destination table to be updated as a side effect of the load job if a schema is autodetected or
supplied in the job configuration. Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND;
when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table, specified by partition decorators.
For normal tables, WRITE_TRUNCATE will always overwrite the schema. One or more of the following values are specified:
ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema.
ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"skip_leading_rows": {
Type: schema.TypeInt,
Optional: true,
ForceNew: true,
ValidateFunc: validation.IntAtLeast(0),
Description: `The number of rows at the top of a CSV file that BigQuery will skip when loading the data.
The default value is 0. This property is useful if you have header rows in the file that should be skipped.
When autodetect is on, the behavior is the following:
skipLeadingRows unspecified - Autodetect tries to detect headers in the first row. If they are not detected,
the row is read as data. Otherwise data is read starting from the second row.
skipLeadingRows is 0 - Instructs autodetect that there are no headers and data should be read starting from the first row.
skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row N. If headers are not detected,
row N is just skipped. Otherwise row N is used to extract column names for the detected schema.`,
Default: 0,
},
"source_format": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `The format of the data files. For CSV files, specify "CSV". For datastore backups, specify "DATASTORE_BACKUP".
For newline-delimited JSON, specify "NEWLINE_DELIMITED_JSON". For Avro, specify "AVRO". For parquet, specify "PARQUET".
For orc, specify "ORC". The default value is CSV.`,
Default: "CSV",
},
"time_partitioning": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Time-based partitioning specification for the destination table.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"type": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
Description: `The only type supported is DAY, which will generate one partition per day. Providing an empty string used to cause an error,
but in OnePlatform the field will be treated as unset.`,
},
"expiration_ms": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value.`,
},
"field": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field.
The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED.
A wrapper is used here because an empty string is an invalid value.`,
},
},
},
},
"write_disposition": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
ValidateFunc: validation.StringInSlice([]string{"WRITE_TRUNCATE", "WRITE_APPEND", "WRITE_EMPTY", ""}, false),
Description: `Specifies the action that occurs if the destination table already exists. The following values are supported:
WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result.
WRITE_APPEND: If the table already exists, BigQuery appends the data to the table.
WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result.
Each action is atomic and only occurs if BigQuery is able to complete the job successfully.
Creation, truncation and append actions occur as one atomic update upon job completion. Default value: "WRITE_EMPTY" Possible values: ["WRITE_TRUNCATE", "WRITE_APPEND", "WRITE_EMPTY"]`,
Default: "WRITE_EMPTY",
},
},
},
ExactlyOneOf: []string{},
},
"query": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Configures a query job.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"query": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
Description: `SQL query text to execute. The useLegacySql field can be used to indicate whether the query uses legacy SQL or standard SQL.
*NOTE*: queries containing [DML language](https://cloud.google.com/bigquery/docs/reference/standard-sql/data-manipulation-language)
('DELETE', 'UPDATE', 'MERGE', 'INSERT') must specify 'create_disposition = ""' and 'write_disposition = ""'.`,
},
"allow_large_results": {
Type: schema.TypeBool,
Optional: true,
ForceNew: true,
Description: `If true and query uses legacy SQL dialect, allows the query to produce arbitrarily large result tables at a slight cost in performance.
Requires destinationTable to be set. For standard SQL queries, this flag is ignored and large results are always allowed.
However, you must still set destinationTable when result size exceeds the allowed maximum response size.`,
},
"create_disposition": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
ValidateFunc: validation.StringInSlice([]string{"CREATE_IF_NEEDED", "CREATE_NEVER", ""}, false),
Description: `Specifies whether the job is allowed to create new tables. The following values are supported:
CREATE_IF_NEEDED: If the table does not exist, BigQuery creates the table.
CREATE_NEVER: The table must already exist. If it does not, a 'notFound' error is returned in the job result.
Creation, truncation and append actions occur as one atomic update upon job completion Default value: "CREATE_IF_NEEDED" Possible values: ["CREATE_IF_NEEDED", "CREATE_NEVER"]`,
Default: "CREATE_IF_NEEDED",
},
"default_dataset": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Specifies the default dataset to use for unqualified table names in the query. Note that this does not alter behavior of unqualified dataset names.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"dataset_id": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
DiffSuppressFunc: compareSelfLinkRelativePaths,
Description: `The dataset. Can be specified '{{dataset_id}}' if 'project_id' is also set,
or of the form 'projects/{{project}}/datasets/{{dataset_id}}' if not.`,
},
"project_id": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The ID of the project containing this table.`,
},
},
},
},
"destination_encryption_configuration": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Custom encryption configuration (e.g., Cloud KMS keys)`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"kms_key_name": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
Description: `Describes the Cloud KMS encryption key that will be used to protect destination BigQuery table.
The BigQuery Service Account associated with your project requires access to this encryption key.`,
},
},
},
},
"destination_table": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Describes the table where the query results should be stored.
This property must be set for large results that exceed the maximum response size.
For queries that produce anonymous (cached) results, this field will be populated by BigQuery.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"table_id": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
DiffSuppressFunc: compareSelfLinkRelativePaths,
Description: `The table. Can be specified '{{table_id}}' if 'project_id' and 'dataset_id' are also set,
or of the form 'projects/{{project}}/datasets/{{dataset_id}}/tables/{{table_id}}' if not.`,
},
"dataset_id": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The ID of the dataset containing this table.`,
},
"project_id": {
Type: schema.TypeString,
Computed: true,
Optional: true,
ForceNew: true,
Description: `The ID of the project containing this table.`,
},
},
},
},
"flatten_results": {
Type: schema.TypeBool,
Optional: true,
ForceNew: true,
Description: `If true and query uses legacy SQL dialect, flattens all nested and repeated fields in the query results.
allowLargeResults must be true if this is set to false. For standard SQL queries, this flag is ignored and results are never flattened.`,
},
"maximum_billing_tier": {
Type: schema.TypeInt,
Optional: true,
ForceNew: true,
Description: `Limits the billing tier for this job. Queries that have resource usage beyond this tier will fail (without incurring a charge).
If unspecified, this will be set to your project default.`,
},
"maximum_bytes_billed": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `Limits the bytes billed for this job. Queries that will have bytes billed beyond this limit will fail (without incurring a charge).
If unspecified, this will be set to your project default.`,
},
"parameter_mode": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `Standard SQL only. Set to POSITIONAL to use positional (?) query parameters or to NAMED to use named (@myparam) query parameters in this query.`,
},
"priority": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
ValidateFunc: validation.StringInSlice([]string{"INTERACTIVE", "BATCH", ""}, false),
Description: `Specifies a priority for the query. Default value: "INTERACTIVE" Possible values: ["INTERACTIVE", "BATCH"]`,
Default: "INTERACTIVE",
},
"schema_update_options": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Allows the schema of the destination table to be updated as a side effect of the query job.
Schema update options are supported in two cases: when writeDisposition is WRITE_APPEND;
when writeDisposition is WRITE_TRUNCATE and the destination table is a partition of a table,
specified by partition decorators. For normal tables, WRITE_TRUNCATE will always overwrite the schema.
One or more of the following values are specified:
ALLOW_FIELD_ADDITION: allow adding a nullable field to the schema.
ALLOW_FIELD_RELAXATION: allow relaxing a required field in the original schema to nullable.`,
Elem: &schema.Schema{
Type: schema.TypeString,
},
},
"script_options": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Options controlling the execution of scripts.`,
MaxItems: 1,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"key_result_statement": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
ValidateFunc: validation.StringInSlice([]string{"LAST", "FIRST_SELECT", ""}, false),
Description: `Determines which statement in the script represents the "key result",
used to populate the schema and query results of the script job. Possible values: ["LAST", "FIRST_SELECT"]`,
AtLeastOneOf: []string{},
},
"statement_byte_budget": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `Limit on the number of bytes billed per statement. Exceeding this budget results in an error.`,
AtLeastOneOf: []string{},
},
"statement_timeout_ms": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `Timeout period for each statement in a script.`,
AtLeastOneOf: []string{},
},
},
},
},
"use_legacy_sql": {
Type: schema.TypeBool,
Optional: true,
ForceNew: true,
Description: `Specifies whether to use BigQuery's legacy SQL dialect for this query. The default value is true.
If set to false, the query will use BigQuery's standard SQL.`,
},
"use_query_cache": {
Type: schema.TypeBool,
Optional: true,
ForceNew: true,
Description: `Whether to look for the result in the query cache. The query cache is a best-effort cache that will be flushed whenever
tables in the query are modified. Moreover, the query cache is only available when a query does not have a destination table specified.
The default value is true.`,
Default: true,
},
"user_defined_function_resources": {
Type: schema.TypeList,
Optional: true,
ForceNew: true,
Description: `Describes user-defined function resources used in the query.`,
Elem: &schema.Resource{
Schema: map[string]*schema.Schema{
"inline_code": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `An inline resource that contains code for a user-defined function (UDF).
Providing a inline code resource is equivalent to providing a URI for a file containing the same code.`,
},
"resource_uri": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `A code resource to load from a Google Cloud Storage URI (gs://bucket/path).`,
},
},
},
},
"write_disposition": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
ValidateFunc: validation.StringInSlice([]string{"WRITE_TRUNCATE", "WRITE_APPEND", "WRITE_EMPTY", ""}, false),
Description: `Specifies the action that occurs if the destination table already exists. The following values are supported:
WRITE_TRUNCATE: If the table already exists, BigQuery overwrites the table data and uses the schema from the query result.
WRITE_APPEND: If the table already exists, BigQuery appends the data to the table.
WRITE_EMPTY: If the table already exists and contains data, a 'duplicate' error is returned in the job result.
Each action is atomic and only occurs if BigQuery is able to complete the job successfully.
Creation, truncation and append actions occur as one atomic update upon job completion. Default value: "WRITE_EMPTY" Possible values: ["WRITE_TRUNCATE", "WRITE_APPEND", "WRITE_EMPTY"]`,
Default: "WRITE_EMPTY",
},
},
},
ExactlyOneOf: []string{},
},
"job_type": {
Type: schema.TypeString,
Computed: true,
Description: `The type of the job.`,
},
"job_id": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
Description: `The ID of the job. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or dashes (-). The maximum length is 1,024 characters.`,
},
"location": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
Description: `The geographic location of the job. The default value is US.`,
Default: "US",
},
"user_email": {
Type: schema.TypeString,
Computed: true,
Description: `Email address of the user who ran the job.`,
},
"project": {
Type: schema.TypeString,
Optional: true,
Computed: true,
ForceNew: true,
},
},
UseJSONNumber: true,
}
}
func resourceBigQueryJobCreate(d *schema.ResourceData, meta interface{}) error {
config := meta.(*Config)
userAgent, err := generateUserAgentString(d, config.userAgent)
if err != nil {
return err
}
obj := make(map[string]interface{})
configurationProp, err := expandBigQueryJobConfiguration(nil, d, config)
if err != nil {
return err
} else if !isEmptyValue(reflect.ValueOf(configurationProp)) {
obj["configuration"] = configurationProp
}
jobReferenceProp, err := expandBigQueryJobJobReference(nil, d, config)
if err != nil {
return err
} else if !isEmptyValue(reflect.ValueOf(jobReferenceProp)) {
obj["jobReference"] = jobReferenceProp
}
obj, err = resourceBigQueryJobEncoder(d, meta, obj)
if err != nil {
return err
}
url, err := replaceVars(d, config, "{{BigQueryBasePath}}projects/{{project}}/jobs")
if err != nil {
return err
}
log.Printf("[DEBUG] Creating new Job: %#v", obj)
billingProject := ""
project, err := getProject(d, config)
if err != nil {
return fmt.Errorf("Error fetching project for Job: %s", err)
}
billingProject = project
// err == nil indicates that the billing_project value was found
if bp, err := getBillingProject(d, config); err == nil {
billingProject = bp
}
res, err := sendRequestWithTimeout(config, "POST", billingProject, url, userAgent, obj, d.Timeout(schema.TimeoutCreate))
if err != nil {
return fmt.Errorf("Error creating Job: %s", err)
}
// Store the ID now
id, err := replaceVars(d, config, "projects/{{project}}/jobs/{{job_id}}")
if err != nil {
return fmt.Errorf("Error constructing id: %s", err)
}
d.SetId(id)
err = PollingWaitTime(resourceBigQueryJobPollRead(d, meta), PollCheckForExistence, "Creating Job", d.Timeout(schema.TimeoutCreate), 1)
if err != nil {
return fmt.Errorf("Error waiting to create Job: %s", err)
}
log.Printf("[DEBUG] Finished creating Job %q: %#v", d.Id(), res)
return resourceBigQueryJobRead(d, meta)
}
func resourceBigQueryJobPollRead(d *schema.ResourceData, meta interface{}) PollReadFunc {
return func() (map[string]interface{}, error) {
config := meta.(*Config)
url, err := replaceVars(d, config, "{{BigQueryBasePath}}projects/{{project}}/jobs/{{job_id}}?location={{location}}")
if err != nil {
return nil, err
}
billingProject := ""
project, err := getProject(d, config)
if err != nil {
return nil, fmt.Errorf("Error fetching project for Job: %s", err)
}
billingProject = project
// err == nil indicates that the billing_project value was found
if bp, err := getBillingProject(d, config); err == nil {
billingProject = bp
}
userAgent, err := generateUserAgentString(d, config.userAgent)
if err != nil {
return nil, err
}
res, err := sendRequest(config, "GET", billingProject, url, userAgent, nil)
if err != nil {
return res, err
}
return res, nil
}
}
func resourceBigQueryJobRead(d *schema.ResourceData, meta interface{}) error {
config := meta.(*Config)
userAgent, err := generateUserAgentString(d, config.userAgent)
if err != nil {
return err
}
url, err := replaceVars(d, config, "{{BigQueryBasePath}}projects/{{project}}/jobs/{{job_id}}?location={{location}}")
if err != nil {
return err
}
billingProject := ""
project, err := getProject(d, config)
if err != nil {
return fmt.Errorf("Error fetching project for Job: %s", err)
}
billingProject = project
// err == nil indicates that the billing_project value was found
if bp, err := getBillingProject(d, config); err == nil {
billingProject = bp
}
res, err := sendRequest(config, "GET", billingProject, url, userAgent, nil)
if err != nil {
return handleNotFoundError(err, d, fmt.Sprintf("BigQueryJob %q", d.Id()))
}
if err := d.Set("project", project); err != nil {
return fmt.Errorf("Error reading Job: %s", err)
}
if err := d.Set("user_email", flattenBigQueryJobUserEmail(res["user_email"], d, config)); err != nil {
return fmt.Errorf("Error reading Job: %s", err)
}
// Terraform must set the top level schema field, but since this object contains collapsed properties