Cloud Bigtable V2 Client - Class ExecuteQueryRequest (2.19.2)

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.
↳ proto_format 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. 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.

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

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

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.

Returns
Type Description
Google\Protobuf\Internal\MapField

setParams

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.

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.

Exactly one of query and prepared_query is required. Setting both or neither is an INVALID_ARGUMENT.
Returns
Type Description
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 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.
Returns
Type Description
ExecuteQueryRequest