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.



1652
1653
1654
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1652

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:



1581
1582
1583
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1581

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>) 


1593
1594
1595
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1593

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) 


1602
1603
1604
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1602

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) 


1608
1609
1610
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1608

def query_mode
  @query_mode
end

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

Query optimizer configuration. Corresponds to the JSON property queryOptions

Returns:



1613
1614
1615
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1613

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:



1618
1619
1620
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1618

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) 


1628
1629
1630
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1628

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) 


1639
1640
1641
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1639

def seqno
  @seqno
end

#sql ⇒ String

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

Returns:

  • (String) 


1644
1645
1646
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1644

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:



1650
1651
1652
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1650

def transaction
  @transaction
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
 
# File 'lib/google/apis/spanner_v1/classes.rb', line 1657

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