Method: projects.instances.tables.modifyColumnFamilies

Performs a series of column family modifications on the specified table. Either all or none of the modifications will occur before this method returns, but data requests received prior to that point may see a table where only some modifications have taken effect.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The unique name of the table whose families should be modified. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

Authorization requires the following IAM permission on the specified resource name:

  • bigtable.tables.update

Request body

The request body contains data with the following structure:

JSON representation 
{
  "modifications": [
    {
      object (Modification)
    }
  ],
  "ignoreWarnings": boolean
}
Fields
modifications[]

object (Modification)

Required. Modifications to be atomically applied to the specified table's families. Entries are applied in order, meaning that earlier modifications can be masked by later ones (in the case of repeated updates to the same family, for example).
ignoreWarnings

boolean

Optional. If true, ignore safety checks when modifying the column families.

Response body

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

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.

Modification

A create, update, or delete of a particular column family.

JSON representation 
{
  "id": string,
  "updateMask": string,

  // Union field mod can be only one of the following:
  "create": {
    object (ColumnFamily)
  },
  "update": {
    object (ColumnFamily)
  },
  "drop": boolean
  // End of list of possible types for union field mod.
}
Fields
id

string

The ID of the column family to be modified.
updateMask

string (FieldMask format)

Optional. A mask specifying which fields (e.g. gcRule) in the update mod should be updated, ignored for other modification types. If unset or empty, we treat it as updating gcRule to be backward compatible.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".
Union field mod. Column family modifications. mod can be only one of the following:
create

object (ColumnFamily)

Create a new column family with the specified schema, or fail if one already exists with the given ID.
update

object (ColumnFamily)

Update an existing column family to the specified schema, or fail if no column family exists with the given ID.
drop

boolean

Drop (delete) the column family with the given ID, or fail if no such family exists.