.TH "GCLOUD_ALPHA_FIRESTORE_EXPORT" 1



.SH "NAME"
.HP
gcloud alpha firestore export \- export Cloud Firestore documents to Google Cloud Storage



.SH "SYNOPSIS"
.HP
\f5gcloud alpha firestore export\fR \fIOUTPUT_URI_PREFIX\fR [\fB\-\-async\fR] [\fB\-\-collection\-ids\fR=[\fICOLLECTION_IDS\fR,...]] [\fB\-\-database\fR=\fIDATABASE\fR;\ default="(default)"] [\fB\-\-namespace\-ids\fR=[\fINAMESPACE_IDS\fR,...]] [\fB\-\-snapshot\-time\fR=\fISNAPSHOT_TIME\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR export Cloud Firestore documents to Google Cloud Storage.



.SH "EXAMPLES"

To export all collection groups to \f5mybucket\fR in objects prefixed with
\f5my/path\fR, run:

.RS 2m
$ gcloud alpha firestore export gs://mybucket/my/path
.RE

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

.RS 2m
$ gcloud alpha firestore export gs://mybucket/my/path \e
    \-\-collection\-ids='specific collection group1','specific
 collection group2' \-\-async
.RE

To export all collection groups from certain namespace, run:

.RS 2m
$ gcloud alpha firestore export gs://mybucket/my/path \e
    \-\-namespace\-ids='specific namespace id'
.RE

To export from a snapshot at '2023\-05\-26T10:20:00.00Z', run:

.RS 2m
$ gcloud alpha firestore export gs://mybucket/my/path \e
    \-\-snapshot\-time='2023\-05\-26T10:20:00.00Z'
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m
\fIOUTPUT_URI_PREFIX\fR

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

For example:

.RS 2m
$ gcloud alpha firestore export gs://mybucket/my/path
.RE

Will place the export in the \f5mybucket\fR bucket in objects prefixed with
\f5my/path\fR.


.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

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

.TP 2m
\fB\-\-collection\-ids\fR=[\fICOLLECTION_IDS\fR,...]

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

For example, to operate on only the \f5customers\fR and \f5orders\fR
collections:

.RS 2m
$ gcloud alpha firestore export \-\-collection\-ids='customers','orders'
.RE

.TP 2m
\fB\-\-database\fR=\fIDATABASE\fR; default="(default)"

The database to operate on. The default value is \f5(default)\fR.

For example, to operate on database \f5foo\fR:

.RS 2m
$ gcloud alpha firestore export \-\-database='foo'
.RE

.TP 2m
\fB\-\-namespace\-ids\fR=[\fINAMESPACE_IDS\fR,...]

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 \f5customers\fR and \f5orders\fR namespaces:

.RS 2m
$ gcloud alpha firestore export \-\-namespaces\-ids='customers','orders'
.RE

.TP 2m
\fB\-\-snapshot\-time\fR=\fISNAPSHOT_TIME\fR

The version of the database to export.

The timestamp must be in the past, rounded to the minute and not older than
\f5earliestVersionTime\fR. If specified, then the exported documents will
represent a consistent view of the database at the provided time. Otherwise,
there are no guarantees about the consistency of the exported documents.

For example, to operate on snapshot time \f52023\-05\-26T10:20:00.00Z\fR:

.RS 2m
$ gcloud alpha firestore export \e
    \-\-snapshot\-time='2023\-05\-26T10:20:00.00Z'
.RE


.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "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. These variants are also available:

.RS 2m
$ gcloud firestore export
.RE

.RS 2m
$ gcloud beta firestore export
.RE