Query Query

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

Query documents of a collection.

# Examples

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

# Properties

# collection

  • Type: string
  • Dynamic: ✔️
  • Required:

The Firestore collection

# fetchType

  • Type: FetchType
  • Dynamic:
  • Required:
  • Default: STORE

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.

# filters

  • Type: array
  • SubType: Filter
  • Dynamic:
  • Required:

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

# limit

  • Type: integer
  • Dynamic:
  • Required:

Maximum numbers of returned results.

# offset

  • Type: integer
  • Dynamic:
  • Required:

Start offset for pagination of the query results.

# orderBy

  • Type: string
  • Dynamic:
  • Required:

Field name for the order by clause.

# orderDirection

  • Type: Direction
  • Dynamic:
  • Required:
  • Default: ASCENDING

Field name for the order by clause.

# projectId

  • Type: string
  • Dynamic:
  • Required:

The GCP project id

# scopes

  • Type: array
  • SubType: string
  • Dynamic:
  • Required:
  • Default: [https://www.googleapis.com/auth/cloud-platform]

The GCP scopes to used

# serviceAccount

  • Type: string
  • Dynamic:
  • Required:

The GCP service account key

# Outputs

# row

  • Type: object

Map containing the first row of fetched data

Only populated if using fetchType=FETCH_ONE.

# rows

  • Type: array

List containing the fetched data

Only populated if using fetchType=FETCH.

# size

  • Type: integer

The size of the fetched rows

# uri

  • Type: string

The uri of stored data

Only populated if using fetchType=STORE

# Definitions

# Filter

# field

  • Type: string
  • Dynamic:
  • Required: ✔️

Field name for the filter.

# operator

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

# value

  • Type: string
  • Dynamic: ✔️
  • Required: ✔️

Field value for the filter.

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