Google Bigtable v2 API - Class ExecuteQueryRequest (3.17.0)

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

Reference documentation and code samples for the Google Bigtable v2 API class ExecuteQueryRequest.

Request message for Bigtable.ExecuteQuery

Optional. This value specifies routing for replication. If not specified, the default application profile will be used.

Required. The unique name of the instance against which the query should be executed. Values are of the form projects/<project>/instances/<instance>

InstanceName-typed view over the InstanceName resource name property.

Required. params contains string type keys and Bigtable type values that bind to placeholders in the query string. In query string, a parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName) in the query string.

For example, if params["firstName"] = bytes_value: "foo" type {bytes_type {}} then @firstName will be replaced with googlesql bytes value "foo" in the query string during query evaluation.

If Value.kind is not set, the value is treated as a NULL value of the given type. For example, if params["firstName"] = type {string_type {}} then @firstName will be replaced with googlesql null string.

If query is set, any empty Value.type in the map will be rejected with INVALID_ARGUMENT.

If prepared_query is set, any empty Value.type in the map will be inferred from the param_types in the PrepareQueryRequest. Any non-empty Value.type must match the corresponding param_types entry, or be rejected with INVALID_ARGUMENT.

A prepared query that was returned from PrepareQueryResponse.

Exactly one of query and prepared_query is required. Setting both or neither is an INVALID_ARGUMENT.

Setting this field also places restrictions on several other fields:

• data_format must be empty.
• validate_only must be false.
• params must match the param_types set in the PrepareQueryRequest.

Protocol buffer format as described by ProtoSchema and ProtoRows messages.

Required. The query string.

Exactly one of query and prepared_query is required. Setting both or neither is an INVALID_ARGUMENT.

Optional. If this request is resuming a previously interrupted query execution, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the query execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token. Otherwise the request will fail.