cequel 1.0.4 → 1.1.0

data/lib/cequel/metal/batch.rb

@@ -25,9 +25,12 @@ module Cequel
       # @see Keyspace#batch
       #
       def initialize(keyspace, options = {})
+        options.assert_valid_keys(:auto_apply, :unlogged, :consistency)
         @keyspace = keyspace
         @auto_apply = options[:auto_apply]
         @unlogged = options.fetch(:unlogged, false)
+        @consistency = options.fetch(:consistency,
+                                     keyspace.default_consistency)
         reset
       end
 
@@ -54,7 +57,8 @@ module Cequel
           @statement.prepend(begin_statement)
           @statement.append("APPLY BATCH\n")
         end
-        @keyspace.execute(*@statement.args)
+        @keyspace.execute_with_consistency(
+          @statement.args.first, @statement.args.drop(1), @consistency)
       end
 
       #
@@ -74,6 +78,17 @@ module Cequel
         !unlogged?
       end
 
+      # @private
+      def execute_with_consistency(cql, bind_vars, query_consistency)
+        if query_consistency && query_consistency != @consistency
+          raise ArgumentError,
+                "Attempting to perform query with consistency " \
+                "#{query_consistency.to_s.upcase} in batch with consistency " \
+                "#{@consistency.upcase}"
+        end
+        execute(cql, *bind_vars)
+      end
+
       private
 
       def reset

data/lib/cequel/metal/data_set.rb

@@ -44,10 +44,12 @@ module Cequel
       attr_reader :sort_order
       # @return [Integer] maximum number of rows to return, `nil` if no limit
       attr_reader :row_limit
+      # @return [Symbol] what consistency level queries from this data set will
+      #   use
+      # @since 1.1.0
+      attr_reader :query_consistency
 
-      def_delegator :keyspace, :execute, :execute_cql
-      private :execute_cql
-      def_delegator :keyspace, :write
+      def_delegator :keyspace, :write_with_consistency
 
       #
       # @param table_name [Symbol] column family for this data set
@@ -79,7 +81,7 @@ module Cequel
       #   CQL documentation for INSERT
       #
       def insert(data, options = {})
-        inserter(options) { insert(data) }.execute
+        inserter { insert(data) }.execute(options)
       end
 
       #
@@ -125,10 +127,10 @@ module Cequel
       #
       def update(*args, &block)
         if block
-          updater(args.extract_options!, &block).execute
+          updater(&block).execute(args.extract_options!)
         else
           data = args.shift
-          updater(args.extract_options!) { set(data) }.execute
+          updater { set(data) }.execute(args.extract_options!)
         end
       end
 
@@ -151,7 +153,7 @@ module Cequel
       #   CQL documentation for counter columns
       #
       def increment(deltas, options = {})
-        incrementer(options) { increment(deltas) }.execute
+        incrementer { increment(deltas) }.execute(options)
       end
       alias_method :incr, :increment
 
@@ -168,7 +170,7 @@ module Cequel
       # @since 0.5.0
       #
       def decrement(deltas, options = {})
-        incrementer(options) { decrement(deltas) }.execute
+        incrementer { decrement(deltas) }.execute(options)
       end
       alias_method :decr, :decrement
 
@@ -193,7 +195,7 @@ module Cequel
       # @see #update
       #
       def list_prepend(column, elements, options = {})
-        updater(options) { list_prepend(column, elements) }.execute
+        updater { list_prepend(column, elements) }.execute(options)
       end
 
       #
@@ -216,7 +218,7 @@ module Cequel
       # @since 1.0.0
       #
       def list_append(column, elements, options = {})
-        updater(options) { list_append(column, elements) }.execute
+        updater { list_append(column, elements) }.execute(options)
       end
 
       #
@@ -238,7 +240,7 @@ module Cequel
       # @since 1.0.0
       #
       def list_replace(column, index, value, options = {})
-        updater(options) { list_replace(column, index, value) }.execute
+        updater { list_replace(column, index, value) }.execute(options)
       end
 
       #
@@ -260,7 +262,7 @@ module Cequel
       # @since 1.0.0
       #
       def list_remove(column, value, options = {})
-        updater(options) { list_remove(column, value) }.execute
+        updater { list_remove(column, value) }.execute(options)
       end
 
       #
@@ -284,7 +286,7 @@ module Cequel
       #
       def list_remove_at(column, *positions)
         options = positions.extract_options!
-        deleter(options) { list_remove_at(column, *positions) }.execute
+        deleter { list_remove_at(column, *positions) }.execute(options)
       end
 
       #
@@ -307,7 +309,7 @@ module Cequel
       #
       def map_remove(column, *keys)
         options = keys.extract_options!
-        deleter(options) { map_remove(column, *keys) }.execute
+        deleter { map_remove(column, *keys) }.execute(options)
       end
 
       #
@@ -328,7 +330,7 @@ module Cequel
       # @since 1.0.0
       #
       def set_add(column, values, options = {})
-        updater(options) { set_add(column, values) }.execute
+        updater { set_add(column, values) }.execute(options)
       end
 
       #
@@ -349,7 +351,7 @@ module Cequel
       # @since 1.0.0
       #
       def set_remove(column, value, options = {})
-        updater(options) { set_remove(column, value) }.execute
+        updater { set_remove(column, value) }.execute(options)
       end
 
       #
@@ -370,7 +372,7 @@ module Cequel
       # @since 1.0.0
       #
       def map_update(column, updates, options = {})
-        updater(options) { map_update(column, updates) }.execute
+        updater { map_update(column, updates) }.execute(options)
       end
 
       #
@@ -422,11 +424,11 @@ module Cequel
       def delete(*columns, &block)
         options = columns.extract_options!
         if block
-          deleter(options, &block).execute
+          deleter(&block).execute(options)
         elsif columns.empty?
-          deleter(options) { delete_row }.execute
+          deleter { delete_row }.execute(options)
         else
-          deleter(options) { delete_columns(*columns) }.execute
+          deleter { delete_columns(*columns) }.execute(options)
         end
       end
 
@@ -545,6 +547,25 @@ module Cequel
         end
       end
 
+      # rubocop:disable LineLength
+
+      #
+      # Change the consistency for queries performed by this data set
+      #
+      # @param consistency [Symbol] a consistency level
+      # @return [DataSet] new data set tuned to the given consistency
+      #
+      # @see http://www.datastax.com/documentation/cassandra/2.0/cassandra/dml/dml_config_consistency_c.html
+      # @since 1.1.0
+      #
+      def consistency(consistency)
+        clone.tap do |data_set|
+          data_set.query_consistency = consistency
+        end
+      end
+
+      # rubocop:enable LineLength
+
       #
       # Enumerate over rows in this data set. Along with #each, all other
       # Enumerable methods are implemented.
@@ -560,14 +581,15 @@ module Cequel
       #
       def each
         return enum_for(:each) unless block_given?
-        execute_cql(*cql).fetch { |row| yield Row.from_result_row(row) }
+        result = execute_cql(*cql)
+        result.each { |row| yield Row.from_result_row(row) }
       end
 
       #
       # @return [Hash] the first row in this data set
       #
       def first
-        row = execute_cql(*limit(1).cql).fetch_row
+        row = execute_cql(*limit(1).cql).first
         Row.from_result_row(row)
       end
 
@@ -575,7 +597,7 @@ module Cequel
       # @return [Fixnum] the number of rows in this data set
       #
       def count
-        execute_cql(*count_cql).fetch_row['count']
+        execute_cql(*count_cql).first['count']
       end
 
       #
@@ -606,7 +628,7 @@ module Cequel
       #
       def inspect
         "#<#{self.class.name}: " \
-          "#{CassandraCQL::Statement.sanitize(cql.first, cql[1..-1])}>"
+          "#{Keyspace.sanitize(cql.first, cql.drop(1))}>"
       end
 
       #
@@ -630,28 +652,30 @@ module Cequel
         end
       end
 
-      # @private
-      def updater(options = {}, &block)
-        Updater.new(self, options, &block)
-      end
-
-      # @private
-      def deleter(options = {}, &block)
-        Deleter.new(self, options, &block)
-      end
-
       protected
 
-      attr_writer :row_limit
+      attr_writer :row_limit, :query_consistency
 
       private
 
-      def inserter(options = {}, &block)
-        Inserter.new(self, options, &block)
+      def execute_cql(cql, *bind_vars)
+        keyspace.execute_with_consistency(cql, bind_vars, query_consistency)
+      end
+
+      def inserter(&block)
+        Inserter.new(self, &block)
+      end
+
+      def incrementer(&block)
+        Incrementer.new(self, &block)
+      end
+
+      def updater(&block)
+        Updater.new(self, &block)
       end
 
-      def incrementer(options = {}, &block)
-        Incrementer.new(self, options, &block)
+      def deleter(&block)
+        Deleter.new(self, &block)
       end
 
       def initialize_copy(source)

data/lib/cequel/metal/deleter.rb

@@ -61,7 +61,7 @@ module Cequel
 
       private
 
-      def write_to_statement(statement)
+      def write_to_statement(statement, options)
         if @delete_row
           statement.append("DELETE FROM #{table_name}")
         elsif statements.empty?
@@ -71,7 +71,7 @@ module Cequel
             .append(statements.join(','), *bind_vars)
             .append(" FROM #{table_name}")
         end
-        statement.append(generate_upsert_options)
+        statement.append(generate_upsert_options(options))
       end
 
       def empty?

data/lib/cequel/metal/incrementer.rb

@@ -35,10 +35,10 @@ module Cequel
 
       private
 
-      def write_to_statement(statement)
+      def write_to_statement(statement, options)
         statement
           .append("UPDATE #{table_name}")
-          .append(generate_upsert_options)
+          .append(generate_upsert_options(options))
           .append(
             " SET " << statements.join(', '),
             *bind_vars

data/lib/cequel/metal/inserter.rb

@@ -11,7 +11,7 @@ module Cequel
       #
       # (see Writer#initialize)
       #
-      def initialize(data_set, options = {})
+      def initialize(data_set)
         @row = {}
         super
       end
@@ -19,10 +19,12 @@ module Cequel
       #
       # (see Writer#execute)
       #
-      def execute
+      def execute(options = {})
         statement = Statement.new
-        write_to_statement(statement)
-        data_set.write(*statement.args)
+        consistency = options.fetch(:consistency, data_set.query_consistency)
+        write_to_statement(statement, options)
+        data_set.write_with_consistency(
+          statement.cql, statement.bind_vars, consistency)
       end
 
       #
@@ -55,12 +57,12 @@ module Cequel
         end
       end
 
-      def write_to_statement(statement)
+      def write_to_statement(statement, options)
         statement.append("INSERT INTO #{table_name}")
         statement.append(
           " (#{column_names.join(', ')}) VALUES (#{statements.join(', ')}) ",
           *bind_vars)
-        statement.append(generate_upsert_options)
+        statement.append(generate_upsert_options(options))
       end
     end
   end

data/lib/cequel/metal/keyspace.rb

@@ -1,4 +1,6 @@
 # -*- encoding : utf-8 -*-
+require 'set'
+
 module Cequel
   module Metal
     #
@@ -9,29 +11,72 @@ module Cequel
     class Keyspace
       extend Forwardable
       include Logging
+      include MonitorMixin
 
       # @return [Hash] configuration options for this keyspace
       attr_reader :configuration
       # @return [String] name of the keyspace
       attr_reader :name
+      # @return [Array<String>] list of hosts to connect to
+      attr_reader :hosts
+      # @return Integer port to connect to Cassandra nodes on
+      attr_reader :port
+      # @return [Symbol] the default consistency for queries in this keyspace
+      # @since 1.1.0
+      attr_writer :default_consistency
 
       #
       # @!method write(statement, *bind_vars)
       #
-      # Write data to this keyspace using a CQL query. Will be included the
-      # current batch operation if one is present.
+      #   Write data to this keyspace using a CQL query. Will be included the
+      #   current batch operation if one is present.
       #
-      # @param (see #execute)
-      # @return [void]
+      #   @param (see #execute)
+      #   @return [void]
       #
       def_delegator :write_target, :execute, :write
 
+      # @!method write_with_consistency(statement, bind_vars, consistency)
+      #
+      #   Write data to this keyspace using a CQL query at the given
+      #   consistency. Will be included the current batch operation if one is
+      #   present.
+      #
+      #   @param (see #execute_with_consistency)
+      #   @return [void]
+      #
+      def_delegator :write_target, :execute_with_consistency,
+                    :write_with_consistency
+
       #
       # @!method batch
       #   (see Cequel::Metal::BatchManager#batch)
       #
       def_delegator :batch_manager, :batch
 
+      #
+      # Combine a statement with bind vars into a fully-fledged CQL query. This
+      # will no longer be needed once the CQL driver supports bound values
+      # natively.
+      #
+      # @param statement [String] CQL statement with ? placeholders for bind
+      #   vars
+      # @param bind_vars [Array] bind variables corresponding to ? in the
+      #   statement
+      # @return [String] CQL statement with quoted values in place of bind
+      #   variables
+      #
+      def self.sanitize(statement, bind_vars)
+        each_bind_var = bind_vars.each
+        statement.gsub('?') { Type.quote(each_bind_var.next) }
+      end
+
+      #
+      # @!method sanitize
+      #   (see Cequel::Metal::Keyspace.sanitize)
+      #
+      def_delegator 'self.class', :sanitize
+
       #
       # @api private
       # @param configuration [Options]
@@ -40,13 +85,14 @@ module Cequel
       #
       def initialize(configuration={})
         configure(configuration)
+        @lock = Monitor.new
       end
 
       #
       # Configure this keyspace from a hash of options
       #
       # @param configuration [Options] configuration options
-      # @option configuration [String] :host ('127.0.0.1:9160') host/port of
+      # @option configuration [String] :host ('127.0.0.1:9042') host/port of
       #   single Cassandra instance to connect to
       # @option configuration [Array<String>] :hosts list of Cassandra
       #   instances to connect to
@@ -59,10 +105,14 @@ module Cequel
       # @return [void]
       #
       def configure(configuration = {})
+        if configuration.key?(:thrift)
+          warn "Cequel no longer uses the Thrift transport to communicate " \
+               "with Cassandra. The :thrift option is deprecated and ignored."
+        end
         @configuration = configuration
-        @hosts = configuration.fetch(
-          :host, configuration.fetch(:hosts, '127.0.0.1:9160'))
-        @thrift_options = configuration[:thrift].try(:symbolize_keys) || {}
+
+        @hosts, @port = extract_hosts_and_port(configuration)
+
         @name = configuration[:keyspace]
         # reset the connections
         clear_active_connections!
@@ -83,18 +133,42 @@ module Cequel
         DataSet.new(table_name.to_sym, self)
       end
 
+      #
+      # @return [Cql::Client::Client] the low-level client provided by the
+      #   adapter
+      # @api private
+      #
+      def client
+        synchronize { @client ||= build_client }
+      end
+
       #
       # Execute a CQL query in this keyspace
       #
       # @param statement [String] CQL string
       # @param bind_vars [Object] values for bind variables
-      # @return [void]
+      # @return [Enumerable] the results of the query
+      #
+      # @see #execute_with_consistency
       #
       def execute(statement, *bind_vars)
+        execute_with_consistency(statement, bind_vars, default_consistency)
+      end
+
+      #
+      # Execute a CQL query in this keyspace with the given consistency
+      #
+      # @param statement [String] CQL string
+      # @param bind_vars [Array] array of values for bind variables
+      # @param consistency [Symbol] consistency at which to execute query
+      # @return [Enumerable] the results of the query
+      #
+      # @since 1.1.0
+      #
+      def execute_with_consistency(statement, bind_vars, consistency)
         log('CQL', statement, *bind_vars) do
-          with_connection do |conn|
-            conn.execute(statement, *bind_vars)
-          end
+          client.execute(sanitize(statement, bind_vars),
+                         consistency || default_consistency)
         end
       end
 
@@ -104,47 +178,66 @@ module Cequel
       # @return [void]
       #
       def clear_active_connections!
-        if defined? @connection_pool
-          remove_instance_variable(:@connection_pool)
+        if defined? @client
+          remove_instance_variable(:@client)
         end
       end
 
+      #
+      # @return [Symbol] the default consistency for queries in this keyspace
+      # @since 1.1.0
+      #
+      def default_consistency
+        @default_consistency || :quorum
+      end
+
       private
 
-      def_delegator :connection_pool, :with, :with_connection
-      private :with_connection
+      attr_reader :lock
 
       def_delegator :batch_manager, :current_batch
       private :current_batch
 
-      def build_connection
-        options = {cql_version: '3.0.0'}
-        options[:keyspace] = name if name
-        CassandraCQL::Database.new(
-          @hosts,
-          options,
-          @thrift_options
-        )
-      end
+      def_delegator :lock, :synchronize
+      private :lock
 
-      def connection_pool
-        return @connection_pool if defined? @connection_pool
-        options = {
-          size: @configuration.fetch(:pool, 1),
-          timeout: @configuration.fetch(:pool_timeout, 0)
-        }
-        @connection_pool = ConnectionPool.new(options) do
-          build_connection
+      def build_client
+        Cql::Client.connect(hosts: hosts, port: port).tap do |client|
+          client.use(name) if name
         end
       end
 
       def batch_manager
-        @batch_manager ||= BatchManager.new(self)
+        synchronize { @batch_manager ||= BatchManager.new(self) }
       end
 
       def write_target
         current_batch || self
       end
+
+      def extract_hosts_and_port(configuration)
+        hosts, ports = [], Set[]
+        ports << configuration[:port] if configuration.key?(:port)
+        Array.wrap(configuration.fetch(
+          :host, configuration.fetch(:hosts, '127.0.0.1'))).each do |host_port|
+
+          host, port = host_port.split(':')
+          hosts << host
+          if port
+            warn "Specifying a hostname as host:port is deprecated. Specify " \
+                 "only the host IP or hostname in :hosts, and specify a " \
+                 "port for all nodes using the :port option."
+            ports << port.to_i
+          end
+        end
+
+        if ports.size > 1
+          fail ArgumentError, "All Cassandra nodes must listen on the same " \
+               "port; specified multiple ports #{ports.join(', ')}"
+        end
+
+        [hosts, ports.first || 9042]
+      end
     end
   end
 end