Google Cloud ReadRows
CertifiedRead rows from a Google Cloud Bigtable table
Google Cloud ReadRows
Read rows from a Google Cloud Bigtable table
Reads rows from a Bigtable table using an optional row key range, row key prefix, or cell filter. Supports FETCH (return all rows in the output), FETCH_ONE (return only the first row), and STORE (persist all rows to internal storage as ion, recommended for large result sets) fetch types
type: io.kestra.plugin.gcp.bigtable.ReadRowsExamples
Read rows from Bigtable by row key prefix and store the result
id: bigtable_read_rows
namespace: company.team
tasks:
- id: read
type: io.kestra.plugin.gcp.bigtable.ReadRows
projectId: "{{ secret('GCP_PROJECT_ID') }}"
instanceId: my-instance
tableId: sensor-readings
rowKeyPrefix: "device-42#"
fetchType: STORE
Read the first row within a row key range
id: bigtable_read_one_row
namespace: company.team
tasks:
- id: read
type: io.kestra.plugin.gcp.bigtable.ReadRows
projectId: "{{ secret('GCP_PROJECT_ID') }}"
instanceId: my-instance
tableId: sensor-readings
rowKeyStart: "device-42#001"
rowKeyEnd: "device-42#002"
fetchType: FETCH_ONE
Properties
instanceId *string
The Bigtable instance ID
An instance is a container for your tables within a given GCP project.
projectId *string
The GCP project ID
tableId *string
The Bigtable table ID to read from
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
{}1150columnFamily string
Only return cells from this column family
If not set, cells from all column families are returned
emulatorHost string
Bigtable emulator host (host: port), for local testing only
When set, the task connects to a local Bigtable emulator instead of the real Bigtable service, using plaintext transport and no credentials. Not intended for production use.
fetchType string
STORESTOREFETCHFETCH_ONENONEData storage method
FETCH_ONE outputs the first row, FETCH outputs all rows in the output variable, STORE stores all rows to a file in internal storage and is recommended for large result sets
impersonatedServiceAccount string
The GCP service account to impersonate
limit integerstring
Maximum number of rows to read
If not set, all matching rows are read
rowKeyEnd string
Exclusive end of the row key range to scan
Used together with rowKeyStart. Ignored if rowKeyPrefix is set
rowKeyPrefix string
Row key prefix to filter on
Mutually exclusive with rowKeyStart/rowKeyEnd
rowKeyStart string
Inclusive start of the row key range to scan
Mutually exclusive with rowKeyPrefix. If neither is set, the full table is scanned
scopes array
The GCP scopes to be used
serviceAccount string
The GCP service account
Outputs
row object
The first matching row (only set when fetchType is FETCH_ONE)
rowCount integer
Number of rows read
rows array
All matching rows (only set when fetchType is FETCH)
uri string
uriURI of the file storing all rows (only set when fetchType is STORE)
