Class: Cassandra::Statements::Batch

Inherits:
Object
  • Object
show all
Includes:
Cassandra::Statement
Defined in:
lib/cassandra/statements/batch.rb

Overview

Batch statement groups several Cassandra::Statement. There are several types of Batch statements available:

See Also:

Instance Method Summary collapse

Instance Method Details

#add(statement, args = nil, type_hints = nil) ⇒ self

Note:

Positional arguments for simple statements are only supported starting with Apache Cassandra 2.0 and above.

Note:

Named arguments for simple statements are only supported starting with Apache Cassandra 2.1 and above.

Adds a statement to this batch.

Parameters:

  • statement (String, Cassandra::Statements::Simple, Cassandra::Statements::Prepared, Cassandra::Statements::Bound) —

    statement to add.

  • args (Array, Hash) (defaults to: nil) —

    (nil) positional or named arguments to bind, must contain the same number of parameters as the number of positional (?) or named (:name) markers in the CQL passed.

  • type_hints (Array, Hash) (defaults to: nil) —

    (nil) specified CQL types for positional or named arguments to override type guessing.

Returns:

  • (self) 


76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/cassandra/statements/batch.rb', line 76

def add(statement, args = nil, type_hints = nil)
  args ||= EMPTY_LIST
  type_hints ||= EMPTY_LIST

  case statement
  when String
    @statements << Simple.new(statement, args, type_hints)
  when Prepared
    @statements << statement.bind(args)
  when Bound, Simple
    @statements << statement
  else
    raise ::ArgumentError, "a batch can only consist of simple or prepared statements, #{statement.inspect} given"
  end

  self
end

#cql ⇒ nil

A batch statement doesn't really have any cql of its own as it is composed of multiple different statements

Returns:

  • (nil) —

    nothing



96
97
98
 
# File 'lib/cassandra/statements/batch.rb', line 96

def cql
  nil
end

#inspect ⇒ String

Returns a CLI-friendly batch statement representation.

Returns:

  • (String) —

    a CLI-friendly batch statement representation



105
106
107
 
# File 'lib/cassandra/statements/batch.rb', line 105

def inspect
  "#<#{self.class.name}:0x#{self.object_id.to_s(16)} @type=#{type.inspect}>"
end

#type ⇒ Symbol

Returns one of :logged, :unlogged or :counter.

Returns:

  • (Symbol) —

    one of :logged, :unlogged or :counter



101
102
 
# File 'lib/cassandra/statements/batch.rb', line 101

def type
end