mirror of
https://github.com/imjasonh/gcloud-help
synced 2026-07-08 18:45:13 +00:00
124 lines
4.3 KiB
Text
124 lines
4.3 KiB
Text
NAME
|
|
gcloud bigtable tables update - update an existing Cloud Bigtable table
|
|
|
|
SYNOPSIS
|
|
gcloud bigtable tables update (TABLE : --instance=INSTANCE) [--async]
|
|
[--deletion-protection] [--disable-automated-backup]
|
|
[--enable-automated-backup]
|
|
[--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD
|
|
| --clear-change-stream-retention-period] [GCLOUD_WIDE_FLAG ...]
|
|
|
|
DESCRIPTION
|
|
Update an existing new Cloud Bigtable table with the specified
|
|
configuration.
|
|
|
|
EXAMPLES
|
|
To enable deletion protection, run:
|
|
|
|
$ gcloud bigtable tables update my-table --instance=my-instance \
|
|
--deletion-protection
|
|
|
|
To disable deletion protection, run:
|
|
|
|
$ gcloud bigtable tables update my-table --instance=my-instance \
|
|
--no-deletion-protection
|
|
|
|
To enable a change stream with a retention period of 1 day, or to update
|
|
your table's change stream retention period to 1 day, run:
|
|
|
|
$ gcloud bigtable tables update my-table --instance=my-instance \
|
|
--change-stream-retention-period=1d
|
|
|
|
To disable a change stream, run:
|
|
|
|
$ gcloud bigtable tables update my-table --instance=my-instance \
|
|
--clear-change-stream-retention-period
|
|
|
|
To enable default automated backup policy (retention_period=72h,
|
|
frequency=24h), run:
|
|
|
|
$ gcloud bigtable tables update my-table --instance=my-instance \
|
|
--enable-automated-backup
|
|
|
|
To disable automated backup: run:
|
|
|
|
$ gcloud bigtable tables update my-table --instance=my-instance \
|
|
--disable-automated-backup
|
|
|
|
POSITIONAL ARGUMENTS
|
|
Table resource - Cloud Bigtable table to update. 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 table 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.
|
|
|
|
TABLE
|
|
ID of the table or fully qualified identifier for the table.
|
|
|
|
To set the table attribute:
|
|
▸ provide the argument table on the command line.
|
|
|
|
This positional argument must be specified if any of the other
|
|
arguments in this group are specified.
|
|
|
|
--instance=INSTANCE
|
|
Name of the Cloud Bigtable instance.
|
|
|
|
To set the instance attribute:
|
|
▸ provide the argument table on the command line with a fully
|
|
specified name;
|
|
▸ provide the argument --instance on the command line.
|
|
|
|
FLAGS
|
|
--async
|
|
Return immediately, without waiting for the operation in progress to
|
|
complete.
|
|
|
|
--deletion-protection
|
|
Once specified, the table is deletion protected.
|
|
|
|
--disable-automated-backup
|
|
Once set, disables automated backup policy for the table.
|
|
|
|
--enable-automated-backup
|
|
Once set, enables the default automated backup policy
|
|
(retention_period=72h, frequency=24h) for the table.
|
|
|
|
At most one of these can be specified:
|
|
|
|
--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD
|
|
The length of time to retain change stream data for the table, in the
|
|
range of [1 day, 7 days]. Acceptable units are days (d), hours (h),
|
|
minutes (m), and seconds (s). If not already specified, enables a
|
|
change stream for the table. Examples: 5d or 48h.
|
|
|
|
--clear-change-stream-retention-period
|
|
This disables the change stream and eventually removes the change
|
|
stream data.
|
|
|
|
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
|
|
These variants are also available:
|
|
|
|
$ gcloud alpha bigtable tables update
|
|
|
|
$ gcloud beta bigtable tables update
|
|
|