forked from airbytehq/airbyte
-
Notifications
You must be signed in to change notification settings - Fork 0
/
destination_specs.yaml
7854 lines (7854 loc) · 283 KB
/
destination_specs.yaml
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
# This file is generated by io.airbyte.configoss.specs.SeedConnectorSpecGenerator.
# Do NOT edit this file directly. See generator class for more details.
---
- dockerImage: "airbyte/destination-azure-blob-storage:0.2.0"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/destinations/azureblobstorage"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "AzureBlobStorage Destination Spec"
type: "object"
required:
- "azure_blob_storage_account_name"
- "azure_blob_storage_account_key"
- "format"
additionalProperties: false
properties:
azure_blob_storage_endpoint_domain_name:
title: "Endpoint Domain Name"
type: "string"
default: "blob.core.windows.net"
description: "This is Azure Blob Storage endpoint domain name. Leave default\
\ value (or leave it empty if run container from command line) to use\
\ Microsoft native from example."
examples:
- "blob.core.windows.net"
azure_blob_storage_container_name:
title: "Azure blob storage container (Bucket) Name"
type: "string"
description: "The name of the Azure blob storage container. If not exists\
\ - will be created automatically. May be empty, then will be created\
\ automatically airbytecontainer+timestamp"
examples:
- "airbytetescontainername"
azure_blob_storage_account_name:
title: "Azure Blob Storage account name"
type: "string"
description: "The account's name of the Azure Blob Storage."
examples:
- "airbyte5storage"
azure_blob_storage_account_key:
title: "Azure Blob Storage account key"
description: "The Azure blob storage account key."
airbyte_secret: true
type: "string"
examples:
- "Z8ZkZpteggFx394vm+PJHnGTvdRncaYS+JhLKdj789YNmD+iyGTnG+PV+POiuYNhBg/ACS+LKjd%4FG3FHGN12Nd=="
azure_blob_storage_output_buffer_size:
title: "Azure Blob Storage output buffer size (Megabytes)"
type: "integer"
description: "The amount of megabytes to buffer for the output stream to\
\ Azure. This will impact memory footprint on workers, but may need adjustment\
\ for performance and appropriate block size in Azure."
minimum: 1
maximum: 2047
default: 5
examples:
- 5
azure_blob_storage_spill_size:
title: "Azure Blob Storage file spill size"
type: "integer"
description: "The amount of megabytes after which the connector should spill\
\ the records in a new blob object. Make sure to configure size greater\
\ than individual records. Enter 0 if not applicable"
default: 500
examples:
- 500
format:
title: "Output Format"
type: "object"
description: "Output data format"
oneOf:
- title: "CSV: Comma-Separated Values"
required:
- "format_type"
- "flattening"
properties:
format_type:
type: "string"
const: "CSV"
flattening:
type: "string"
title: "Normalization (Flattening)"
description: "Whether the input json data should be normalized (flattened)\
\ in the output CSV. Please refer to docs for details."
default: "No flattening"
enum:
- "No flattening"
- "Root level flattening"
- title: "JSON Lines: newline-delimited JSON"
required:
- "format_type"
properties:
format_type:
type: "string"
const: "JSONL"
supportsIncremental: true
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes:
- "overwrite"
- "append"
- dockerImage: "airbyte/destination-amazon-sqs:0.1.0"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/destinations/amazon-sqs"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Destination Amazon Sqs"
type: "object"
required:
- "queue_url"
- "region"
additionalProperties: false
properties:
queue_url:
title: "Queue URL"
description: "URL of the SQS Queue"
type: "string"
examples:
- "https://sqs.eu-west-1.amazonaws.com/1234567890/my-example-queue"
order: 0
region:
title: "AWS Region"
description: "AWS Region of the SQS Queue"
type: "string"
enum:
- "us-east-1"
- "us-east-2"
- "us-west-1"
- "us-west-2"
- "af-south-1"
- "ap-east-1"
- "ap-south-1"
- "ap-northeast-1"
- "ap-northeast-2"
- "ap-northeast-3"
- "ap-southeast-1"
- "ap-southeast-2"
- "ca-central-1"
- "cn-north-1"
- "cn-northwest-1"
- "eu-central-1"
- "eu-north-1"
- "eu-south-1"
- "eu-west-1"
- "eu-west-2"
- "eu-west-3"
- "sa-east-1"
- "me-south-1"
- "us-gov-east-1"
- "us-gov-west-1"
order: 1
message_delay:
title: "Message Delay"
description: "Modify the Message Delay of the individual message from the\
\ Queue's default (seconds)."
type: "integer"
examples:
- "15"
order: 2
access_key:
title: "AWS IAM Access Key ID"
description: "The Access Key ID of the AWS IAM Role to use for sending \
\ messages"
type: "string"
examples:
- "xxxxxHRNxxx3TBxxxxxx"
order: 3
airbyte_secret: true
secret_key:
title: "AWS IAM Secret Key"
description: "The Secret Key of the AWS IAM Role to use for sending messages"
type: "string"
examples:
- "hu+qE5exxxxT6o/ZrKsxxxxxxBhxxXLexxxxxVKz"
order: 4
airbyte_secret: true
message_body_key:
title: "Message Body Key"
description: "Use this property to extract the contents of the named key\
\ in the input record to use as the SQS message body. If not set, the\
\ entire content of the input record data is used as the message body."
type: "string"
examples:
- "myDataPath"
order: 5
message_group_id:
title: "Message Group Id"
description: "The tag that specifies that a message belongs to a specific\
\ message group. This parameter applies only to, and is REQUIRED by, FIFO\
\ queues."
type: "string"
examples:
- "my-fifo-group"
order: 6
supportsIncremental: true
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes:
- "append"
- dockerImage: "airbyte/destination-doris:0.1.0"
spec:
documentationUrl: "https://docs.airbyte.io/integrations/destinations/doris"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Doris Destination Spec"
type: "object"
required:
- "host"
- "httpport"
- "queryport"
- "username"
- "database"
properties:
host:
title: "Host"
description: "Hostname of the database"
type: "string"
order: 0
httpport:
title: "HttpPort"
description: "Http Port of the database."
type: "integer"
minimum: 0
maximum: 65536
default: 8030
examples:
- "8030"
order: 1
queryport:
title: "QueryPort"
description: "Query(SQL) Port of the database."
type: "integer"
minimum: 0
maximum: 65536
default: 9030
examples:
- "9030"
order: 2
database:
title: "DataBase Name"
description: "Name of the database."
type: "string"
order: 3
username:
title: "UserName"
description: "Username to use to access the database."
type: "string"
order: 4
password:
title: "Password"
description: "Password associated with the username."
type: "string"
airbyte_secret: true
order: 5
supportsIncremental: false
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes:
- "append"
- "overwrite"
- dockerImage: "airbyte/destination-iceberg:0.1.0"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/destinations/iceberg"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "Iceberg Destination Spec"
type: "object"
required:
- "catalog_config"
- "storage_config"
- "format_config"
properties:
catalog_config:
title: "Iceberg catalog config"
type: "object"
description: "Catalog config of Iceberg."
oneOf:
- title: "HiveCatalog: Use Apache Hive MetaStore"
required:
- "catalog_type"
- "hive_thrift_uri"
properties:
catalog_type:
title: "Catalog Type"
type: "string"
default: "Hive"
enum:
- "Hive"
order: 0
hive_thrift_uri:
title: "Hive Metastore thrift uri"
type: "string"
description: "Hive MetaStore thrift server uri of iceberg catalog."
examples:
- "host:port"
order: 1
database:
title: "Default database"
description: "The default database tables are written to if the source\
\ does not specify a namespace. The usual value for this field is\
\ \"default\"."
type: "string"
default: "default"
examples:
- "default"
order: 2
- title: "HadoopCatalog: Use hierarchical file systems as same as storage\
\ config"
description: "A Hadoop catalog doesn’t need to connect to a Hive MetaStore,\
\ but can only be used with HDFS or similar file systems that support\
\ atomic rename."
required:
- "catalog_type"
properties:
catalog_type:
title: "Catalog Type"
type: "string"
default: "Hadoop"
enum:
- "Hadoop"
order: 0
database:
title: "Default database"
description: "The default database tables are written to if the source\
\ does not specify a namespace. The usual value for this field is\
\ \"default\"."
type: "string"
default: "default"
examples:
- "default"
order: 1
- title: "JdbcCatalog: Use relational database"
description: "Using a table in a relational database to manage Iceberg\
\ tables through JDBC. Read more <a href=\"https://iceberg.apache.org/docs/latest/jdbc/\"\
>here</a>. Supporting: PostgreSQL"
required:
- "catalog_type"
properties:
catalog_type:
title: "Catalog Type"
type: "string"
default: "Jdbc"
enum:
- "Jdbc"
order: 0
database:
title: "Default schema"
description: "The default schema tables are written to if the source\
\ does not specify a namespace. The usual value for this field is\
\ \"public\"."
type: "string"
default: "public"
examples:
- "public"
order: 1
jdbc_url:
title: "Jdbc url"
type: "string"
examples:
- "jdbc:postgresql://{host}:{port}/{database}"
order: 2
username:
title: "User"
description: "Username to use to access the database."
type: "string"
order: 3
password:
title: "Password"
description: "Password associated with the username."
type: "string"
airbyte_secret: true
order: 4
ssl:
title: "SSL Connection"
description: "Encrypt data using SSL. When activating SSL, please\
\ select one of the connection modes."
type: "boolean"
default: false
order: 5
catalog_schema:
title: "schema for Iceberg catalog"
description: "Iceberg catalog metadata tables are written to catalog\
\ schema. The usual value for this field is \"public\"."
type: "string"
default: "public"
examples:
- "public"
order: 6
order: 0
storage_config:
title: "Storage config"
type: "object"
description: "Storage config of Iceberg."
oneOf:
- title: "S3"
type: "object"
description: "S3 object storage"
required:
- "storage_type"
- "access_key_id"
- "secret_access_key"
- "s3_warehouse_uri"
properties:
storage_type:
title: "Storage Type"
type: "string"
default: "S3"
enum:
- "S3"
order: 0
access_key_id:
type: "string"
description: "The access key ID to access the S3 bucket. Airbyte requires\
\ Read and Write permissions to the given bucket. Read more <a href=\"\
https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys\"\
>here</a>."
title: "S3 Key ID"
airbyte_secret: true
examples:
- "A012345678910EXAMPLE"
order: 0
secret_access_key:
type: "string"
description: "The corresponding secret to the access key ID. Read\
\ more <a href=\"https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys\"\
>here</a>"
title: "S3 Access Key"
airbyte_secret: true
examples:
- "a012345678910ABCDEFGH/AbCdEfGhEXAMPLEKEY"
order: 1
s3_warehouse_uri:
title: "S3 Warehouse Uri for Iceberg"
type: "string"
description: "The Warehouse Uri for Iceberg"
examples:
- "s3a://my-bucket/path/to/warehouse"
- "s3://my-bucket/path/to/warehouse"
order: 2
s3_bucket_region:
title: "S3 Bucket Region"
type: "string"
default: ""
description: "The region of the S3 bucket. See <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions\"\
>here</a> for all region codes."
enum:
- ""
- "us-east-1"
- "us-east-2"
- "us-west-1"
- "us-west-2"
- "af-south-1"
- "ap-east-1"
- "ap-south-1"
- "ap-northeast-1"
- "ap-northeast-2"
- "ap-northeast-3"
- "ap-southeast-1"
- "ap-southeast-2"
- "ca-central-1"
- "cn-north-1"
- "cn-northwest-1"
- "eu-central-1"
- "eu-north-1"
- "eu-south-1"
- "eu-west-1"
- "eu-west-2"
- "eu-west-3"
- "sa-east-1"
- "me-south-1"
- "us-gov-east-1"
- "us-gov-west-1"
order: 3
s3_endpoint:
title: "Endpoint"
type: "string"
default: ""
description: "Your S3 endpoint url. Read more <a href=\"https://docs.aws.amazon.com/general/latest/gr/s3.html#:~:text=Service%20endpoints-,Amazon%20S3%20endpoints,-When%20you%20use\"\
>here</a>"
examples:
- "http://localhost:9000"
- "localhost:9000"
order: 4
s3_path_style_access:
type: "boolean"
description: "Use path style access"
examples:
- true
- false
default: true
order: 5
order: 1
format_config:
title: "File format"
type: "object"
required:
- "format"
description: "File format of Iceberg storage."
properties:
format:
title: "File storage format"
type: "string"
default: "Parquet"
description: ""
enum:
- "Parquet"
- "Avro"
order: 0
flush_batch_size:
title: "Data file flushing batch size"
description: "Iceberg data file flush batch size. Incoming rows write\
\ to cache firstly; When cache size reaches this 'batch size', flush\
\ into real Iceberg data file."
type: "integer"
default: 10000
order: 1
auto_compact:
title: "Auto compact data files"
description: "Auto compact data files when stream close"
type: "boolean"
default: false
order: 2
compact_target_file_size_in_mb:
title: "Target size of compacted data file"
description: "Specify the target size of Iceberg data file when performing\
\ a compaction action. "
type: "integer"
default: 100
order: 3
order: 2
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes:
- "overwrite"
- "append"
- dockerImage: "airbyte/destination-aws-datalake:0.1.3"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/destinations/aws-datalake"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "AWS Datalake Destination Spec"
type: "object"
required:
- "credentials"
- "region"
- "bucket_name"
- "lakeformation_database_name"
additionalProperties: false
properties:
aws_account_id:
type: "string"
title: "AWS Account Id"
description: "target aws account id"
examples:
- "111111111111"
order: 1
credentials:
title: "Authentication mode"
description: "Choose How to Authenticate to AWS."
type: "object"
oneOf:
- type: "object"
title: "IAM Role"
required:
- "role_arn"
- "credentials_title"
properties:
credentials_title:
type: "string"
title: "Credentials Title"
description: "Name of the credentials"
const: "IAM Role"
enum:
- "IAM Role"
default: "IAM Role"
order: 0
role_arn:
title: "Target Role Arn"
type: "string"
description: "Will assume this role to write data to s3"
airbyte_secret: false
- type: "object"
title: "IAM User"
required:
- "credentials_title"
- "aws_access_key_id"
- "aws_secret_access_key"
properties:
credentials_title:
type: "string"
title: "Credentials Title"
description: "Name of the credentials"
const: "IAM User"
enum:
- "IAM User"
default: "IAM User"
order: 0
aws_access_key_id:
title: "Access Key Id"
type: "string"
description: "AWS User Access Key Id"
airbyte_secret: true
aws_secret_access_key:
title: "Secret Access Key"
type: "string"
description: "Secret Access Key"
airbyte_secret: true
order: 2
region:
title: "S3 Bucket Region"
type: "string"
default: ""
description: "The region of the S3 bucket. See <a href=\"https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-available-regions\"\
>here</a> for all region codes."
enum:
- ""
- "us-east-1"
- "us-east-2"
- "us-west-1"
- "us-west-2"
- "af-south-1"
- "ap-east-1"
- "ap-south-1"
- "ap-northeast-1"
- "ap-northeast-2"
- "ap-northeast-3"
- "ap-southeast-1"
- "ap-southeast-2"
- "ca-central-1"
- "cn-north-1"
- "cn-northwest-1"
- "eu-central-1"
- "eu-north-1"
- "eu-south-1"
- "eu-west-1"
- "eu-west-2"
- "eu-west-3"
- "sa-east-1"
- "me-south-1"
- "us-gov-east-1"
- "us-gov-west-1"
order: 3
bucket_name:
title: "S3 Bucket Name"
type: "string"
description: "The name of the S3 bucket. Read more <a href=\"https://docs.aws.amazon.com/AmazonS3/latest/userguide/create-bucket-overview.html\"\
>here</a>."
order: 4
bucket_prefix:
title: "Target S3 Bucket Prefix"
type: "string"
description: "S3 prefix"
order: 5
lakeformation_database_name:
title: "Lake Formation Database Name"
type: "string"
description: "The default database this destination will use to create tables\
\ in per stream. Can be changed per connection by customizing the namespace."
order: 6
lakeformation_database_default_tag_key:
title: "Lake Formation Database Tag Key"
description: "Add a default tag key to databases created by this destination"
examples:
- "pii_level"
type: "string"
order: 7
lakeformation_database_default_tag_values:
title: "Lake Formation Database Tag Values"
description: "Add default values for the `Tag Key` to databases created\
\ by this destination. Comma separate for multiple values."
examples:
- "private,public"
type: "string"
order: 8
lakeformation_governed_tables:
title: "Lake Formation Governed Tables"
description: "Whether to create tables as LF governed tables."
type: "boolean"
default: false
order: 9
format:
title: "Output Format *"
type: "object"
description: "Format of the data output."
oneOf:
- title: "JSON Lines: Newline-delimited JSON"
required:
- "format_type"
properties:
format_type:
title: "Format Type *"
type: "string"
enum:
- "JSONL"
default: "JSONL"
compression_codec:
title: "Compression Codec (Optional)"
description: "The compression algorithm used to compress data."
type: "string"
enum:
- "UNCOMPRESSED"
- "GZIP"
default: "UNCOMPRESSED"
- title: "Parquet: Columnar Storage"
required:
- "format_type"
properties:
format_type:
title: "Format Type *"
type: "string"
enum:
- "Parquet"
default: "Parquet"
compression_codec:
title: "Compression Codec (Optional)"
description: "The compression algorithm used to compress data."
type: "string"
enum:
- "UNCOMPRESSED"
- "SNAPPY"
- "GZIP"
- "ZSTD"
default: "SNAPPY"
order: 10
partitioning:
title: "Choose how to partition data"
description: "Partition data by cursor fields when a cursor field is a date"
type: "string"
enum:
- "NO PARTITIONING"
- "DATE"
- "YEAR"
- "MONTH"
- "DAY"
- "YEAR/MONTH"
- "YEAR/MONTH/DAY"
default: "NO PARTITIONING"
order: 11
glue_catalog_float_as_decimal:
title: "Glue Catalog: Float as Decimal"
description: "Cast float/double as decimal(38,18). This can help achieve\
\ higher accuracy and represent numbers correctly as received from the\
\ source."
type: "boolean"
default: false
order: 12
supportsIncremental: true
supportsNormalization: false
supportsDBT: false
supported_destination_sync_modes:
- "overwrite"
- "append"
- dockerImage: "airbyte/destination-bigquery:1.3.0"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/destinations/bigquery"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "BigQuery Destination Spec"
type: "object"
required:
- "project_id"
- "dataset_location"
- "dataset_id"
additionalProperties: true
properties:
project_id:
type: "string"
description: "The GCP project ID for the project containing the target BigQuery\
\ dataset. Read more <a href=\"https://cloud.google.com/resource-manager/docs/creating-managing-projects#identifying_projects\"\
>here</a>."
title: "Project ID"
order: 0
dataset_location:
type: "string"
description: "The location of the dataset. Warning: Changes made after creation\
\ will not be applied. Read more <a href=\"https://cloud.google.com/bigquery/docs/locations\"\
>here</a>."
title: "Dataset Location"
order: 1
enum:
- "US"
- "EU"
- "asia-east1"
- "asia-east2"
- "asia-northeast1"
- "asia-northeast2"
- "asia-northeast3"
- "asia-south1"
- "asia-south2"
- "asia-southeast1"
- "asia-southeast2"
- "australia-southeast1"
- "australia-southeast2"
- "europe-central1"
- "europe-central2"
- "europe-north1"
- "europe-southwest1"
- "europe-west1"
- "europe-west2"
- "europe-west3"
- "europe-west4"
- "europe-west6"
- "europe-west7"
- "europe-west8"
- "europe-west9"
- "me-west1"
- "northamerica-northeast1"
- "northamerica-northeast2"
- "southamerica-east1"
- "southamerica-west1"
- "us-central1"
- "us-east1"
- "us-east2"
- "us-east3"
- "us-east4"
- "us-east5"
- "us-west1"
- "us-west2"
- "us-west3"
- "us-west4"
dataset_id:
type: "string"
description: "The default BigQuery Dataset ID that tables are replicated\
\ to if the source does not specify a namespace. Read more <a href=\"\
https://cloud.google.com/bigquery/docs/datasets#create-dataset\">here</a>."
title: "Default Dataset ID"
order: 2
loading_method:
type: "object"
title: "Loading Method"
description: "Loading method used to send select the way data will be uploaded\
\ to BigQuery. <br/><b>Standard Inserts</b> - Direct uploading using SQL\
\ INSERT statements. This method is extremely inefficient and provided\
\ only for quick testing. In almost all cases, you should use staging.\
\ <br/><b>GCS Staging</b> - Writes large batches of records to a file,\
\ uploads the file to GCS, then uses <b>COPY INTO table</b> to upload\
\ the file. Recommended for most workloads for better speed and scalability.\
\ Read more about GCS Staging <a href=\"https://docs.airbyte.com/integrations/destinations/bigquery#gcs-staging\"\
>here</a>."
order: 3
oneOf:
- title: "Standard Inserts"
required:
- "method"
properties:
method:
type: "string"
const: "Standard"
- title: "GCS Staging"
required:
- "method"
- "gcs_bucket_name"
- "gcs_bucket_path"
- "credential"
properties:
method:
type: "string"
const: "GCS Staging"
order: 0
credential:
title: "Credential"
description: "An HMAC key is a type of credential and can be associated\
\ with a service account or a user account in Cloud Storage. Read\
\ more <a href=\"https://cloud.google.com/storage/docs/authentication/hmackeys\"\
>here</a>."
type: "object"
order: 1
oneOf:
- title: "HMAC key"
required:
- "credential_type"
- "hmac_key_access_id"
- "hmac_key_secret"
properties:
credential_type:
type: "string"
const: "HMAC_KEY"
order: 0
hmac_key_access_id:
type: "string"
description: "HMAC key access ID. When linked to a service account,\
\ this ID is 61 characters long; when linked to a user account,\
\ it is 24 characters long."
title: "HMAC Key Access ID"
airbyte_secret: true
examples:
- "1234567890abcdefghij1234"
order: 1
hmac_key_secret:
type: "string"
description: "The corresponding secret for the access ID. It\
\ is a 40-character base-64 encoded string."
title: "HMAC Key Secret"
airbyte_secret: true
examples:
- "1234567890abcdefghij1234567890ABCDEFGHIJ"
order: 2
gcs_bucket_name:
title: "GCS Bucket Name"
type: "string"
description: "The name of the GCS bucket. Read more <a href=\"https://cloud.google.com/storage/docs/naming-buckets\"\
>here</a>."
examples:
- "airbyte_sync"
order: 2
gcs_bucket_path:
title: "GCS Bucket Path"
description: "Directory under the GCS bucket where data will be written."
type: "string"
examples:
- "data_sync/test"
order: 3
keep_files_in_gcs-bucket:
type: "string"
description: "This upload method is supposed to temporary store records\
\ in GCS bucket. By this select you can chose if these records should\
\ be removed from GCS when migration has finished. The default \"\
Delete all tmp files from GCS\" value is used if not set explicitly."
title: "GCS Tmp Files Afterward Processing"
default: "Delete all tmp files from GCS"
enum:
- "Delete all tmp files from GCS"
- "Keep all tmp files in GCS"
order: 4
file_buffer_count:
title: "File Buffer Count"
type: "integer"
minimum: 10
maximum: 50
default: 10
description: "Number of file buffers allocated for writing data. Increasing\
\ this number is beneficial for connections using Change Data Capture\
\ (CDC) and up to the number of streams within a connection. Increasing\
\ the number of file buffers past the maximum number of streams\
\ has deteriorating effects"
examples:
- "10"
order: 5
credentials_json:
type: "string"
description: "The contents of the JSON service account key. Check out the\
\ <a href=\"https://docs.airbyte.com/integrations/destinations/bigquery#service-account-key\"\
>docs</a> if you need help generating this key. Default credentials will\
\ be used if this field is left empty."
title: "Service Account Key JSON (Required for cloud, optional for open-source)"
airbyte_secret: true
order: 4
always_show: true
transformation_priority:
type: "string"
description: "Interactive run type means that the query is executed as soon\
\ as possible, and these queries count towards concurrent rate limit and\
\ daily limit. Read more about interactive run type <a href=\"https://cloud.google.com/bigquery/docs/running-queries#queries\"\
>here</a>. Batch queries are queued and started as soon as idle resources\
\ are available in the BigQuery shared resource pool, which usually occurs\
\ within a few minutes. Batch queries don’t count towards your concurrent\
\ rate limit. Read more about batch queries <a href=\"https://cloud.google.com/bigquery/docs/running-queries#batch\"\
>here</a>. The default \"interactive\" value is used if not set explicitly."
title: "Transformation Query Run Type"
default: "interactive"
enum:
- "interactive"
- "batch"
order: 5
big_query_client_buffer_size_mb:
title: "Google BigQuery Client Chunk Size"
description: "Google BigQuery client's chunk (buffer) size (MIN=1, MAX =\
\ 15) for each table. The size that will be written by a single RPC. Written\
\ data will be buffered and only flushed upon reaching this size or closing\
\ the channel. The default 15MB value is used if not set explicitly. Read\
\ more <a href=\"https://googleapis.dev/python/bigquery/latest/generated/google.cloud.bigquery.client.Client.html\"\
>here</a>."
type: "integer"
minimum: 1
maximum: 15
default: 15
examples:
- "15"
order: 6
supportsIncremental: true
supportsNormalization: true
supportsDBT: true
supported_destination_sync_modes:
- "overwrite"
- "append"
- "append_dedup"
- dockerImage: "airbyte/destination-bigquery-denormalized:1.3.0"
spec:
documentationUrl: "https://docs.airbyte.com/integrations/destinations/bigquery"
connectionSpecification:
$schema: "http://json-schema.org/draft-07/schema#"
title: "BigQuery Denormalized Typed Struct Destination Spec"
type: "object"
required:
- "project_id"
- "dataset_id"
additionalProperties: true
properties:
project_id:
type: "string"