- NAME
-
- gcloud alpha bigtable backups create - creates a backup of a Cloud Bigtable table
- SYNOPSIS
-
-
gcloud alpha bigtable backups create
(BACKUP
:--cluster
=CLUSTER
--instance
=INSTANCE
)--table
=TABLE
(--expiration-date
=EXPIRATION_DATE
|--retention-period
=RETENTION_PERIOD
) [--async
] [--backup-type
=BACKUP_TYPE
] [--hot-to-standard-time
=HOT_TO_STANDARD_TIME
] [GCLOUD_WIDE_FLAG …
]
-
- DESCRIPTION
-
(ALPHA)
Creates a backup of a Cloud Bigtable table. - EXAMPLES
-
To create a backup 'BACKUP_NAME' asyncronously from table 'TABLE_NAME' which
expires at '2019-03-30T10:49:41Z', run:
gcloud alpha bigtable backups create BACKUP_NAME --instance=INSTANCE_NAME --cluster=CLUSTER_NAME --table=TABLE_NAME --expiration-date=2019-03-30T10:49:41Z --async
To create a backup 'BACKUP_NAME' syncronously from table 'TABLE_NAME' which expires in 2 weeks from now, run:
gcloud alpha bigtable backups create BACKUP_NAME --instance=INSTANCE_NAME --cluster=CLUSTER_NAME --table=TABLE_NAME --retention-period=2w
To create a hot backup 'BACKUP_NAME' from table 'TABLE_NAME' which expires in 2 weeks from now, run:
gcloud alpha bigtable backups create BACKUP_NAME --instance=INSTANCE_NAME --cluster=CLUSTER_NAME --table=TABLE_NAME --retention-period=2w --backup-type=HOT
To create a hot backup 'BACKUP_NAME' from table 'TABLE_NAME' which will be converted to a standard backup at '2019-03-31T10:49:41Z' and expires in 2 weeks from now, run:
gcloud alpha bigtable backups create BACKUP_NAME --instance=INSTANCE_NAME --cluster=CLUSTER_NAME --table=TABLE_NAME --retention-period=2w --backup-type=HOT --hot-to-standard-time=2019-03-31T10:49:41Z
To create a hot backup 'BACKUP_NAME' from table 'TABLE_NAME' which will be converted to a standard backup in 1 week from now and expires in 2 weeks from now, run:
gcloud alpha bigtable backups create BACKUP_NAME --instance=INSTANCE_NAME --cluster=CLUSTER_NAME --table=TABLE_NAME --retention-period=2w --backup-type=HOT --hot-to-standard-time=+P1w
- POSITIONAL ARGUMENTS
-
-
Backup resource - The Cloud Bigtable backup to create. 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
project
attribute:-
provide the argument
backup
on the command line with a fully specified name; -
provide the argument
--project
on the command line; -
set the property
core/project
.
This must be specified.
BACKUP
-
ID of the backup or fully qualified identifier for the backup.
To set the
backup
attribute:-
provide the argument
backup
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--cluster
=CLUSTER
-
Name of the Cloud Bigtable cluster.
To set the
cluster
attribute:-
provide the argument
backup
on the command line with a fully specified name; -
provide the argument
--cluster
on the command line.
-
provide the argument
--instance
=INSTANCE
-
Name of the Cloud Bigtable instance.
To set the
instance
attribute:-
provide the argument
backup
on the command line with a fully specified name; -
provide the argument
--instance
on the command line.
-
provide the argument
-
provide the argument
-
Backup resource - The Cloud Bigtable backup to create. 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.
- REQUIRED FLAGS
-
--table
=TABLE
- ID of the table from which the backup will be created.
-
Exactly one of these must be specified:
--expiration-date
=EXPIRATION_DATE
-
Absolute expiration time of the backup. From the time the request is received,
must be:
- At least 6 hours in the future
- At most 90 days in the future
See
$ gcloud topic datetimes
for information on date/time formats. --retention-period
=RETENTION_PERIOD
-
Retention period of the backup relative from now; must be:
- At least 6 hours
- At most 90 days
See
$ gcloud topic datetimes
for information on duration formats.
- OPTIONAL FLAGS
-
--async
- Return immediately, without waiting for the operation in progress to complete.
--backup-type
=BACKUP_TYPE
-
Type of the backup; whether the backup is a standard backup or a hot backup.
BACKUP_TYPE
must be one of:backup-type-unspecified
,hot
,standard
. --hot-to-standard-time
=HOT_TO_STANDARD_TIME
-
Time at which a hot backup will be converted to a standard backup relative from
now; must be:
- At least 24 hours
Only applies for hot backups. See
$ gcloud topic datetimes
for information on date/time formats.
- 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. - API REFERENCE
-
This command uses the
bigtableadmin/v2
API. The full documentation for this API can be found at: https://cloud.google.com/bigtable/ - 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 backups create
gcloud beta bigtable backups create
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 2024-10-08 UTC.