Class: Google::Apis::SpannerV1::Statement

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

A single DML statement.

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

Returns a new instance of Statement



2733
2734
2735
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2733

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:



2714
2715
2716
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2714

def param_types
  @param_types
end

#params ⇒ Hash<String,Object>

Parameter names and values that bind to placeholders in the DML string. A parameter placeholder consists of the @ character followed by the parameter name (for example, @firstName). Parameter names can contain 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 a SQL statement with unbound parameters. Corresponds to the JSON property params

Returns:

  • (Hash<String,Object>) 


2726
2727
2728
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2726

def params
  @params
end

#sql ⇒ String

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

Returns:

  • (String) 


2731
2732
2733
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2731

def sql
  @sql
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2738
2739
2740
2741
2742
 
# File 'generated/google/apis/spanner_v1/classes.rb', line 2738

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