Create Change Stream
firestore.create_change_stream
ActionDatabases & warehousesconnection required
Calls firestore v1 POST /v1/projects/{projectsId}/databases/{databasesId}/changeStreams.
Creates a new change stream for the database.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Google Firestore
- Secret shape
- {"client_id", "client_secret", "refresh_token"}
- Config it needs
- project_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 fields, 3 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
database Database name or id. | string | Yes | — | — | — |
body The GoogleFirestoreAdminV1ChangeStream resource, as the API defines it. | object | Yes | — | — | — |
change_stream_id The ID to use for the change stream, which will become the final component of the change stream's resource name. Required. | string | Yes | — | — | — |
Output
One shape.
result
Extra keys beyond the ones listed can appear.
| Field | Type | Example |
|---|---|---|
collectionGroupScope | object | — |
createTime | string | — |
databaseScope | object | — |
etag | string | — |
name | string | — |
retentionPeriod | string | — |
startTime | string | — |
updateTime | string | — |
{
"collectionGroupScope": {},
"createTime": "",
"databaseScope": {},
"etag": "",
"name": "",
"retentionPeriod": "",
"startTime": "",
"updateTime": ""
}See Create Change Stream run in a workflow.
In a technical demo we add the Google Firestore connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.