Reference documentation and code samples for the Cloud Bigtable V2 Client class PrepareQueryRequest.
Request message for Bigtable.PrepareQuery
Generated from protobuf message google.bigtable.v2.PrepareQueryRequest
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 preparing the query. Note that this app_profile_id is only used for preparing the query. The actual query execution will use the app profile specified in the ExecuteQueryRequest. If not specified, the default application profile will be used.
Required. param_types is a map of parameter identifier strings to their Types. 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 param_types["firstName"] = Bytes then @firstName will be a query parameter of type Bytes. The specific Value to be used for the query execution must be sent in ExecuteQueryRequest in the params map.
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 preparing the query. Note that
this app_profile_id is only used for preparing the query. The actual
query execution will use the app profile specified in the
ExecuteQueryRequest. If not specified, the default application profile
will be used.
Returns
Type
Description
string
setAppProfileId
Optional. This value specifies routing for preparing the query. Note that
this app_profile_id is only used for preparing the query. The actual
query execution will use the app profile specified in the
ExecuteQueryRequest. If not specified, the default application profile
will be used.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getQuery
Required. The query string.
Returns
Type
Description
string
setQuery
Required. The query string.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getProtoFormat
Protocol buffer format as described by ProtoSchema and ProtoRows
messages.
Required. param_types is a map of parameter identifier strings to their
Types.
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 param_types["firstName"] = Bytes then @firstName will be a
query parameter of type Bytes. The specific Value to be used for the
query execution must be sent in ExecuteQueryRequest in the params map.
Required. param_types is a map of parameter identifier strings to their
Types.
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 param_types["firstName"] = Bytes then @firstName will be a
query parameter of type Bytes. The specific Value to be used for the
query execution must be sent in ExecuteQueryRequest in the params map.
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.
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.
appProfileId
string
Optional. This value specifies routing for preparing the query. Note that
this app_profile_id is only used for preparing the query. The actual
query execution will use the app profile specified in the
ExecuteQueryRequest. 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-08-28 UTC."],[],[],null,["# Cloud Bigtable V2 Client - Class PrepareQueryRequest (2.17.1)\n\nVersion latestkeyboard_arrow_down\n\n- [2.17.1 (latest)](/php/docs/reference/cloud-bigtable/latest/V2.PrepareQueryRequest)\n- [2.17.0](/php/docs/reference/cloud-bigtable/2.17.0/V2.PrepareQueryRequest)\n- [2.16.0](/php/docs/reference/cloud-bigtable/2.16.0/V2.PrepareQueryRequest)\n- [2.15.0](/php/docs/reference/cloud-bigtable/2.15.0/V2.PrepareQueryRequest)\n- [2.14.0](/php/docs/reference/cloud-bigtable/2.14.0/V2.PrepareQueryRequest)\n- [2.13.0](/php/docs/reference/cloud-bigtable/2.13.0/V2.PrepareQueryRequest)\n- [2.12.0](/php/docs/reference/cloud-bigtable/2.12.0/V2.PrepareQueryRequest)\n- [2.11.1](/php/docs/reference/cloud-bigtable/2.11.1/V2.PrepareQueryRequest)\n- [2.9.1](/php/docs/reference/cloud-bigtable/2.9.1/V2.PrepareQueryRequest)\n- [2.8.0](/php/docs/reference/cloud-bigtable/2.8.0/V2.PrepareQueryRequest)\n- [2.7.0](/php/docs/reference/cloud-bigtable/2.7.0/V2.PrepareQueryRequest)\n- [2.6.3](/php/docs/reference/cloud-bigtable/2.6.3/V2.PrepareQueryRequest)\n- [2.5.0](/php/docs/reference/cloud-bigtable/2.5.0/V2.PrepareQueryRequest)\n- [2.4.0](/php/docs/reference/cloud-bigtable/2.4.0/V2.PrepareQueryRequest)\n- [2.3.0](/php/docs/reference/cloud-bigtable/2.3.0/V2.PrepareQueryRequest)\n- [2.2.1](/php/docs/reference/cloud-bigtable/2.2.1/V2.PrepareQueryRequest)\n- [2.1.0](/php/docs/reference/cloud-bigtable/2.1.0/V2.PrepareQueryRequest)\n- [2.0.1](/php/docs/reference/cloud-bigtable/2.0.1/V2.PrepareQueryRequest)\n- [1.32.1](/php/docs/reference/cloud-bigtable/1.32.1/V2.PrepareQueryRequest)\n- [1.31.1](/php/docs/reference/cloud-bigtable/1.31.1/V2.PrepareQueryRequest)\n- [1.30.0](/php/docs/reference/cloud-bigtable/1.30.0/V2.PrepareQueryRequest)\n- [1.29.2](/php/docs/reference/cloud-bigtable/1.29.2/V2.PrepareQueryRequest)\n- [1.28.3](/php/docs/reference/cloud-bigtable/1.28.3/V2.PrepareQueryRequest)\n- [1.27.0](/php/docs/reference/cloud-bigtable/1.27.0/V2.PrepareQueryRequest)\n- [1.26.2](/php/docs/reference/cloud-bigtable/1.26.2/V2.PrepareQueryRequest)\n- [1.25.0](/php/docs/reference/cloud-bigtable/1.25.0/V2.PrepareQueryRequest)\n- [1.24.1](/php/docs/reference/cloud-bigtable/1.24.1/V2.PrepareQueryRequest)\n- [1.23.0](/php/docs/reference/cloud-bigtable/1.23.0/V2.PrepareQueryRequest)\n- [1.22.2](/php/docs/reference/cloud-bigtable/1.22.2/V2.PrepareQueryRequest)\n- [1.21.1](/php/docs/reference/cloud-bigtable/1.21.1/V2.PrepareQueryRequest)\n- [1.20.3](/php/docs/reference/cloud-bigtable/1.20.3/V2.PrepareQueryRequest) \nReference documentation and code samples for the Cloud Bigtable V2 Client class PrepareQueryRequest.\n\nRequest message for Bigtable.PrepareQuery\n\nGenerated from protobuf message `google.bigtable.v2.PrepareQueryRequest`\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 preparing the query. Note that\nthis `app_profile_id` is only used for preparing the query. The actual\nquery execution will use the app profile specified in the\n`ExecuteQueryRequest`. If not specified, the `default` application profile\nwill be used.\n\n### setAppProfileId\n\nOptional. This value specifies routing for preparing the query. Note that\nthis `app_profile_id` is only used for preparing the query. The actual\nquery execution will use the app profile specified in the\n`ExecuteQueryRequest`. If not specified, the `default` application profile\nwill be used.\n\n### getQuery\n\nRequired. The query string.\n\n### setQuery\n\nRequired. The query string.\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### getParamTypes\n\nRequired. `param_types` is a map of parameter identifier strings to their\n`Type`s.\n\nIn query string, a parameter placeholder consists of the\n`@` character followed by the parameter name (for example, `@firstName`) in\nthe query string.\nFor example, if param_types\\[\"firstName\"\\] = Bytes then @firstName will be a\nquery parameter of type Bytes. The specific `Value` to be used for the\nquery execution must be sent in `ExecuteQueryRequest` in the `params` map.\n\n### setParamTypes\n\nRequired. `param_types` is a map of parameter identifier strings to their\n`Type`s.\n\nIn query string, a parameter placeholder consists of the\n`@` character followed by the parameter name (for example, `@firstName`) in\nthe query string.\nFor example, if param_types\\[\"firstName\"\\] = Bytes then @firstName will be a\nquery parameter of type Bytes. The specific `Value` to be used for the\nquery execution must be sent in `ExecuteQueryRequest` in the `params` map.\n\n### getDataFormat\n\n### static::build\n\n### static::buildFromInstanceNameQueryAppProfileId"]]
