Query documents of a collection.

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"

Dynamic YES

The Firestore collection

Dynamic YES

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

Dynamic NO

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

Dynamic YES

The GCP service account to impersonate.

Dynamic YES

Maximum numbers of returned results.

Dynamic YES

Start offset for pagination of the query results.

Dynamic YES

Field name for the order by clause.

Dynamic YES

Default ASCENDING

Possible Values

ASCENDINGDESCENDING

Field name for the order by clause.

Dynamic YES

The GCP project ID.

SubType string

Dynamic YES

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

The GCP scopes to be used.

Dynamic YES

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.

Dynamic YES

Field name for the filter.

Dynamic YES

Field value for the filter.

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

Dynamic YES

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