Method: projects.instances.tables.patch

Updates a specified table.

HTTP request

PATCH https://bigtableadmin.googleapis.com/v2/{table.name=projects/*/instances/*/tables/*}

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
table.name

string

The unique name of the table. Values are of the form projects/{project}/instances/{instance}/tables/[_a-zA-Z0-9][-_.a-zA-Z0-9]*. Views: NAME_ONLY, SCHEMA_VIEW, REPLICATION_VIEW, STATS_VIEW, FULL

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. The list of fields to update. A mask specifying which fields (e.g. changeStreamConfig) in the table field should be updated. This mask is relative to the table field, not to the request message. The wildcard (*) path is currently not supported. Currently tables.patch is only supported for the following fields:

  • changeStreamConfig
  • changeStreamConfig.retention_period
  • deletionProtection
  • automatedBackupPolicy
  • automatedBackupPolicy.retention_period
  • automatedBackupPolicy.frequency
  • automatedBackupPolicy.locations
  • rowKeySchema

If columnFamilies is set in updateMask, it will return an UNIMPLEMENTED error.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
ignoreWarnings

boolean

Optional. If true, ignore safety checks when updating the table.

Request body

The request body contains an instance of Table.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/bigtable.admin
  • https://www.googleapis.com/auth/bigtable.admin.table
  • https://www.googleapis.com/auth/cloud-bigtable.admin
  • https://www.googleapis.com/auth/cloud-bigtable.admin.table
  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.