Class: Google::Cloud::Spanner::V1::ExecuteBatchDmlRequest::Statement

Inherits:

Object

• Object
• Google::Cloud::Spanner::V1::ExecuteBatchDmlRequest::Statement

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/spanner/v1/spanner.rb

Overview

A single DML statement.

Defined Under Namespace

Classes: ParamTypesEntry

Instance Attribute Summary

• #param_types ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Spanner::V1::Type}

  It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value.

• #params ⇒ ::Google::Protobuf::Struct

  Parameter names and values that bind to placeholders in the DML string.

• #sql ⇒ ::String

  Required.

Instance Attribute Details

#param_types ⇒ ::Google::Protobuf::Map{::String => ::Google::Cloud::Spanner::V1::Type}

Returns 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.

Returns:

• (::Google::Protobuf::Map{::String => ::Google::Cloud::Spanner::V1::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.

# File 'proto_docs/google/spanner/v1/spanner.rb', line 608

class Statement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Spanner::V1::Type]
  class ParamTypesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#params ⇒ ::Google::Protobuf::Struct

Returns 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.

Returns:

• (::Google::Protobuf::Struct) —

  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.

# File 'proto_docs/google/spanner/v1/spanner.rb', line 608

class Statement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Spanner::V1::Type]
  class ParamTypesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#sql ⇒ ::String

Returns Required. The DML string.

Returns:

• (::String) —

  Required. The DML string.

# File 'proto_docs/google/spanner/v1/spanner.rb', line 608

class Statement
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::Google::Cloud::Spanner::V1::Type]
  class ParamTypesEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end