.TH "GCLOUD_ALPHA_BIGTABLE_INSTANCES_TABLES_UPDATE" 1



.SH "NAME"
.HP
gcloud alpha bigtable instances tables update \- update an existing Cloud Bigtable table



.SH "SYNOPSIS"
.HP
\f5gcloud alpha bigtable instances tables update\fR (\fITABLE\fR\ :\ \fB\-\-instance\fR=\fIINSTANCE\fR) [\fB\-\-async\fR] [\fB\-\-deletion\-protection\fR] [\fB\-\-row\-key\-schema\-pre\-encoded\-bytes\fR] [\fB\-\-automated\-backup\-retention\-period\fR=\fIAUTOMATED_BACKUP_RETENTION_PERIOD\fR\ |\ \fB\-\-disable\-automated\-backup\fR\ |\ \fB\-\-enable\-automated\-backup\fR] [\fB\-\-change\-stream\-retention\-period\fR=\fICHANGE_STREAM_RETENTION_PERIOD\fR\ |\ \fB\-\-clear\-change\-stream\-retention\-period\fR] [\fB\-\-clear\-row\-key\-schema\fR\ |\ \fB\-\-row\-key\-schema\-definition\-file\fR=\fIROW_KEY_SCHEMA_DEFINITION_FILE\fR] [\fB\-\-clear\-tiered\-storage\-config\fR\ |\ \fB\-\-tiered\-storage\-infrequent\-access\-older\-than\fR=\fITIERED_STORAGE_INFREQUENT_ACCESS_OLDER_THAN\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Update an existing new Cloud Bigtable table with the specified
configuration.



.SH "EXAMPLES"

To enable deletion protection, run:

.RS 2m
$ gcloud alpha bigtable instances tables update my\-table \e
    \-\-instance=my\-instance \-\-deletion\-protection
.RE

To disable deletion protection, run:

.RS 2m
$ gcloud alpha bigtable instances tables update my\-table \e
    \-\-instance=my\-instance \-\-no\-deletion\-protection
.RE

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:

.RS 2m
$ gcloud alpha bigtable instances tables update my\-table \e
    \-\-instance=my\-instance \-\-change\-stream\-retention\-period=1d
.RE

To disable a change stream, run:

.RS 2m
$ gcloud alpha bigtable instances tables update my\-table \e
    \-\-instance=my\-instance \-\-clear\-change\-stream\-retention\-period
.RE

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

.RS 2m
$ gcloud alpha bigtable instances tables update my\-table \e
    \-\-instance=my\-instance \-\-enable\-automated\-backup
.RE

To disable automated backup: run:

.RS 2m
$ gcloud alpha bigtable instances tables update my\-table \e
    \-\-instance=my\-instance \-\-disable\-automated\-backup
.RE

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

.RS 2m
$ gcloud alpha bigtable instances tables update my\-table \e
    \-\-instance=my\-instance \-\-automated\-backup\-retention_period=30d
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5table\fR on the command line with a fully specified
name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fITABLE\fR

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

To set the \f5table\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5table\fR on the command line.
.RE
.sp

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

.TP 2m
\fB\-\-instance\fR=\fIINSTANCE\fR

Name of the Bigtable instance.

To set the \f5instance\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5table\fR on the command line with a fully specified
name;
.IP "\(bu" 2m
provide the argument \f5\-\-instance\fR on the command line.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.

.TP 2m
\fB\-\-deletion\-protection\fR

Once specified, the table is deletion protected.

.TP 2m
\fB\-\-row\-key\-schema\-pre\-encoded\-bytes\fR

By default, Base64 encoding is applied to all binary fields in the YAML/JSON
file (for example, \f5encoding.delimitedBytes.delimiter\fR).

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

This field is only used when \f5row\-key\-schema\-definition\-file\fR is set. It
is ignored if \f5clear\-row\-key\-schema\fR is set.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-automated\-backup\-retention\-period\fR=\fIAUTOMATED_BACKUP_RETENTION_PERIOD\fR

The retention period of automated backup in the format of \f530d\fR for 30 days.
Min retention period is \f53d\fR and max is \f590d\fR. Setting this flag will
enable automated backup for the table.

.TP 2m
\fB\-\-disable\-automated\-backup\fR

Once set, disables automated backup policy for the table.

.TP 2m
\fB\-\-enable\-automated\-backup\fR

Once set, enables the default automated backup policy (retention_period=7d,
frequency=1d) for the table. Note: If a table has automated backup enabled, this
flag resets it to the default policy.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-change\-stream\-retention\-period\fR=\fICHANGE_STREAM_RETENTION_PERIOD\fR

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: \f55d\fR or \f548h\fR.

.TP 2m
\fB\-\-clear\-change\-stream\-retention\-period\fR

This disables the change stream and eventually removes the change stream data.

.RE
.sp
.TP 2m

Whether to update or clear the row key schema in the updated table. Only one of
these flags can be set.


At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-row\-key\-schema\fR

Whether to clear the row key schema in the updated table.

.TP 2m
\fB\-\-row\-key\-schema\-definition\-file\fR=\fIROW_KEY_SCHEMA_DEFINITION_FILE\fR

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:

.RS 2m
encoding:
  delimitedBytes:
    delimiter: '#'
fields:
\- fieldName: field1
  type:
    bytesType:
      encoding:
        raw: {}
\- fieldName: field2
  type:
    bytesType:
      encoding:
        raw: {}
.RE

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-tiered\-storage\-config\fR

Disables the tiered storage config.

.TP 2m
\fB\-\-tiered\-storage\-infrequent\-access\-older\-than\fR=\fITIERED_STORAGE_INFREQUENT_ACCESS_OLDER_THAN\fR

The age at which data should be moved to infrequent access storage.

See \f5$ gcloud topic datetimes\fR for information on absolute duration formats.


.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 "API REFERENCE"

This command uses the \fBbigtableadmin/v2\fR API. The full documentation for
this API can be found at: https://cloud.google.com/bigtable/



.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 bigtable instances tables update
.RE

.RS 2m
$ gcloud beta bigtable instances tables update
.RE