Method: projects.instances.tables.checkConsistency

Checks replication consistency based on a consistency token, that is, if replication has caught up based on the conditions specified in the token and the check request.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The unique name of the Table for which to check replication consistency. Values are of the form projects/{project}/instances/{instance}/tables/{table}.

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

  • bigtable.tables.checkConsistency

Request body

The request body contains data with the following structure:

JSON representation 
{
  "consistencyToken": string,

  // Union field mode can be only one of the following:
  "standardReadRemoteWrites": {
    object (StandardReadRemoteWrites)
  },
  "dataBoostReadLocalWrites": {
    object (DataBoostReadLocalWrites)
  }
  // End of list of possible types for union field mode.
}
Fields
consistencyToken

string

Required. The token created using tables.generateConsistencyToken for the Table.
Union field mode. Which type of read needs to consistently observe which type of write? Default: standard_read_remote_writes mode can be only one of the following:
standardReadRemoteWrites

object (StandardReadRemoteWrites)

Checks that reads using an app profile with StandardIsolation can see all writes committed before the token was created, even if the read and write target different clusters.
dataBoostReadLocalWrites

object (DataBoostReadLocalWrites)

Checks that reads using an app profile with DataBoostIsolationReadOnly can see all writes committed before the token was created, but only if the read and write target the same cluster.

Response body

Response message for google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency

If successful, the response body contains data with the following structure:

JSON representation 
{
  "consistent": boolean
}
Fields
consistent

boolean

True only if the token is consistent. A token is consistent if replication has caught up with the restrictions specified in the request.

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.

StandardReadRemoteWrites

This type has no fields.

Checks that all writes before the consistency token was generated are replicated in every cluster and readable.

DataBoostReadLocalWrites

This type has no fields.

Checks that all writes before the consistency token was generated in the same cluster are readable by Databoost.