Skip to content

BigQuery

BigQuery (big-query)

Stream data into Google BigQuery.

Data Warehouse json

Minimal example

output:
big-query:
connection:
project: ~
JSON
{
"output": {
"big-query": {
"connection": {
"project": null
}
}
}
}

Contents

Fields

FieldTypeRequiredDescription
connection ConnectionConnectionConnection details (project, dataset, table).
retry ReliabilityRetryRetry configuration for transient failures.
batch ProcessingBatchBatching configuration (size/timeout).
mode OperationModeOutput mode (streaming or load-job).
Allowed values: streaming, load-job
streaming StreamingStreamingConfiguration for Storage Write API.
load-job Load JobLoad JobConfiguration for Load Jobs (GCS staging).
schema SchemaSchemaSchema handling and coercion settings.
credentials AuthenticationCredentialsAuthentication credentials.
parameters ParametersParameters[]Parameters for template expansion.

Reliability

Show fields
FieldTypeRequiredDescription
retryRetryRetry configuration for transient failures.

Processing

Show fields
FieldTypeRequiredDescription
batchBatchBatching configuration (size/timeout).

Connection

Show fields
FieldTypeRequiredDescription
connectionConnectionConnection details (project, dataset, table).

Operation

Show fields
FieldTypeRequiredDescription
modeModeOutput mode (streaming or load-job).
Allowed values: streaming, load-job

Streaming

Show fields
FieldTypeRequiredDescription
streamingStreamingConfiguration for Storage Write API.

Load Job

Show fields
FieldTypeRequiredDescription
load-jobLoad JobConfiguration for Load Jobs (GCS staging).

Schema

Show fields
FieldTypeRequiredDescription
schemaSchemaSchema handling and coercion settings.

Authentication

Show fields
FieldTypeRequiredDescription
credentialsCredentialsAuthentication credentials.

Parameters

Show fields
FieldTypeRequiredDescription
parametersParameters[]Parameters for template expansion.

Schema

Credentials Options

OptionNameTypeDescription
service-accountService Accountobject
service-account-fileService Account Fileobject
workload-identityWorkload Identityobject
application-defaultApplication Defaultmap

Retry Fields

FieldTypeRequiredDescription
timeouttime-interval (string)timeout (e.g. 500ms, 2s etc. - default is 30).
Examples: 500ms, 2h
retriesnumber (integer)number of retries.
Examples: 42, 1.2e-10

Batch Fields

FieldTypeRequiredDescription
fixed-sizenumber (integer)maximum number of events in an output batch.
Examples: 42, 1.2e-10
modeModeIf ‘document’ send on end of document generated by input. If ‘fixed’, use fixed_size.
Allowed values: fixed, document
timeouttime-interval (string)interval after which the batch is sent, to keep throughput going (default 100ms).
Examples: 500ms, 2h
headermultiline-text (string)put a header line before the batch.
footermultiline-text (string)put a header line after the last line of the batch.
use-document-markerboolean (bool)Enrich the job metadata with a document marker (for document handling in batch mode).
wrap-as-jsonboolean (bool)Format the output batch as a JSON array.

Connection - Impersonation Fields

FieldTypeRequiredDescription
service-accountstring
delegatesstring[]

Connection Fields

FieldTypeRequiredDescription
projectstring
datasetstring
tablestring
billing-projectstring
locationstring
impersonationImpersonationImpersonate a service account (requires IAM Credentials API).

Streaming Fields

FieldTypeRequiredDescription
stream-typeStream TypeAllowed values: default, committed, pending, buffered
insert-id-fieldstringField to use for deduplication (insertId).

Load Job Fields

FieldTypeRequiredDescription
staging-uristringGCS URI for staging files (gs://bucket/path).
write-dispositionWrite DispositionAllowed values: write-append, write-truncate, write-empty
create-dispositionCreate DispositionAllowed values: create-if-needed, create-never

Schema - Overrides Fields

FieldTypeRequiredDescription
field-pathstring
target-typestring

Schema Fields

FieldTypeRequiredDescription
auto-fetchboolean (bool)
overridesOverrides[]

Credentials - Service Account Fields

FieldTypeRequiredDescription
secret-idstring

Credentials - Service Account File Fields

FieldTypeRequiredDescription
pathstring

Credentials - Workload Identity Fields

FieldTypeRequiredDescription
audiencestring
service-account-emailstring

Parameters Fields

FieldTypeRequiredDescription
namestring
valuestring
r-typestring

Batch - Mode Options

ValueDescription
fixedFixed
documentDocument

Mode Options

ValueDescription
streamingStreaming
load-jobLoad Job

Streaming - Stream Type Options

ValueDescription
defaultDefault
committedCommitted
pendingPending
bufferedBuffered

Load Job - Write Disposition Options

ValueDescription
write-appendWrite Append
write-truncateWrite Truncate
write-emptyWrite Empty

Load Job - Create Disposition Options

ValueDescription
create-if-neededCreate If Needed
create-neverCreate Never