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



773
774
775
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 773

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 query parameters. See the definition of Type for more information about SQL types. Corresponds to the JSON property paramTypes

Returns:



726
727
728
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 726

def param_types
  @param_types
end

#params ⇒ Hash<String,Object>

The SQL query 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 query 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>) 


741
742
743
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 741

def params
  @params
end

#query_mode ⇒ String

Used to control the amount of debugging information returned in ResultSetStats. Corresponds to the JSON property queryMode

Returns:

  • (String) 


747
748
749
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 747

def query_mode
  @query_mode
end

#resume_token ⇒ String

If this request is resuming a previously interrupted SQL query execution, resume_token should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL query 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) 


758
759
760
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 758

def resume_token
  @resume_token
end

#sql ⇒ String

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

Returns:

  • (String) 


763
764
765
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 763

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:



771
772
773
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 771

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



778
779
780
781
782
783
784
785
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 778

def update!(**args)
  @param_types = args[:param_types] if args.key?(:param_types)
  @params = args[:params] if args.key?(:params)
  @query_mode = args[:query_mode] if args.key?(:query_mode)
  @resume_token = args[:resume_token] if args.key?(:resume_token)
  @sql = args[:sql] if args.key?(:sql)
  @transaction = args[:transaction] if args.key?(:transaction)
end