Stay organized with collections
Save and categorize content based on your preferences.
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
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_writesmode can be only one of the following:
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-05-08 UTC."],[[["\u003cp\u003eChecks replication consistency by verifying if replication has caught up based on the conditions specified in the provided consistency token.\u003c/p\u003e\n"],["\u003cp\u003eRequires a consistency token generated using \u003ccode\u003etables.generateConsistencyToken\u003c/code\u003e to perform the consistency check.\u003c/p\u003e\n"],["\u003cp\u003eSupports two consistency modes: \u003ccode\u003estandardReadRemoteWrites\u003c/code\u003e, which checks consistency across all clusters, and \u003ccode\u003edataBoostReadLocalWrites\u003c/code\u003e, which checks consistency within the same cluster.\u003c/p\u003e\n"],["\u003cp\u003eA successful check returns a boolean \u003ccode\u003econsistent\u003c/code\u003e value, indicating whether the replication is consistent based on the token and request specifications.\u003c/p\u003e\n"],["\u003cp\u003eThe endpoint to verify replication consistency is a \u003ccode\u003ePOST\u003c/code\u003e request to \u003ccode\u003ehttps://bigtableadmin.googleapis.com/v2/{name=projects/*/instances/*/tables/*}:checkConsistency\u003c/code\u003e.\u003c/p\u003e\n"]]],[],null,["# Method: projects.instances.tables.checkConsistency\n\nChecks 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.\n\n### HTTP request\n\n`POST https://bigtableadmin.googleapis.com/v2/{name=projects/*/instances/*/tables/*}:checkConsistency`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n### Request body\n\nThe request body contains data with the following structure:\n\n### Response body\n\nResponse message for [google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency](/bigtable/docs/reference/admin/rest/v2/projects.instances.tables/checkConsistency#google.bigtable.admin.v2.BigtableTableAdmin.CheckConsistency)\n\nIf successful, the response body contains data with the following structure:\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/bigtable.admin`\n- `https://www.googleapis.com/auth/bigtable.admin.table`\n- `https://www.googleapis.com/auth/cloud-bigtable.admin`\n- `https://www.googleapis.com/auth/cloud-bigtable.admin.table`\n- `https://www.googleapis.com/auth/cloud-platform`\n\nFor more information, see the [Authentication Overview](/docs/authentication#authorization-gcp).\n\nStandardReadRemoteWrites\n------------------------\n\nThis type has no fields.\nChecks that all writes before the consistency token was generated are replicated in every cluster and readable.\n\nDataBoostReadLocalWrites\n------------------------\n\nThis type has no fields.\nChecks that all writes before the consistency token was generated in the same cluster are readable by Databoost."]]
