Google Cloud Query
CertifiedQuery documents from Firestore
Google Cloud Query
Query documents from Firestore
Executes a Firestore query with optional filters, ordering, pagination, and fetch mode. Supports fetching first/all rows or storing results to a file.
type: io.kestra.plugin.gcp.firestore.QueryExamples
id: gcp_firestore_query
namespace: company.team
tasks:
- id: query
type: io.kestra.plugin.gcp.firestore.Query
collection: "persons"
filters:
- field: "lastname"
value: "Doe"
Properties
collection string
Collection path
Target collection name or path
databaseId string
(default)Database ID
Defaults to (default) if not provided
fetchType string
STORESTOREFETCHFETCH_ONENONEFetch type
FETCH_ONE returns first row; FETCH returns all rows in output; STORE writes rows to a file; NONE returns nothing.
filters Non-dynamicarray
Filters
List of field/operator/value filters applied as where clauses
A filter for the where clause
Field name for the filter
Field value for the filter
Field value for the filter. Only strings are supported at the moment.
EQUAL_TOEQUAL_TONOT_EQUAL_TOLESS_THANLESS_THAN_OR_EQUAL_TOGREATER_THANGREATER_THAN_OR_EQUAL_TOThe operator for the filter, by default EQUAL_TO that will call 'collection.whereEqualTo(name, value)'
impersonatedServiceAccount string
The GCP service account to impersonate
limit integerstring
Limit
Maximum number of results
offset integerstring
Offset
Start offset for paginating results
orderBy string
Order by field
orderDirection string
ASCENDINGASCENDINGDESCENDINGOrder direction
ASCENDING by default
pluginDefaultsRef Non-dynamicstring
Reference (ref) of the pluginDefaults to apply to this task.
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
Outputs
row object
Map containing the first row of fetched data.
Only populated if using fetchType=FETCH_ONE.
rows array
List containing the fetched data.
Only populated if using fetchType=FETCH.
size integer
The number of fetched rows.
uri string
uriKestra's internal storage URI of the stored data.
Only populated if using fetchType=STORE.
Metrics
records counter
recordsNumber of records queried from the Firestore collection.
