Reference documentation and code samples for the Cloud Spanner V1 Client class ExecuteSqlRequest.
The request for ExecuteSql and ExecuteStreamingSql.
Generated from protobuf message google.spanner.v1.ExecuteSqlRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ session |
string
Required. The session in which the SQL query should be performed. |
↳ transaction |
Google\Cloud\Spanner\V1\TransactionSelector
The transaction to use. For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. Partitioned DML requires an existing Partitioned DML transaction ID. |
↳ sql |
string
Required. The SQL string. |
↳ params |
Google\Protobuf\Struct
Parameter names and values that bind to placeholders in the SQL string. A parameter placeholder consists of the |
↳ param_types |
array|Google\Protobuf\Internal\MapField
It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type |
↳ resume_token |
string
If this request is resuming a previously interrupted SQL statement execution, |
↳ query_mode |
int
Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL. |
↳ partition_token |
string
If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token. |
↳ seqno |
int|string
A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed. The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries. |
↳ query_options |
Google\Cloud\Spanner\V1\ExecuteSqlRequest\QueryOptions
Query optimizer configuration to use for the given query. |
↳ request_options |
Google\Cloud\Spanner\V1\RequestOptions
Common options for this request. |
getSession
Required. The session in which the SQL query should be performed.
Generated from protobuf field string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setSession
Required. The session in which the SQL query should be performed.
Generated from protobuf field string session = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getTransaction
The transaction to use.
For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. Partitioned DML requires an existing Partitioned DML transaction ID.
Generated from protobuf field .google.spanner.v1.TransactionSelector transaction = 2;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\V1\TransactionSelector|null | |
hasTransaction
clearTransaction
setTransaction
The transaction to use.
For queries, if none is provided, the default is a temporary read-only transaction with strong concurrency. Standard DML statements require a read-write transaction. To protect against replays, single-use transactions are not supported. The caller must either supply an existing transaction ID or begin a new transaction. Partitioned DML requires an existing Partitioned DML transaction ID.
Generated from protobuf field .google.spanner.v1.TransactionSelector transaction = 2;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\V1\TransactionSelector
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSql
Required. The SQL string.
Generated from protobuf field string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setSql
Required. The SQL string.
Generated from protobuf field string sql = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParams
Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the
parameter name (for example, @firstName). Parameter names must conform
to the naming requirements of identifiers as specified at
https://cloud.google.com/spanner/docs/lexical#identifiers.
Parameters can appear anywhere that a literal value is expected. The same
parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
Generated from protobuf field .google.protobuf.Struct params = 4;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Struct|null | |
hasParams
clearParams
setParams
Parameter names and values that bind to placeholders in the SQL string.
A parameter placeholder consists of the @ character followed by the
parameter name (for example, @firstName). Parameter names must conform
to the naming requirements of identifiers as specified at
https://cloud.google.com/spanner/docs/lexical#identifiers.
Parameters can appear anywhere that a literal value is expected. The same
parameter name can be used more than once, for example:
"WHERE id > @msg_id AND id < @msg_id + 100"
It is an error to execute a SQL statement with unbound parameters.
Generated from protobuf field .google.protobuf.Struct params = 4;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Struct
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getParamTypes
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type BYTES and values
of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact
SQL type for some or all of the SQL statement parameters. See the
definition of Type for more information
about SQL types.
Generated from protobuf field map<string, .google.spanner.v1.Type> param_types = 5;
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setParamTypes
It is not always possible for Cloud Spanner to infer the right SQL type
from a JSON value. For example, values of type BYTES and values
of type STRING both appear in params as JSON strings.
In these cases, param_types can be used to specify the exact
SQL type for some or all of the SQL statement parameters. See the
definition of Type for more information
about SQL types.
Generated from protobuf field map<string, .google.spanner.v1.Type> param_types = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getResumeToken
If this request is resuming a previously interrupted SQL statement
execution, resume_token should be copied from the last
PartialResultSet yielded before the interruption. Doing this
enables the new SQL statement execution to resume where the last one left
off. The rest of the request parameters must exactly match the
request that yielded this token.
Generated from protobuf field bytes resume_token = 6;
| Returns | |
|---|---|
| Type | Description |
string | |
setResumeToken
If this request is resuming a previously interrupted SQL statement
execution, resume_token should be copied from the last
PartialResultSet yielded before the interruption. Doing this
enables the new SQL statement execution to resume where the last one left
off. The rest of the request parameters must exactly match the
request that yielded this token.
Generated from protobuf field bytes resume_token = 6;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryMode
Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL.
Generated from protobuf field .google.spanner.v1.ExecuteSqlRequest.QueryMode query_mode = 7;
| Returns | |
|---|---|
| Type | Description |
int | |
setQueryMode
Used to control the amount of debugging information returned in ResultSetStats. If partition_token is set, query_mode can only be set to QueryMode.NORMAL.
Generated from protobuf field .google.spanner.v1.ExecuteSqlRequest.QueryMode query_mode = 7;
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPartitionToken
If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token.
Generated from protobuf field bytes partition_token = 8;
| Returns | |
|---|---|
| Type | Description |
string | |
setPartitionToken
If present, results will be restricted to the specified partition previously created using PartitionQuery(). There must be an exact match for the values of fields common to this message and the PartitionQueryRequest message used to create this partition_token.
Generated from protobuf field bytes partition_token = 8;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSeqno
A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed.
The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries.
Generated from protobuf field int64 seqno = 9;
| Returns | |
|---|---|
| Type | Description |
int|string | |
setSeqno
A per-transaction sequence number used to identify this request. This field makes each request idempotent such that if the request is received multiple times, at most one will succeed.
The sequence number must be monotonically increasing within the transaction. If a request arrives for the first time with an out-of-order sequence number, the transaction may be aborted. Replays of previously handled requests will yield the same response as the first execution. Required for DML statements. Ignored for queries.
Generated from protobuf field int64 seqno = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getQueryOptions
Query optimizer configuration to use for the given query.
Generated from protobuf field .google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\V1\ExecuteSqlRequest\QueryOptions|null | |
hasQueryOptions
clearQueryOptions
setQueryOptions
Query optimizer configuration to use for the given query.
Generated from protobuf field .google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\V1\ExecuteSqlRequest\QueryOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRequestOptions
Common options for this request.
Generated from protobuf field .google.spanner.v1.RequestOptions request_options = 11;
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Spanner\V1\RequestOptions|null | |
hasRequestOptions
clearRequestOptions
setRequestOptions
Common options for this request.
Generated from protobuf field .google.spanner.v1.RequestOptions request_options = 11;
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Spanner\V1\RequestOptions
|
| Returns | |
|---|---|
| Type | Description |
$this | |