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

Inherits:

Object

• Object
• Google::Apis::SpannerV1::Statement

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

• #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.

• #params ⇒ Hash<String,Object>

  The DML string can contain parameter placeholders.

• #sql ⇒ String

  Required.

Instance Method Summary

• #initialize(**args) ⇒ Statement constructor

  A new instance of Statement.

• #update!(**args) ⇒ Object

  Update properties of this object.

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

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

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:

• (Hash<String,Google::Apis::SpannerV1::Type>)

# File 'generated/google/apis/spanner_v1/classes.rb', line 2705

def param_types
  @param_types
end

#params ⇒ Hash<String,Object>

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

# File 'generated/google/apis/spanner_v1/classes.rb', line 2720

def params
  @params
end

#sql ⇒ String

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

Returns:

• (String)

# File 'generated/google/apis/spanner_v1/classes.rb', line 2725

def sql
  @sql
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

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

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