Reference documentation and code samples for the Cloud Bigtable V2 Client class ExecuteQueryRequest.
Request message for Bigtable.ExecuteQuery
Generated from protobuf message google.bigtable.v2.ExecuteQueryRequest
Namespace
Google \ Cloud \ Bigtable \ V2
Methods
__construct
Constructor.
Parameters
Name
Description
data
array
Optional. Data for populating the Message object.
↳ instance_name
string
Required. The unique name of the instance against which the query should be executed. Values are of the form projects/<project>/instances/<instance>
↳ app_profile_id
string
Optional. This value specifies routing for replication. If not specified, the default application profile will be used.
↳ query
string
Required. The query string. Exactly one of query and prepared_query is required. Setting both or neither is an INVALID_ARGUMENT.
↳ prepared_query
string
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.
↳ resume_token
string
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.
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.
getInstanceName
Required. The unique name of the instance against which the query should be
executed.
Values are of the form projects/<project>/instances/<instance>
Returns
Type
Description
string
setInstanceName
Required. The unique name of the instance against which the query should be
executed.
Values are of the form projects/<project>/instances/<instance>
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getAppProfileId
Optional. This value specifies routing for replication. If not specified,
the default application profile will be used.
Returns
Type
Description
string
setAppProfileId
Optional. This value specifies routing for replication. If not specified,
the default application profile will be used.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getQuery
Required. The query string.
Exactly one of query and prepared_query is required. Setting both
or neither is an INVALID_ARGUMENT.
Returns
Type
Description
string
setQuery
Required. The query string.
Exactly one of query and prepared_query is required. Setting both
or neither is an INVALID_ARGUMENT.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getPreparedQuery
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.
Returns
Type
Description
string
setPreparedQuery
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getProtoFormat
Protocol buffer format as described by ProtoSchema and ProtoRows
messages.
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.
Returns
Type
Description
string
setResumeToken
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.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getParams
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.
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.
Required. The unique name of the instance against which the query should be
executed.
Values are of the form projects/<project>/instances/<instance>
Please see BigtableClient::instanceName() for help formatting this field.
query
string
Required. The query string.
Exactly one of query and prepared_query is required. Setting both
or neither is an INVALID_ARGUMENT.
Required. The unique name of the instance against which the query should be
executed.
Values are of the form projects/<project>/instances/<instance>
Please see BigtableClient::instanceName() for help formatting this field.
query
string
Required. The query string.
Exactly one of query and prepared_query is required. Setting both
or neither is an INVALID_ARGUMENT.
appProfileId
string
Optional. This value specifies routing for replication. If not specified,
the default application profile will be used.
[[["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-09-04 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class ExecuteQueryRequest (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/V2.ExecuteQueryRequest)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/V2.ExecuteQueryRequest)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/V2.ExecuteQueryRequest)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/V2.ExecuteQueryRequest)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/V2.ExecuteQueryRequest)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/V2.ExecuteQueryRequest)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/V2.ExecuteQueryRequest)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/V2.ExecuteQueryRequest)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/V2.ExecuteQueryRequest)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/V2.ExecuteQueryRequest)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/V2.ExecuteQueryRequest)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/V2.ExecuteQueryRequest)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/V2.ExecuteQueryRequest)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/V2.ExecuteQueryRequest)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/V2.ExecuteQueryRequest)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/V2.ExecuteQueryRequest)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/V2.ExecuteQueryRequest)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/V2.ExecuteQueryRequest)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/V2.ExecuteQueryRequest)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/V2.ExecuteQueryRequest)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/V2.ExecuteQueryRequest)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/V2.ExecuteQueryRequest)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/V2.ExecuteQueryRequest)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/V2.ExecuteQueryRequest)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/V2.ExecuteQueryRequest)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/V2.ExecuteQueryRequest)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/V2.ExecuteQueryRequest)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/V2.ExecuteQueryRequest)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/V2.ExecuteQueryRequest)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/V2.ExecuteQueryRequest)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/V2.ExecuteQueryRequest) \nReference documentation and code samples for the Cloud Bigtable V2 Client class ExecuteQueryRequest.\n\nRequest message for Bigtable.ExecuteQuery\n\nGenerated from protobuf message `google.bigtable.v2.ExecuteQueryRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Bigtable \\\\ V2\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getInstanceName\n\nRequired. The unique name of the instance against which the query should be\nexecuted.\n\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`\n\n### setInstanceName\n\nRequired. The unique name of the instance against which the query should be\nexecuted.\n\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`\n\n### getAppProfileId\n\nOptional. This value specifies routing for replication. If not specified,\nthe `default` application profile will be used.\n\n### setAppProfileId\n\nOptional. This value specifies routing for replication. If not specified,\nthe `default` application profile will be used.\n\n### getQuery\n\nRequired. The query string.\n\nExactly one of `query` and `prepared_query` is required. Setting both\nor neither is an `INVALID_ARGUMENT`.\n\n### setQuery\n\nRequired. The query string.\n\nExactly one of `query` and `prepared_query` is required. Setting both\nor neither is an `INVALID_ARGUMENT`.\n\n### getPreparedQuery\n\nA prepared query that was returned from `PrepareQueryResponse`.\n\nExactly one of `query` and `prepared_query` is required. Setting both\nor neither is an `INVALID_ARGUMENT`.\nSetting this field also places restrictions on several other fields:\n\n- `data_format` must be empty.\n- `validate_only` must be false.\n- `params` must match the `param_types` set in the `PrepareQueryRequest`.\n\n### setPreparedQuery\n\nA prepared query that was returned from `PrepareQueryResponse`.\n\nExactly one of `query` and `prepared_query` is required. Setting both\nor neither is an `INVALID_ARGUMENT`.\nSetting this field also places restrictions on several other fields:\n\n- `data_format` must be empty.\n- `validate_only` must be false.\n- `params` must match the `param_types` set in the `PrepareQueryRequest`.\n\n### getProtoFormat\n\nProtocol buffer format as described by ProtoSchema and ProtoRows\nmessages.\n\n### hasProtoFormat\n\n### setProtoFormat\n\nProtocol buffer format as described by ProtoSchema and ProtoRows\nmessages.\n\n### getResumeToken\n\nOptional. If this request is resuming a previously interrupted query\nexecution, `resume_token` should be copied from the last\nPartialResultSet yielded before the interruption. Doing this\nenables the query execution to resume where the last one left\noff.\n\nThe rest of the request parameters must exactly match the\nrequest that yielded this token. Otherwise the request will fail.\n\n### setResumeToken\n\nOptional. If this request is resuming a previously interrupted query\nexecution, `resume_token` should be copied from the last\nPartialResultSet yielded before the interruption. Doing this\nenables the query execution to resume where the last one left\noff.\n\nThe rest of the request parameters must exactly match the\nrequest that yielded this token. Otherwise the request will fail.\n\n### getParams\n\nRequired. params contains string type keys and Bigtable type values that\nbind to placeholders in the query string. In query string, a parameter\nplaceholder consists of the\n`@` character followed by the parameter name (for example, `@firstName`) in\nthe query string.\n\nFor example, if\n`params[\"firstName\"] = bytes_value: \"foo\" type {bytes_type }}`\nthen `@firstName` will be replaced with googlesql bytes value \"foo\" in the\nquery string during query evaluation.\nIf `Value.kind` is not set, the value is treated as a NULL value of the\ngiven type. For example, if\n`params[\"firstName\"] = type {string_type }}`\nthen `@firstName` will be replaced with googlesql null string.\nIf `query` is set, any empty `Value.type` in the map will be rejected with\n`INVALID_ARGUMENT`.\nIf `prepared_query` is set, any empty `Value.type` in the map will be\ninferred from the `param_types` in the `PrepareQueryRequest`. Any non-empty\n`Value.type` must match the corresponding `param_types` entry, or be\nrejected with `INVALID_ARGUMENT`.\n\n### setParams\n\nRequired. params contains string type keys and Bigtable type values that\nbind to placeholders in the query string. In query string, a parameter\nplaceholder consists of the\n`@` character followed by the parameter name (for example, `@firstName`) in\nthe query string.\n\nFor example, if\n`params[\"firstName\"] = bytes_value: \"foo\" type {bytes_type }}`\nthen `@firstName` will be replaced with googlesql bytes value \"foo\" in the\nquery string during query evaluation.\nIf `Value.kind` is not set, the value is treated as a NULL value of the\ngiven type. For example, if\n`params[\"firstName\"] = type {string_type }}`\nthen `@firstName` will be replaced with googlesql null string.\nIf `query` is set, any empty `Value.type` in the map will be rejected with\n`INVALID_ARGUMENT`.\nIf `prepared_query` is set, any empty `Value.type` in the map will be\ninferred from the `param_types` in the `PrepareQueryRequest`. Any non-empty\n`Value.type` must match the corresponding `param_types` entry, or be\nrejected with `INVALID_ARGUMENT`.\n\n### getDataFormat\n\n### static::build\n\n### static::buildFromInstanceNameQueryAppProfileId"]]
