Google Cloud BigQuery StorageWrite
Certified
Stream a file to BigQuery via Storage Write API
Google Cloud BigQuery StorageWrite
Stream a file to BigQuery via Storage Write API
Reads a file from Kestra internal storage and writes rows with the BigQuery Storage Write API. Supports DEFAULT, COMMITTED, or PENDING streams (commit required for PENDING). Requires the destination table to exist.
type: io.kestra.plugin.gcp.bigquery.StorageWriteExamples
id: gcp_bq_storage_write
namespace: company.team
tasks:
- id: read_data
type: io.kestra.plugin.core.http.Download
uri: https://dummyjson.com/products/1
- id: storage_write
type: io.kestra.plugin.gcp.bigquery.StorageWrite
from: "{{ outputs.read_data.uri }}"
destinationTable: "my-project.my_dataset.my_table"
writeStreamType: DEFAULT
Installation
Our standard Docker images already include this plugin. If you use a -slim image or another setup, install it with the following command:
kestractl plugins get io.kestra.plugin:plugin-gcp --compatible-for $KESTRA_VERSION For kestractl, use your Kestra version with --compatible-for, or specify an exact plugin version.
Properties
destinationTable *string
The table where to load data
The table must be created before.
assets
Assets this task consumes as inputs or produces as outputs, for lineage tracking and the asset graph (Enterprise Edition). A flow declaring this property on a task is rejected in the open-source edition.
io.kestra.core.models.assets.AssetsDeclaration
IGNOREFAILWARNAsset failure behavior
Behavior applied to the task state when a declared asset fails to render, emit, or be persisted (e.g. a lock conflict): FAIL escalates it to FAILED, WARN (default) warns it if it would otherwise succeed, IGNORE leaves the state untouched.
Whether to auto-register assets referenced dynamically at runtime that are not statically declared in inputs or outputs.
The assets consumed as inputs.
io.kestra.core.models.assets.AssetIdentifier
1The assets produced as outputs.
io.kestra.plugin.ee.assets.Dataset
1150{}1150io.kestra.plugin.ee.assets.File
1150{}1150io.kestra.plugin.ee.assets.Table
1150{}1150io.kestra.plugin.ee.assets.VM
1150{}1150io.kestra.core.models.assets.External
1150{}1150io.kestra.core.models.assets.Custom
11501Custom asset type
{}1150bufferSize integerstring
1000The number of records to send on each query
from string
The fully-qualified URIs that point to source data
impersonatedServiceAccount string
The GCP service account to impersonate
location string
The geographic location where the dataset should reside
This property is experimental and might be subject to change or removed.
See Dataset Location
projectId string
The GCP project ID
scopes array
["https://www.googleapis.com/auth/cloud-platform"]The GCP scopes to be used
serviceAccount string
The GCP service account
When unset or rendered to an empty value, Application Default Credentials are used (e.g. GOOGLE_APPLICATION_CREDENTIALS or the runtime's attached identity).
workloadIdentityAudience string
Audience of the Workload Identity Federation provider
The full resource name of the workload identity pool provider, //iam.googleapis.com/projects/<number>/locations/global/workloadIdentityPools/<pool>/providers/<provider>.
Required with workloadIdentityToken, and must match the aud claim of the token.
workloadIdentityToken string
OIDC token for Workload Identity Federation
When set together with workloadIdentityAudience, the token is exchanged at Google STS for federated credentials and no service account key is needed: Google verifies it against the identity provider that issued it.
Use {{ oidcToken(audience='…') }} to have Kestra Enterprise mint one for the running execution.
Combine with impersonatedServiceAccount to act as a service account the pool may impersonate, and set projectId explicitly since no key file carries it.
Cannot be combined with serviceAccount.
writeStreamType string
DEFAULTDEFAULTCOMMITTEDPENDINGThe type of write stream to use
Outputs
commitTime string
date-timeCommit time reported by BigQuery, only on PENDING writeStreamType
rows integer
Rows count
rowsCount integer
Rows count reported by BigQuery, only on PENDING writeStreamType
Metrics
rows counter
Rows count.
rows_count counter
Rows count reported by BigQuery, only on PENDING writeStreamType.