gcloud bigtable instances tables update

Stay organized with collections Save and categorize content based on your preferences.

gcloud bigtable instances tables update - update an existing Cloud Bigtable table

gcloud 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] [GCLOUD_WIDE_FLAG …]

gcloud bigtable instances tables update my-table --instance=my-instance --deletion-protection

To disable deletion protection, run:

gcloud bigtable instances 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 instances tables update my-table --instance=my-instance --change-stream-retention-period=1d

To disable a change stream, run:

gcloud bigtable instances tables update my-table --instance=my-instance --clear-change-stream-retention-period

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:

gcloud bigtable instances tables update my-table --instance=my-instance --enable-automated-backup

To disable automated backup: run:

gcloud bigtable instances tables update my-table --instance=my-instance --disable-automated-backup

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

gcloud bigtable instances tables update my-table --instance=my-instance --automated-backup-retention_period=30d

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.

--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/JSON file (for example, encoding.delimitedBytes.delimiter).

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 row-key-schema-definition-file is set. It is ignored if clear-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 of 30d for 30 days. Min retention period is 3d and max is 90d. 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, this flag 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), 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.

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:

--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: field1
  type:
    bytesType:
      encoding:
        raw: {}
- fieldName: field2
  type:
    bytesType:
      encoding:
        raw: {}

Run $ gcloud help for details.