.TH "GCLOUD_ALPHA_FIRESTORE_DATABASES_RESTORE" 1



.SH "NAME"
.HP
gcloud alpha firestore databases restore \- restores a Cloud Firestore database from a backup



.SH "SYNOPSIS"
.HP
\f5gcloud alpha firestore databases restore\fR \fB\-\-destination\-database\fR=\fIDESTINATION_DATABASE\fR \fB\-\-source\-backup\fR=\fISOURCE_BACKUP\fR [\fB\-\-tags\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-encryption\-type\fR=\fIENCRYPTION_TYPE\fR\ :\ \fB\-\-kms\-key\-name\fR=\fIKMS_KEY_NAME\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "EXAMPLES"

To restore a database from a backup.

.RS 2m
$ gcloud alpha firestore databases restore \e
  \-\-source\-backup=projects/PROJECT_ID/locations/LOCATION_ID/\e
backups/BACKUP_ID \-\-destination\-database=DATABASE_ID
.RE

To restore a database from a backup with tags.

.RS 2m
$ gcloud alpha firestore databases restore \e
  \-\-source\-backup=projects/PROJECT_ID/locations/LOCATION_ID/\e
backups/BACKUP_ID \-\-destination\-database=DATABASE_ID \e
    \-\-tags=key1=value1,key2=value2
.RE

To restore to a CMEK\-enabled database.

.RS 2m
$ gcloud alpha firestore databases restore \e
  \-\-source\-backup=projects/PROJECT_ID/locations/LOCATION_ID/\e
backups/BACKUP_ID \-\-destination\-database=DATABASE_ID \e
    \-\-encryption\-type=customer\-managed\-encryption \e
    \-\-kms\-key\-name=projects/PROJECT_ID/locations/LOCATION_ID/\e
keyRings/KEY_RING_ID/cryptoKeys/CRYPTO_KEY_ID
.RE



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-destination\-database\fR=\fIDESTINATION_DATABASE\fR

Destination database to restore to. Destination database will be created in the
same location as the source backup.

This value should be 4\-63 characters. Valid characters are /[a\-z][0\-9]\-/
with first character a letter and the last a letter or a number. Must not be
UUID\-like /[0\-9a\-f]8(\-[0\-9a\-f]4)3\-[0\-9a\-f]12/.

Using "(default)" database ID is also allowed.

For example, to restore to database \f5testdb\fR:

.RS 2m
$ gcloud alpha firestore databases restore \e
    \-\-destination\-database=testdb
.RE

.TP 2m
\fB\-\-source\-backup\fR=\fISOURCE_BACKUP\fR

The source backup to restore from.

For example, to restore from backup
\f5cf9f748a\-7980\-4703\-b1a1\-d1ffff591db0\fR in us\-east1:

.RS 2m
$ gcloud alpha firestore databases restore \e
    \-\-source\-backup=projects/PROJECT_ID/locations/us\-east1/backups/\e
cf9f748a\-7980\-4703\-b1a1\-d1ffff591db0
.RE


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-tags\fR=[\fIKEY\fR=\fIVALUE\fR,...]

Tags to attach to the destination database. Example:
\-\-tags=key1=value1,key2=value2

For example, to attach tags to a database:

$ \-\-tags=key1=value1,key2=value2

.TP 2m

The encryption configuration of the new database being created from the backup.
If not specified, the same encryption settings as the backup will be used.

To create a CMEK\-enabled database:

.RS 2m
$ gcloud alpha firestore databases restore \e
    \-\-encryption\-type=customer\-managed\-encryption \e
    \-\-kms\-key\-name=projects/PROJECT_ID/locations/LOCATION_ID/\e
keyRings/KEY_RING_ID/cryptoKeys/CRYPTO_KEY_ID
.RE

To create a Google\-default\-encrypted database:

.RS 2m
$ gcloud alpha firestore databases restore \e
    \-\-encryption\-type=google\-default\-encryption
.RE

To create a database using the same encryption settings as the backup:

.RS 2m
$ gcloud alpha firestore databases restore \e
    \-\-encryption\-type=use\-source\-encryption
.RE



.RS 2m
.TP 2m
\fB\-\-encryption\-type\fR=\fIENCRYPTION_TYPE\fR

The encryption type of the destination database. \fIENCRYPTION_TYPE\fR must be
one of: \fBuse\-source\-encryption\fR, \fBcustomer\-managed\-encryption\fR,
\fBgoogle\-default\-encryption\fR.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-kms\-key\-name\fR=\fIKMS_KEY_NAME\fR

The resource ID of a Cloud KMS key. If set, the database created will be a
Customer\-Managed Encryption Key (CMEK) database encrypted with this key. This
feature is allowlist only in initial launch.

Only a key in the same location as this database is allowed to be used for
encryption. For Firestore's nam5 multi\-region, this corresponds to Cloud KMS
location us. For Firestore's eur3 multi\-region, this corresponds to Cloud KMS
location europe. See https://cloud.google.com/kms/docs/locations.

This value should be the KMS key resource ID in the format of
\f5projects/{project_id}/locations/{kms_location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}\fR.
How to retrieve this resource ID is listed at
https://cloud.google.com/kms/docs/getting\-resource\-ids#getting_the_id_for_a_key_and_version.


This flag must only be specified when encryption\-type is
\f5customer\-managed\-encryption\fR.


.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 databases restore
.RE

.RS 2m
$ gcloud beta firestore databases restore
.RE