NAME

gcloud firestore export - export Cloud Firestore documents to Google Cloud Storage

SYNOPSIS

gcloud firestore export OUTPUT_URI_PREFIX [--async] [--collection-ids=[COLLECTION_IDS,...]] [--database=DATABASE; default="(default)"] [--namespace-ids=[NAMESPACE_IDS,...]] [GCLOUD_WIDE_FLAG ...]

DESCRIPTION

export Cloud Firestore documents to Google Cloud Storage.

EXAMPLES

To export all collection groups to mybucket in objects prefixed with my/path, run:

$ gcloud firestore export gs://mybucket/my/path

To export a specific set of collections groups asynchronously, run:

$ gcloud firestore export gs://mybucket/my/path \ --collection-ids='specific collection group1','specific collection group2' --async

To export all collection groups from certain namespace, run:

$ gcloud firestore export gs://mybucket/my/path \ --namespace-ids='specific namespace id'

POSITIONAL ARGUMENTS

OUTPUT_URI_PREFIX

Location where the export files will be stored. Must be a valid Google Cloud Storage bucket with an optional path prefix.

For example:

$ gcloud firestore export gs://mybucket/my/path

Will place the export in the mybucket bucket in objects prefixed with my/path.

FLAGS

--async

Return immediately, without waiting for the operation in progress to complete.

--collection-ids=[COLLECTION_IDS,...]

List specifying which collections will be included in the operation. When omitted, all collections are included.

For example, to operate on only the customers and orders collections:

$ gcloud firestore export --collection-ids='customers','orders'

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

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

For example, to operate on database foo:

$ gcloud firestore export --database='foo'

--namespace-ids=[NAMESPACE_IDS,...]

List specifying which namespaces will be included in the operation. When omitted, all namespaces are included.

This is only supported for Datastore Mode databases.

For example, to operate on only the customers and orders namespaces:

$ gcloud firestore export --namespaces-ids='customers','orders'

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

These variants are also available:

$ gcloud alpha firestore export

$ gcloud beta firestore export