Struct google_spanner1::ExecuteSqlRequest

pub struct ExecuteSqlRequest {
    pub transaction: Option<TransactionSelector>,
    pub seqno: Option<String>,
    pub resume_token: Option<String>,
    pub partition_token: Option<String>,
    pub param_types: Option<HashMap<String, Type>>,
    pub query_mode: Option<String>,
    pub sql: Option<String>,
    pub params: Option<HashMap<String, String>>,
}

The request for ExecuteSql and ExecuteStreamingSql.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• instances databases sessions execute sql projects (request)
• instances databases sessions execute streaming sql projects (request)

Fields

transaction: Option<TransactionSelector>

The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency.

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 ReadWrite transaction. Single-use transactions are not supported (to avoid replay). The caller must either supply an existing transaction ID or begin a new transaction.

Partitioned DML requires an existing PartitionedDml transaction ID.

seqno: Option<String>

A per-transaction sequence number used to identify this request. This 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.

resume_token: Option<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.

partition_token: Option<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.

param_types: Option<HashMap<String, 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 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.

query_mode: Option<String>

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.

sql: Option<String>

Required. The SQL string.

params: Option<HashMap<String, String>>

The SQL string can contain parameter placeholders. A parameter placeholder consists of '@' followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores.

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 an SQL statement with unbound parameters.

Parameter values are specified using params, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values.

Trait Implementations

impl RequestValue for ExecuteSqlRequest

impl Clone for ExecuteSqlRequest

fn clone(&self) -> ExecuteSqlRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for ExecuteSqlRequest

fn default() -> ExecuteSqlRequest

Returns the "default value" for a type.

impl Debug for ExecuteSqlRequest

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for ExecuteSqlRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for ExecuteSqlRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.