- 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
Namespace
Google \ Cloud \ Spanner \ V1Methods
__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
↳ directed_read_options
↳ data_boost_enabled
bool
If this is for a partitioned query and this field is set to true
, the request is executed with Spanner Data Boost independent compute resources. If the field is set to true
but the request does not set partition_token
, the API returns an INVALID_ARGUMENT
error.
getSession
Required. The session in which the SQL query should be performed.
string
setSession
Required. The session in which the SQL query should be performed.
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.
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.
$this
getSql
Required. The SQL string.
string
setSql
Required. The SQL string.
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.
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.
$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.
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.
$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.
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.
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 .
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 .
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.
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.
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.
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.
var
int|string
$this
getQueryOptions
Query optimizer configuration to use for the given query.
hasQueryOptions
clearQueryOptions
setQueryOptions
Query optimizer configuration to use for the given query.
$this
getRequestOptions
Common options for this request.
hasRequestOptions
clearRequestOptions
setRequestOptions
Common options for this request.
$this
getDirectedReadOptions
Directed read options for this request.
hasDirectedReadOptions
clearDirectedReadOptions
setDirectedReadOptions
Directed read options for this request.
$this
getDataBoostEnabled
If this is for a partitioned query and this field is set to true
, the
request is executed with Spanner Data Boost independent compute resources.
If the field is set to true
but the request does not set partition_token
, the API returns an INVALID_ARGUMENT
error.
bool
setDataBoostEnabled
If this is for a partitioned query and this field is set to true
, the
request is executed with Spanner Data Boost independent compute resources.
If the field is set to true
but the request does not set partition_token
, the API returns an INVALID_ARGUMENT
error.
var
bool
$this
