Query

Query documents of a collection.

yaml
type: "io.kestra.plugin.gcp.firestore.Query"

yaml
id: gcp_firestore_query
namespace: company.team

tasks:
  - id: query
    type: io.kestra.plugin.gcp.firestore.Query
    collection: "persons"
    filters:
      - field: "lastname"
        value: "Doe"

The Firestore collection

Default STORE

Possible Values

STOREFETCHFETCH_ONENONE

The 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.

SubType

List of query filters that will be added as a where clause.

The GCP service account to impersonate.

Maximum numbers of returned results.

Start offset for pagination of the query results.

Field name for the order by clause.

Default ASCENDING

Possible Values

ASCENDINGDESCENDING

Field name for the order by clause.

The GCP project ID.

SubType string

Default ["https://www.googleapis.com/auth/cloud-platform"]

The GCP scopes to be used.

The GCP service account.

Map containing the first row of fetched data.

Only populated if using fetchType=FETCH_ONE.

List containing the fetched data.

Only populated if using fetchType=FETCH.

The number of fetched rows.

Format uri

Kestra's internal storage URI of the stored data.

Only populated if using fetchType=STORE.

Field name for the filter.

Field value for the filter.

Field value for the filter. Only strings are supported at the moment.

Default EQUAL_TO

Possible Values

EQUAL_TONOT_EQUAL_TOLESS_THANLESS_THAN_OR_EQUAL_TOGREATER_THANGREATER_THAN_OR_EQUAL_TO

The operator for the filter, by default EQUAL_TO that will call 'collection.whereEqualTo(name, value)'

​Query

Query