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 \ V2Methods
__construct
Constructor.
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
↳ param_types
array| Google\Protobuf\Internal\MapField
Required. param_types
is a map of parameter identifier strings to their Type
s. 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>
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>
var
string
$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.
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.
var
string
$this
getQuery
Required. The query string.
string
setQuery
Required. The query string.
var
string
$this
getProtoFormat
Protocol buffer format as described by ProtoSchema and ProtoRows messages.
hasProtoFormat
setProtoFormat
Protocol buffer format as described by ProtoSchema and ProtoRows messages.
$this
getParamTypes
Required. param_types
is a map of parameter identifier strings to their Type
s.
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.
setParamTypes
Required. param_types
is a map of parameter identifier strings to their Type
s.
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.
$this
getDataFormat
string
static::build
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.
static::buildFromInstanceNameQueryAppProfileId
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.
