Query documents from a Google Cloud Firestore collection.
type: "io.kestra.plugin.gcp.firestore.Query"Examples
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
The Firestore collection
fetchType string
STORESTOREFETCHFETCH_ONENONEThe way you want to store the data
FETCH_ONE output the first row, FETCH output all the rows, STORE store all rows in a file, NONE do nothing.
impersonatedServiceAccount string
The GCP service account to impersonate.
limit integerstring
Maximum numbers of returned results.
offset integerstring
Start offset for pagination of the query results.
orderBy string
Field name for the order by clause.
orderDirection string
ASCENDINGASCENDINGDESCENDINGField name for the order by clause.
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.
Definitions
A filter for the where clause
field *Requiredstring
Field name for the filter.
value *Requiredstring
Field value for the filter.
Field value for the filter. Only strings are supported at the moment.
operator string
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)'