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

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

Overview

The request for ExecuteSql and ExecuteStreamingSql.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ ExecuteSqlRequest

Returns a new instance of ExecuteSqlRequest



916
917
918
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 916

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

Instance Attribute Details

#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:



847
848
849
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 847

def param_types
  @param_types
end

#params ⇒ Hash<String,Object>

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

Returns:

  • (Hash<String,Object>) 


862
863
864
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 862

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) 


871
872
873
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 871

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) 


878
879
880
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 878

def query_mode
  @query_mode
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) 


889
890
891
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 889

def resume_token
  @resume_token
end

#seqno ⇒ Fixnum

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

Returns:

  • (Fixnum) 


901
902
903
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 901

def seqno
  @seqno
end

#sql ⇒ String

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

Returns:

  • (String) 


906
907
908
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 906

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:



914
915
916
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 914

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



921
922
923
924
925
926
927
928
929
930
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 921

def update!(**args)
  @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)
  @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