gcloud alpha bigtable instances tables update

NAME
gcloud alpha bigtable instances tables update - update an existing Cloud Bigtable table
SYNOPSIS
gcloud alpha bigtable instances tables update(TABLE :--instance=INSTANCE)[--async][--deletion-protection][--row-key-schema-pre-encoded-bytes][--automated-backup-retention-period=AUTOMATED_BACKUP_RETENTION_PERIOD    |--disable-automated-backup    |--enable-automated-backup][--change-stream-retention-period=CHANGE_STREAM_RETENTION_PERIOD    |--clear-change-stream-retention-period][--clear-row-key-schema    |--row-key-schema-definition-file=ROW_KEY_SCHEMA_DEFINITION_FILE][--clear-tiered-storage-config    |--tiered-storage-infrequent-access-older-than=TIERED_STORAGE_INFREQUENT_ACCESS_OLDER_THAN][GCLOUD_WIDE_FLAG]
DESCRIPTION
(ALPHA) Update an existing new Cloud Bigtable table with thespecified configuration.
EXAMPLES
To enable deletion protection, run:
gcloudalphabigtableinstancestablesupdatemy-table--instance=my-instance--deletion-protection

To disable deletion protection, run:

gcloudalphabigtableinstancestablesupdatemy-table--instance=my-instance--no-deletion-protection

To enable a change stream with a retention period of 1 day, or to update yourtable's change stream retention period to 1 day, run:

gcloudalphabigtableinstancestablesupdatemy-table--instance=my-instance--change-stream-retention-period=1d

To disable a change stream, run:

gcloudalphabigtableinstancestablesupdatemy-table--instance=my-instance--clear-change-stream-retention-period

To enable the default automated backup policy on a table, or update a table touse the default policy (retention_period=7d, frequency=1d), run:

gcloudalphabigtableinstancestablesupdatemy-table--instance=my-instance--enable-automated-backup

To disable automated backup: run:

gcloudalphabigtableinstancestablesupdatemy-table--instance=my-instance--disable-automated-backup

To enable or update a custom automated backup policy and configure it to retainbackups for 30 days, run:

gcloudalphabigtableinstancestablesupdatemy-table--instance=my-instance--automated-backup-retention_period=30d
POSITIONAL ARGUMENTS
Table resource - Cloud Bigtable table to update. The arguments in this group canbe used to specify the attributes of this resource. (NOTE) Some attributes arenot given arguments in this group but can be set in other ways.

To set theproject attribute:

  • provide the argumenttable on the command line with a fullyspecified name;
  • provide the argument--project on the command line;
  • set the propertycore/project.

This must be specified.

TABLE
ID of the table or fully qualified identifier for the table.

To set thetable attribute:

  • provide the argumenttable on the command line.

This positional argument must be specified if any of the other arguments in thisgroup are specified.

--instance=INSTANCE
Name of the Bigtable instance.

To set theinstance attribute:

  • provide the argumenttable on the command line with a fullyspecified 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.
--row-key-schema-pre-encoded-bytes
By default, Base64 encoding is applied to all binary fields in the YAML/JSONfile (for example,encoding.delimitedBytes.delimiter).

Use this to indicate that all binary fields are already encoded in the YAML/JSONfile and should not be encoded again.

This field is only used whenrow-key-schema-definition-file is set.It is ignored ifclear-row-key-schema is set.

At most one of these can be specified:
--automated-backup-retention-period=AUTOMATED_BACKUP_RETENTION_PERIOD
The retention period of automated backup in the format of30d for30 days. Min retention period is3d and max is90d.Setting this flag will enable automated backup for the table.
--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=7d,frequency=1d) for the table. Note: If a table has automated backup enabled, thisflag resets it to the default policy.
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), andseconds (s). If not already specified, enables a change stream for the table.Examples:5d or48h.
--clear-change-stream-retention-period
This disables the change stream and eventually removes the change stream data.
Whether to update or clear the row key schema in the updated table. Only one ofthese flags can be set.At most one of these can be specified:
--clear-row-key-schema
Whether to clear the row key schema in the updated table.
--row-key-schema-definition-file=ROW_KEY_SCHEMA_DEFINITION_FILE
The row key schema for the table. The schema is defined in a YAML or JSON file,equivalent to the StructType protobuf message.

Example YAML:

encoding:delimitedBytes:delimiter:'#'fields:-fieldName:field1type:bytesType:encoding:raw:{}-fieldName:field2type:bytesType:encoding:raw:{}
At most one of these can be specified:
--clear-tiered-storage-config
Disables the tiered storage config.
--tiered-storage-infrequent-access-older-than=TIERED_STORAGE_INFREQUENT_ACCESS_OLDER_THAN
The age at which data should be moved to infrequent access storage.

See$gcloud topicdatetimes for information on absolute duration 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 thebigtableadmin/v2 API. The full documentationfor this API can be found at:https://cloud.google.com/bigtable/
NOTES
This command is currently in alpha and might change without notice. If thiscommand fails with API permission errors despite specifying the correct project,you might be trying to access an API with an invitation-only early accessallowlist. These variants are also available:
gcloudbigtableinstancestablesupdate
gcloudbetabigtableinstancestablesupdate

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-07-22 UTC.