Class ExecuteSqlRequest

The request for ExecuteSql and ExecuteStreamingSql.

Inheritance

object

ExecuteSqlRequest

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Spanner.v1.Data

Assembly: Google.Apis.Spanner.v1.dll

Syntax

public class ExecuteSqlRequest : IDirectResponseSchema

Properties

DataBoostEnabled

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.

Declaration

[JsonProperty("dataBoostEnabled")]
public virtual bool? DataBoostEnabled { get; set; }

Property Value

Type	Description
bool?

DirectedReadOptions

Directed read options for this request.

Declaration

[JsonProperty("directedReadOptions")]
public virtual DirectedReadOptions DirectedReadOptions { get; set; }

Property Value

Type	Description
DirectedReadOptions

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

ParamTypes

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.

Declaration

[JsonProperty("paramTypes")]
public virtual IDictionary<string, Type> ParamTypes { get; set; }

Property Value

Type	Description
IDictionary<string, Type>

Params__

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.

Declaration

[JsonProperty("params")]
public virtual IDictionary<string, object> Params__ { get; set; }

Property Value

Type	Description
IDictionary<string, object>

PartitionToken

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.

Declaration

[JsonProperty("partitionToken")]
public virtual string PartitionToken { get; set; }

Property Value

Type	Description
string

QueryMode

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.

Declaration

[JsonProperty("queryMode")]
public virtual string QueryMode { get; set; }

Property Value

Type	Description
string

QueryOptions

Query optimizer configuration to use for the given query.

Declaration

[JsonProperty("queryOptions")]
public virtual QueryOptions QueryOptions { get; set; }

Property Value

Type	Description
QueryOptions

RequestOptions

Common options for this request.

Declaration

[JsonProperty("requestOptions")]
public virtual RequestOptions RequestOptions { get; set; }

Property Value

Type	Description
RequestOptions

ResumeToken

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.

Declaration

[JsonProperty("resumeToken")]
public virtual string ResumeToken { get; set; }

Property Value

Type	Description
string

Seqno

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.

Declaration

[JsonProperty("seqno")]
public virtual long? Seqno { get; set; }

Property Value

Type	Description
long?

Sql

Required. The SQL string.

Declaration

[JsonProperty("sql")]
public virtual string Sql { get; set; }

Property Value

Type	Description
string

Transaction

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.

Declaration

[JsonProperty("transaction")]
public virtual TransactionSelector Transaction { get; set; }

Property Value

Type	Description
TransactionSelector

Implements

IDirectResponseSchema