- NAME
-
- gcloud alpha bigtable instances tables restore - restore a Cloud Bigtable backup to a new table
- SYNOPSIS
-
-
gcloud alpha bigtable instances tables restore(--destination=DESTINATION:--destination-instance=DESTINATION_INSTANCE) (--source=SOURCE:--source-cluster=SOURCE_CLUSTER--source-instance=SOURCE_INSTANCE) [--async] [--[no-]deletion-protection] [--enable-automated-backup|--automated-backup-locations=[LOCATION,…]--automated-backup-retention-period=AUTOMATED_BACKUP_RETENTION_PERIOD] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)This command restores a Cloud Bigtable backup to a new table. - EXAMPLES
-
To restore table 'table2' from backup 'backup1', run:
gcloud alpha bigtable instances tables restore --source-instance=instance1 --source-cluster=cluster1 --source=backup1 --destination-instance=instance1 --destination=table2To restore table 'table2' from backup 'backup1' in a different project, run:
gcloud alpha bigtable instances tables restore --source=projects/project1/instances/instance1/clusters/cluster1/backups/backup1 --destination=projects/project2/instances/instance2/tables/table2 - REQUIRED FLAGS
-
-
Table resource - The destination to restore to. The arguments in this group can
be used to specify the attributes of this resource. (NOTE) Some attributes are
not given arguments in this group but can be set in other ways.
To set the
projectattribute:-
provide the argument
--destinationon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
--destination=DESTINATION-
ID of the table or fully qualified identifier for the table.
To set the
destinationattribute:-
provide the argument
--destinationon the command line.
This flag argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--destination-instance=DESTINATION_INSTANCE-
Name of the Bigtable instance.
To set the
instanceattribute:-
provide the argument
--destinationon the command line with a fully specified name; -
provide the argument
--destination-instanceon the command line; -
provide the argument
--source-instanceon the command line.
-
provide the argument
-
provide the argument
-
Backup resource - The source to restore from. The arguments in this group can be
used to specify the attributes of this resource. (NOTE) Some attributes are not
given arguments in this group but can be set in other ways.
To set the
projectattribute:-
provide the argument
--sourceon the command line with a fully specified name; -
provide the argument
--projecton the command line; -
set the property
core/project.
This must be specified.
--source=SOURCE-
ID of the backup or fully qualified identifier for the backup.
To set the
sourceattribute:-
provide the argument
--sourceon the command line.
This flag argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--source-cluster=SOURCE_CLUSTER-
Name of the Bigtable cluster.
To set the
clusterattribute:-
provide the argument
--sourceon the command line with a fully specified name; -
provide the argument
--source-clusteron the command line.
-
provide the argument
--source-instance=SOURCE_INSTANCE-
Name of the Bigtable instance.
To set the
instanceattribute:-
provide the argument
--sourceon the command line with a fully specified name; -
provide the argument
--source-instanceon the command line; -
provide the argument
--destination-instanceon the command line.
-
provide the argument
-
provide the argument
-
Table resource - The destination to restore to. The arguments in this group can
be used to specify the attributes of this resource. (NOTE) Some attributes are
not given arguments in this group but can be set in other ways.
- OPTIONAL FLAGS
-
--async- Return immediately, without waiting for the operation in progress to complete.
--[no-]deletion-protection-
Indicates whether the restored table is protected against deletion. Defaults to
disabled if not specified. Use
--deletion-protectionto enable and--no-deletion-protectionto disable. -
At most one of these can be specified:
--enable-automated-backup- Once set, enables the default automated backup policy (retention_period=7d, frequency=1d) for the table. Defaults to no automated backup policy if omitted.
-
Or at least one of these can be specified:
- Group for automated backup policy parameters.
--automated-backup-locations=[LOCATION,…]-
List of Cloud Bigtable zones where you can create automated backups. If empty,
automated backups will be created in all zones of the instance. Locations are in
the format
projects/{project}/locations/{zone}. Setting this flag enables automated backup for the table. If automated backup retention period is not specified, it defaults to 7 days. --automated-backup-retention-period=AUTOMATED_BACKUP_RETENTION_PERIOD-
The retention period of automated backup in the format of
30dfor 30 days. Min retention period is3dand max is90d. Setting this flag enables automated backup for the table. If automated backup retention period is not specified, it defaults to 7 days.
- 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 helpfor 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. These variants are also available:
gcloud bigtable instances tables restoregcloud beta bigtable instances tables restore
gcloud alpha bigtable instances tables restore
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-09-22 UTC.