Page Comparison

Reference Name

No

Required. Name used to uniquely identify this source for lineage, annotating metadata, etc.

Database Id

Yes

1.1.0

Optional. Firestore database name. If no value is provided, then (default) will be used.

Collection

Yes

Required. Name of the Firestore collection to read data from.

Mode

Yes

Required. Mode of query. The mode can be one of two values:

• Basic. Will allow user to specify documents to pull or skip.

• Advanced. Will allow user to specify custom query.

Default is Basic.

Filters

Yes

Optional. Specify the custom filter for fetching documents from Firestore Collection. Supported operators are,

• EqualTo

• NumericEqualTo

• LessThan

• LessThanOrEqualTo

• GreaterThan

• GreaterThanOrEqualTo

A filter must specify the operator with field it should filter on as well the value. Filters are specified using syntax: value:operator(field)[,value:operator(field)].

For example, CA:EqualTo(state),1000000:LessThan(population) will apply two filters. The first will create a filter as state = 'CA'. The second will create a filter as population < 1000000.

Note: This applies only if Mode is set to Advanced.

Documents to pull

Yes

Optional. Specify the document ids to be extracted from Firestore Collection; for example: 'Doc1,Doc2'. Note: This applies only if Mode is set to Basic.

Documents to skip

Yes

Optional. Specify the document ids to be skipped from Firestore Collection; for example: 'Doc1,Doc2'. Note: This applies only if Mode is set to Basic.

Service Account Type

Yes

OptionalRequired. Service Account type, file path where the service account is located or the JSON content of the service account.

Service Account File Path

Yes

Optional. Path on the local file system of the service account key used for authorization. Can be set to auto-detect when running on a Dataproc cluster. When running on other clusters, the file must be present on every node in the cluster.

Default is auto-detect.

Service Account JSON

Yes

Optional. Content of the Service Account file.

Project ID

Yes

Optional. Google Cloud Project ID, which uniquely identifies a project. It can be found on the Dashboard in the Google Cloud Platform Console.

Default is auto-detect.

Include Document Id?

Yes

Option to include Document ID in the output. This can have one two values:

• Yes. Document id will be included.

• No. Document id will not be included.

Note: if Yes is selected, default document id name (__id__) or its alias must be present in the schema with non-nullable STRING type.

Default is No.

Document Id Alias

Yes

Optional. Name of the field to set as the document id field. This value is ignored if the Include Document Id is set to No.

If no value is provided, __id__ is used.