Cloud Bigtable V2 Client - Class PrepareQueryRequest (2.19.2)

Version latest

• 2.19.2 (latest)
• 2.19.1
• 2.18.0
• 2.17.1
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.1
• 2.9.1
• 2.8.0
• 2.7.0
• 2.6.3
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.1
• 2.1.0
• 2.0.1
• 1.32.1
• 1.31.1
• 1.30.0
• 1.29.2
• 1.28.3
• 1.27.0
• 1.26.2
• 1.25.0
• 1.24.1
• 1.23.0
• 1.22.2
• 1.21.1
• 1.20.3

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.
↳ query	string Required. The query string.
↳ proto_format	ProtoFormat Protocol buffer format as described by ProtoSchema and ProtoRows messages.
↳ param_types	array|Google\Protobuf\Internal\MapField 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.

Returns
Type	Description
ProtoFormat|null

hasProtoFormat

setProtoFormat

Protocol buffer format as described by ProtoSchema and ProtoRows messages.

Parameter
Name	Description
var	ProtoFormat

Returns
Type	Description
$this

getParamTypes

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.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setParamTypes

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.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getDataFormat

Returns
Type	Description
string

static::build

Parameters
Name	Description
instanceName	string 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.

Returns
Type	Description
PrepareQueryRequest

static::buildFromInstanceNameQueryAppProfileId

Parameters
Name	Description
instanceName	string 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.

Returns
Type	Description
PrepareQueryRequest