Class ExecuteSqlRequest (3.34.0) 

ExecuteSqlRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The request for ExecuteSql][google.spanner.v1.Spanner.ExecuteSql] and ExecuteStreamingSql][google.spanner.v1.Spanner.ExecuteStreamingSql].

Attributes

NameDescription
session str
Required. The session in which the SQL query should be performed.
transaction google.cloud.spanner_v1.types.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 str
Required. The SQL string.
params google.protobuf.struct_pb2.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="" +=""> It is an error to execute a SQL statement with unbound parameters.
param_types MutableMapping[str, google.cloud.spanner_v1.types.Type]
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][google.spanner.v1.ExecuteSqlRequest.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][google.spanner.v1.Type] for more information about SQL types.
resume_token bytes
If this request is resuming a previously interrupted SQL statement execution, resume_token should be copied from the last PartialResultSet][google.spanner.v1.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 google.cloud.spanner_v1.types.ExecuteSqlRequest.QueryMode
Used to control the amount of debugging information returned in ResultSetStats][google.spanner.v1.ResultSetStats]. If partition_token][google.spanner.v1.ExecuteSqlRequest.partition_token] is set, query_mode][google.spanner.v1.ExecuteSqlRequest.query_mode] can only be set to QueryMode.NORMAL][google.spanner.v1.ExecuteSqlRequest.QueryMode.NORMAL].
partition_token bytes
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
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.types.ExecuteSqlRequest.QueryOptions
Query optimizer configuration to use for the given query.
request_options google.cloud.spanner_v1.types.RequestOptions
Common options for this request.
data_boost_enabled bool
If this is for a partitioned query and this field is set to true, the request will be executed via Spanner independent compute resources. If the field is set to true but the request does not set partition_token, the API will return an INVALID_ARGUMENT error.

Classes

ParamTypesEntry

ParamTypesEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
NameDescription
kwargs dict

Keys and values corresponding to the fields of the message.

mapping Union[dict, .Message]

A dictionary or message to be used to determine the values for this message.

ignore_unknown_fields Optional(bool)

If True, do not raise errors for unknown fields. Only applied if mapping is a mapping type or there are keyword parameters.

QueryMode

QueryMode(value)

Mode in which the statement must be processed.

Values: NORMAL (0): The default mode. Only the statement results are returned. PLAN (1): This mode returns only the query plan, without any results or execution statistics information. PROFILE (2): This mode returns both the query plan and the execution statistics along with the results.

QueryOptions

QueryOptions(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Query optimizer configuration.