Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::ExecuteSqlRequest (v1.4.0)

Version 1.4.0

• 1.5.0 (latest)
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.2
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.2
• 0.21.0
• 0.20.1
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.1
• 0.14.1
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.1
• 0.7.4

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

The request for ExecuteSql and ExecuteStreamingSql.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#data_boost_enabled

def data_boost_enabled() -> ::Boolean

Returns

• (::Boolean) — 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.

#data_boost_enabled=

def data_boost_enabled=(value) -> ::Boolean

Parameter

• value (::Boolean) — 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.

Returns

• (::Boolean) — 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.

#directed_read_options

def directed_read_options() -> ::Google::Cloud::Spanner::V1::DirectedReadOptions

Returns

• (::Google::Cloud::Spanner::V1::DirectedReadOptions) — Directed read options for this request.

#directed_read_options=

def directed_read_options=(value) -> ::Google::Cloud::Spanner::V1::DirectedReadOptions

Parameter

• value (::Google::Cloud::Spanner::V1::DirectedReadOptions) — Directed read options for this request.

Returns

• (::Google::Cloud::Spanner::V1::DirectedReadOptions) — Directed read options for this request.

#last_statement

def last_statement() -> ::Boolean

Returns

• (::Boolean) — Optional. If set to true, this statement marks the end of the transaction. The transaction should be committed or aborted after this statement executes, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected.

  For DML statements, setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of a DML statement should not be assumed until a subsequent Commit call completes successfully.

#last_statement=

def last_statement=(value) -> ::Boolean

Parameter

• value (::Boolean) — Optional. If set to true, this statement marks the end of the transaction. The transaction should be committed or aborted after this statement executes, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected.

  For DML statements, setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of a DML statement should not be assumed until a subsequent Commit call completes successfully.

Returns

• (::Boolean) — Optional. If set to true, this statement marks the end of the transaction. The transaction should be committed or aborted after this statement executes, and attempts to execute any other requests against this transaction (including reads and queries) will be rejected.

  For DML statements, setting this option may cause some error reporting to be deferred until commit time (e.g. validation of unique constraints). Given this, successful execution of a DML statement should not be assumed until a subsequent Commit call completes successfully.

#param_types

def param_types() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Spanner::V1::Type}

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::Spanner::V1::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.

#param_types=

def param_types=(value) -> ::Google::Protobuf::Map{::String => ::Google::Cloud::Spanner::V1::Type}

Parameter

• value (::Google::Protobuf::Map{::String => ::Google::Cloud::Spanner::V1::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.

Returns

• (::Google::Protobuf::Map{::String => ::Google::Cloud::Spanner::V1::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.

#params

def params() -> ::Google::Protobuf::Struct

Returns

• (::Google::Protobuf::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 + 100"

  It is an error to execute a SQL statement with unbound parameters.

#params=

def params=(value) -> ::Google::Protobuf::Struct

Parameter

• value (::Google::Protobuf::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 + 100"

  It is an error to execute a SQL statement with unbound parameters.

Returns

• (::Google::Protobuf::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 + 100"

  It is an error to execute a SQL statement with unbound parameters.

#partition_token

def partition_token() -> ::String

Returns

• (::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.

#partition_token=

def partition_token=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#query_mode

def query_mode() -> ::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryMode

Returns

• (::Google::Cloud::Spanner::V1::ExecuteSqlRequest::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.

#query_mode=

def query_mode=(value) -> ::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryMode

Parameter

• value (::Google::Cloud::Spanner::V1::ExecuteSqlRequest::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.

Returns

• (::Google::Cloud::Spanner::V1::ExecuteSqlRequest::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.

#query_options

def query_options() -> ::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions

Returns

• (::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions) — Query optimizer configuration to use for the given query.

#query_options=

def query_options=(value) -> ::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions

Parameter

• value (::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions) — Query optimizer configuration to use for the given query.

Returns

• (::Google::Cloud::Spanner::V1::ExecuteSqlRequest::QueryOptions) — Query optimizer configuration to use for the given query.

#request_options

def request_options() -> ::Google::Cloud::Spanner::V1::RequestOptions

Returns

• (::Google::Cloud::Spanner::V1::RequestOptions) — Common options for this request.

#request_options=

def request_options=(value) -> ::Google::Cloud::Spanner::V1::RequestOptions

Parameter

• value (::Google::Cloud::Spanner::V1::RequestOptions) — Common options for this request.

Returns

• (::Google::Cloud::Spanner::V1::RequestOptions) — Common options for this request.

#resume_token

def resume_token() -> ::String

Returns

• (::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.

#resume_token=

def resume_token=(value) -> ::String

Parameter

• value (::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.

Returns

• (::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.

#seqno

def seqno() -> ::Integer

Returns

• (::Integer) — 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.

#seqno=

def seqno=(value) -> ::Integer

Parameter

• value (::Integer) — 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.

Returns

• (::Integer) — 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.

#session

def session() -> ::String

Returns

• (::String) — Required. The session in which the SQL query should be performed.

#session=

def session=(value) -> ::String

Parameter

• value (::String) — Required. The session in which the SQL query should be performed.

Returns

• (::String) — Required. The session in which the SQL query should be performed.

#sql

def sql() -> ::String

Returns

• (::String) — Required. The SQL string.

#sql=

def sql=(value) -> ::String

Parameter

• value (::String) — Required. The SQL string.

Returns

• (::String) — Required. The SQL string.

#transaction

def transaction() -> ::Google::Cloud::Spanner::V1::TransactionSelector

Returns

• (::Google::Cloud::Spanner::V1::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.

#transaction=

def transaction=(value) -> ::Google::Cloud::Spanner::V1::TransactionSelector

Parameter

• value (::Google::Cloud::Spanner::V1::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.

Returns

• (::Google::Cloud::Spanner::V1::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.