Google Cloud Spanner v1 API - Class ExecuteSqlRequest (5.0.0-beta05) 

public sealed class ExecuteSqlRequest : IMessage<ExecuteSqlRequest>, IEquatable<ExecuteSqlRequest>, IDeepCloneable<ExecuteSqlRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Cloud Spanner v1 API class ExecuteSqlRequest.

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

Inheritance

object > ExecuteSqlRequest

Namespace

Google.Cloud.Spanner.V1

Assembly

Google.Cloud.Spanner.V1.dll

Constructors

ExecuteSqlRequest()

public ExecuteSqlRequest()

ExecuteSqlRequest(ExecuteSqlRequest)

public ExecuteSqlRequest(ExecuteSqlRequest other)
Parameter
Name Description
other ExecuteSqlRequest

Properties

DataBoostEnabled

public bool DataBoostEnabled { get; set; }

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.

Property Value
Type Description
bool

DirectedReadOptions

public DirectedReadOptions DirectedReadOptions { get; set; }

Directed read options for this request.

Property Value
Type Description
DirectedReadOptions

ParamTypes

public MapField<string, Type> ParamTypes { get; }

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.

Property Value
Type Description
MapFieldstringType

Params

public Struct Params { get; set; }

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.

Property Value
Type Description
Struct

PartitionToken

public ByteString PartitionToken { get; set; }

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.

Property Value
Type Description
ByteString

QueryMode

public ExecuteSqlRequest.Types.QueryMode QueryMode { get; set; }

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].

Property Value
Type Description
ExecuteSqlRequestTypesQueryMode

QueryOptions

public ExecuteSqlRequest.Types.QueryOptions QueryOptions { get; set; }

Query optimizer configuration to use for the given query.

Property Value
Type Description
ExecuteSqlRequestTypesQueryOptions

RequestOptions

public RequestOptions RequestOptions { get; set; }

Common options for this request.

Property Value
Type Description
RequestOptions

ResumeToken

public ByteString ResumeToken { get; set; }

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.

Property Value
Type Description
ByteString

Seqno

public long Seqno { get; set; }

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.

Property Value
Type Description
long

Session

public string Session { get; set; }

Required. The session in which the SQL query should be performed.

Property Value
Type Description
string

SessionAsSessionName

public SessionName SessionAsSessionName { get; set; }

SessionName-typed view over the Session resource name property.

Property Value
Type Description
SessionName

Sql

public string Sql { get; set; }

Required. The SQL string.

Property Value
Type Description
string

Transaction

public TransactionSelector Transaction { get; set; }

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.

Property Value
Type Description
TransactionSelector