- 1.104.0 (latest)
- 1.103.0
- 1.102.0
- 1.101.0
- 1.100.0
- 1.98.0
- 1.97.0
- 1.96.0
- 1.95.0
- 1.94.0
- 1.93.1
- 1.92.1
- 1.91.0
- 1.90.0
- 1.89.0
- 1.88.0
- 1.87.0
- 1.86.0
- 1.85.0
- 1.84.0
- 1.83.0
- 1.82.0
- 1.81.0
- 1.80.0
- 1.79.0
- 1.78.0
- 1.77.0
- 1.76.1
- 1.68.0
- 1.67.0
- 1.66.0
- 1.65.0
- 1.64.0
- 1.63.2
- 1.62.1
- 1.61.0
- 1.60.0
- 1.59.0
- 1.58.4
- 1.57.0
- 1.56.0
- 1.55.0
- 1.54.2
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.
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 @
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.
↳ 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 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.
↳ resume_token
string
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.
↳ 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
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) = {
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) = {
var
string
$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;
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;
$this
getSql
Required. The SQL string.
Generated from protobuf field string sql = 3 [(.google.api.field_behavior) = REQUIRED];
string
setSql
Required. The SQL string.
Generated from protobuf field string sql = 3 [(.google.api.field_behavior) = REQUIRED];
var
string
$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;
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;
var
Google\Protobuf\Struct
$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;
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;
var
array|Google\Protobuf\Internal\MapField
$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;
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;
var
string
$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;
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;
var
int
$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;
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;
var
string
$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;
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;
var
int|string
$this
getQueryOptions
Query optimizer configuration to use for the given query.
Generated from protobuf field .google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
hasQueryOptions
clearQueryOptions
setQueryOptions
Query optimizer configuration to use for the given query.
Generated from protobuf field .google.spanner.v1.ExecuteSqlRequest.QueryOptions query_options = 10;
$this
getRequestOptions
Common options for this request.
Generated from protobuf field .google.spanner.v1.RequestOptions request_options = 11;
hasRequestOptions
clearRequestOptions
setRequestOptions
Common options for this request.
Generated from protobuf field .google.spanner.v1.RequestOptions request_options = 11;
$this
