Cloud Bigtable V2 Client - Class ExecuteQueryRequest (2.5.0)

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.
`↳ proto_format`	`Google\Cloud\Bigtable\V2\ProtoFormat` 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.
`↳ params`	`array\|Google\Protobuf\Internal\MapField` 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. In case of Value.kind is not set, it will be set to corresponding null value in googlesql. `params["firstName"] = type {string_type }}` then `@firstName` will be replaced with googlesql null string. Value.type should always be set and no inference of type will be made from Value.kind. If Value.type is not set, we will return INVALID_ARGUMENT error.

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.

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
`Google\Cloud\Bigtable\V2\ProtoFormat\|null`

hasProtoFormat

setProtoFormat

Protocol buffer format as described by ProtoSchema and ProtoRows messages.

Parameter
Name	Description
`var`	`Google\Cloud\Bigtable\V2\ProtoFormat`

Returns
Type	Description
`$this`

getResumeToken

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

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. In case of Value.kind is not set, it will be set to corresponding null value in googlesql. params["firstName"] = type {string_type }} then @firstName will be replaced with googlesql null string. Value.type should always be set and no inference of type will be made from Value.kind. If Value.type is not set, we will return INVALID_ARGUMENT error.

Returns
Type	Description
`Google\Protobuf\Internal\MapField`

setParams

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 Google\Cloud\Bigtable\V2\BigtableClient::instanceName() for help formatting this field.
`query`	`string` Required. The query string.

Returns
Type	Description
`Google\Cloud\Bigtable\V2\ExecuteQueryRequest`

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 Google\Cloud\Bigtable\V2\BigtableClient::instanceName() for help formatting this field.
`query`	`string` Required. The query string.
`appProfileId`	`string` Optional. This value specifies routing for replication. If not specified, the `default` application profile will be used.

Returns
Type	Description
`Google\Cloud\Bigtable\V2\ExecuteQueryRequest`