Class: Google::Apis::SpannerV1::ExecuteSqlRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/spanner_v1/classes.rb,
lib/google/apis/spanner_v1/representations.rb,
lib/google/apis/spanner_v1/representations.rb

Overview

The request for ExecuteSql and ExecuteStreamingSql.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ExecuteSqlRequest

Returns a new instance of ExecuteSqlRequest.



2645
2646
2647
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2645

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#data_boost_enabled ⇒ Boolean Also known as: data_boost_enabled?

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. Corresponds to the JSON property dataBoostEnabled

Returns:

  • (Boolean) 


2556
2557
2558
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2556

def data_boost_enabled
  @data_boost_enabled
end

#directed_read_options ⇒ Google::Apis::SpannerV1::DirectedReadOptions

The DirectedReadOptions can be used to indicate which replicas or regions should be used for non-transactional reads or queries. DirectedReadOptions may only be specified for a read-only transaction, otherwise the API will return an INVALID_ARGUMENT error. Corresponds to the JSON property directedReadOptions

Returns:



2565
2566
2567
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2565

def directed_read_options
  @directed_read_options
end

#param_types ⇒ Hash<String,Google::Apis::SpannerV1::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. Corresponds to the JSON property paramTypes

Returns:



2574
2575
2576
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2574

def param_types
  @param_types
end

#params ⇒ Hash<String,Object>

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. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


2586
2587
2588
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2586

def params
  @params
end

#partition_token ⇒ 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. Corresponds to the JSON property partitionToken NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


2595
2596
2597
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2595

def partition_token
  @partition_token
end

#query_mode ⇒ 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. Corresponds to the JSON property queryMode

Returns:

  • (String) 


2601
2602
2603
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2601

def query_mode
  @query_mode
end

#query_options ⇒ Google::Apis::SpannerV1::QueryOptions

Query optimizer configuration. Corresponds to the JSON property queryOptions

Returns:



2606
2607
2608
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2606

def query_options
  @query_options
end

#request_options ⇒ Google::Apis::SpannerV1::RequestOptions

Common request options for various APIs. Corresponds to the JSON property requestOptions

Returns:



2611
2612
2613
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2611

def request_options
  @request_options
end

#resume_token ⇒ 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. Corresponds to the JSON property resumeToken NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


2621
2622
2623
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2621

def resume_token
  @resume_token
end

#seqno ⇒ Fixnum

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. Corresponds to the JSON property seqno

Returns:

  • (Fixnum) 


2632
2633
2634
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2632

def seqno
  @seqno
end

#sql ⇒ String

Required. The SQL string. Corresponds to the JSON property sql

Returns:

  • (String) 


2637
2638
2639
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2637

def sql
  @sql
end

#transaction ⇒ Google::Apis::SpannerV1::TransactionSelector

This message is used to select the transaction in which a Read or ExecuteSql call runs. See TransactionOptions for more information about transactions. Corresponds to the JSON property transaction

Returns:



2643
2644
2645
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2643

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 2650

def update!(**args)
  @data_boost_enabled = args[:data_boost_enabled] if args.key?(:data_boost_enabled)
  @directed_read_options = args[:directed_read_options] if args.key?(:directed_read_options)
  @param_types = args[:param_types] if args.key?(:param_types)
  @params = args[:params] if args.key?(:params)
  @partition_token = args[:partition_token] if args.key?(:partition_token)
  @query_mode = args[:query_mode] if args.key?(:query_mode)
  @query_options = args[:query_options] if args.key?(:query_options)
  @request_options = args[:request_options] if args.key?(:request_options)
  @resume_token = args[:resume_token] if args.key?(:resume_token)
  @seqno = args[:seqno] if args.key?(:seqno)
  @sql = args[:sql] if args.key?(:sql)
  @transaction = args[:transaction] if args.key?(:transaction)
end