gcloud alpha firestore change-streams create

NAME

gcloud alpha firestore change-streams create - create a Cloud Firestore change stream

SYNOPSIS

gcloud alpha firestore change-streams create CHANGE_STREAM (--collection-group-scope=COLLECTION_GROUP_ID     | --database-scope) [--database=DATABASE; default="(default)"] [--retention=RETENTION; default="7d"] [GCLOUD_WIDE_FLAG …]

EXAMPLES

To create a database-scoped change stream named my-stream in database my-db:

gcloud alpha firestore change-streams create my-stream --database=my-db --database-scope

To create a collection-group-scoped change stream named my-cg-stream for collection group my-cg in database my-db with a retention period of 1 day:

gcloud alpha firestore change-streams create my-cg-stream --database=my-db --collection-group-scope=my-cg --retention=1d

POSITIONAL ARGUMENTS

CHANGE_STREAM

The ID of the change stream.

REQUIRED FLAGS

Exactly one of these must be specified:

--collection-group-scope=COLLECTION_GROUP_ID

Create a collection-group-scoped change stream for the specified collection group (e.g., --collection-group-scope=my-collection-group).

--database-scope

Create a database-scoped change stream.

OPTIONAL FLAGS

--database=DATABASE; default="(default)"

The database to operate on. The default value is (default).

For example, to operate on database foo:

gcloud alpha firestore change-streams create --database='foo'

--retention=RETENTION; default="7d"

The retention period of the change stream (e.g. 1d, 7d). Must be between 1 and 7 days, in day granularity. Default is 7d.

GCLOUD WIDE FLAGS

These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

NOTES

This command is currently in alpha and might change without notice. If this command fails with API permission errors despite specifying the correct project, you might be trying to access an API with an invitation-only early access allowlist.