google_api_spanner v0.6.0 GoogleApi.Spanner.V1.Model.ExecuteSqlRequest View Source
The request for ExecuteSql and ExecuteStreamingSql.
Attributes
paramTypes
(type:%{optional(String.t) => GoogleApi.Spanner.V1.Model.Type.t}
, default:nil
) - It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of typeBYTES
and values of typeSTRING
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.params
(type:map()
, default:nil
) - 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.partitionToken
(type:String.t
, default:nil
) - 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.queryMode
(type:String.t
, default:nil
) - 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.resumeToken
(type:String.t
, default:nil
) - 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.seqno
(type:String.t
, default:nil
) - 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.
sql
(type:String.t
, default:nil
) - Required. The SQL string.transaction
(type:GoogleApi.Spanner.V1.Model.TransactionSelector.t
, default:nil
) - 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.
Link to this section Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Link to this section Types
t()
View Source
t() :: %GoogleApi.Spanner.V1.Model.ExecuteSqlRequest{
paramTypes: %{optional(String.t()) => GoogleApi.Spanner.V1.Model.Type.t()},
params: map(),
partitionToken: String.t(),
queryMode: String.t(),
resumeToken: String.t(),
seqno: String.t(),
sql: String.t(),
transaction: GoogleApi.Spanner.V1.Model.TransactionSelector.t()
}
t() :: %GoogleApi.Spanner.V1.Model.ExecuteSqlRequest{ paramTypes: %{optional(String.t()) => GoogleApi.Spanner.V1.Model.Type.t()}, params: map(), partitionToken: String.t(), queryMode: String.t(), resumeToken: String.t(), seqno: String.t(), sql: String.t(), transaction: GoogleApi.Spanner.V1.Model.TransactionSelector.t() }
Link to this section Functions
decode(value, options) View Source
Unwrap a decoded JSON object into its complex fields.