Cloud Firestore Update activity¶
Introduction¶
A Cloud Firestore Update activity, using its Cloud Firestore connection, updates documents within a collection in Cloud Firestore and is intended to be used as a target to consume data in an operation.
Create a Cloud Firestore Update activity¶
An instance of a Cloud Firestore Update activity is created from a Cloud Firestore connection using its Update activity type.
To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Create an activity instance in Component reuse.
An existing Cloud Firestore Update activity can be edited from these locations:
- The design component palette's Project endpoints and connectors tab (see Design component palette).
- The project pane's Components tab (see Component actions menu in Project pane Components tab).
- The Global Connections page (see Edit a global endpoint in Global Connections).
Configure a Cloud Firestore Update activity¶
Follow these steps to configure a Cloud Firestore Update activity:
-
Step 1: Enter a name and select a collection
Provide a name for the activity and select a collection. -
Step 2: Provide a request schema
Provide a custom request schema (optional). If you do not provide a custom request schema, the connector's default request schema will be used. -
Step 3: Provide a response schema
Provide a custom response schema (optional). If you do not provide a custom response schema, the connector's default response schema will be used. -
Step 4: Review the data schemas
Any request or response schemas are displayed.
Step 1: Enter a name and select a collection¶
In this step, provide a name for the activity and select a collection. Each user interface element of this step is described below.
Tip
Fields with a variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [
into the field or by clicking the variable icon to display a list of the existing variables to choose from.
-
Name: Enter a name to identify the activity. The name must be unique for each Cloud Firestore Update activity and must not contain forward slashes
/
or colons:
. -
Select a Collection: This section displays collections available in the Cloud Firestore endpoint.
-
Selected Collection: After a collection is selected, it is listed here.
-
Search: Enter any column's value into the search box to filter the list of collections. The search is not case-sensitive. If collections are already displayed within the table, the table results are filtered in real time with each keystroke. To reload collections from the endpoint when searching, enter search criteria and then refresh, as described below.
-
Refresh: Click the refresh icon or the word Refresh to reload collections from the Cloud Firestore endpoint. This may be useful if collections have been added to Google Cloud Firestore. This action refreshes all metadata used to build the table of collections displayed in the configuration.
-
Selecting a Collection: Within the table, click anywhere on a row to select a collection. Only one collection can be selected. The information available for each collection is fetched from the Cloud Firestore endpoint:
- ID: The ID of the collection.
Tip
If the table does not populate with available collections, the Cloud Firestore connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.
-
Document ID: Enter an ID for the new document (optional).
-
Merge on Update (Keep Fields That Are Not Being Updated): When selected, fields that do not have an update will persist. When unselected, fields that do not have an update will not be retained.
-
Continue on Error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.
-
Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.
-
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
-
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Step 2: Provide a request schema¶
In this step, you can provide a custom request schema. If you do not provide a custom request schema, the connector's default request schema will be used. Each user interface element of this step is described below.
-
Provide Request Schema: The request schema defines the structure of request data that is used by the Cloud Firestore Update activity. For instructions on completing this section of activity configuration, refer to Schemas defined in an activity.
-
Back: Click to temporarily store the configuration for this step and return to the previous step.
-
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
-
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Step 3: Provide a response schema¶
In this step, you can provide a custom response schema. If you do not provide a custom response schema, the connector's default response schema will be used. Each user interface element of this step is described below.
-
Provide Response Schema: The response schema defines the structure of response data that is used by the Cloud Firestore Update activity. For instructions on completing this section of activity configuration, refer to Schemas defined in an activity.
-
Back: Click to temporarily store the configuration for this step and return to the previous step.
-
Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.
-
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Step 4: Review the data schemas¶
Any request or response schemas are displayed. Each user interface element of this step is described below.
-
Data Schemas: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.
Note
Data supplied in a transformation takes precedence over the activity configuration.
If any custom schemas were provided in the previous steps, they will be displayed. If custom schemas were not provided, the default schemas included with the connector will be displayed.
The Cloud Firestore connector uses the Google Firebase JavaScript SDK v8. Refer to the documentation for information on the schema nodes and fields.
-
Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Cloud Firestore endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.
-
Back: Click to temporarily store the configuration for this step and return to the previous step.
-
Finished: Click to save the configuration for all steps and close the activity configuration.
-
Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.
Next steps¶
After configuring a Cloud Firestore Update activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.
Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.
Cloud Firestore Update activities can be used as a target with these operation patterns:
- Transformation pattern
- Two-transformation pattern (as the first or second target)
To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.
When ready, deploy and run the operation and validate behavior by checking the operation logs.