cassandra-driver 2.1.7-java → 3.0.0.beta.1-java

data/lib/cassandra/result.rb

@@ -23,7 +23,7 @@ module Cassandra
     # Query execution information, such as number of retries and all tried hosts, etc.
     # @return [Cassandra::Execution::Info]
     def execution_info
-      @info ||= Execution::Info.new(@keyspace, @statement, @options, @hosts, @consistency, @retries, @trace_id ? Execution::Trace.new(@trace_id, @client) : nil)
+      @info ||= Execution::Info.new(@payload, @warnings, @keyspace, @statement, @options, @hosts, @consistency, @retries, @trace_id ? Execution::Trace.new(@trace_id, @client) : nil)
     end
 
     # @return [Boolean] whether it has any rows
@@ -96,7 +96,9 @@ module Cassandra
     class Paged < Result
       attr_reader :paging_state
 
-      def initialize(rows, paging_state, trace_id, keyspace, statement, options, hosts, consistency, retries, client, futures_factory)
+      def initialize(payload, warnings, rows, paging_state, trace_id, keyspace, statement, options, hosts, consistency, retries, client, futures_factory)
+        @payload        = payload
+        @warnings       = warnings
         @rows           = rows
         @paging_state   = paging_state
         @trace_id       = trace_id
@@ -156,13 +158,16 @@ module Cassandra
         end
       end
 
+      # @private
       def inspect
         "#<Cassandra::Result:0x#{self.object_id.to_s(16)} @rows=#{@rows.inspect} @last_page=#{@paging_state.nil?}>"
       end
     end
 
     class Void < Result
-      def initialize(trace_id, keyspace, statement, options, hosts, consistency, retries, client, futures_factory)
+      def initialize(payload, warnings, trace_id, keyspace, statement, options, hosts, consistency, retries, client, futures_factory)
+        @payload     = payload
+        @warnings    = warnings
         @trace_id    = trace_id
         @keyspace    = keyspace
         @statement   = statement
@@ -191,10 +196,10 @@ module Cassandra
       # @return [Cassandra::Result]
       def each(&block)
         if block_given?
-          NO_ROWS.each(&block)
+          EMPTY_LIST.each(&block)
           self
         else
-          NO_ROWS.each
+          EMPTY_LIST.each
         end
       end
       alias :rows :each
@@ -231,10 +236,6 @@ module Cassandra
       def inspect
         "#<Cassandra::Result:0x#{self.object_id.to_s(16)} @rows=[] @last_page=true>"
       end
-
-      private
-
-      NO_ROWS = [].freeze
     end
   end
 end

data/lib/cassandra/retry.rb

@@ -106,11 +106,20 @@ module Cassandra
 
       # Returns a decision that signals to driver to ignore the error
       #
-      # @return [Cassandra::Policies::Retry::Decision] tell driver to ignore the error
-      #   and return an empty result to the application
+      # @return [Cassandra::Policies::Retry::Decision] tell driver to ignore
+      #   the error and return an empty result to the application
       def ignore
         DECISION_IGNORE
       end
+
+      # Returns a decision that signals to the driver attempt execution on the
+      # next host in the load balancing plan
+      #
+      # @return [Cassandra::Policies::Retry::Decision] tell the driver to
+      #   re-execute the statement on another host
+      def try_next_host
+        DECISION_TRY_NEXT_HOST
+      end
     end
 
     # @private
@@ -128,12 +137,17 @@ module Cassandra
 
       class Ignore
       end
+
+      class TryNextHost
+      end
     end
 
     # @private
     DECISION_RERAISE = Decisions::Reraise.new
     # @private
-    DECISION_IGNORE  = Decisions::Ignore.new
+    DECISION_IGNORE = Decisions::Ignore.new
+    # @private
+    DECISION_TRY_NEXT_HOST = Decisions::TryNextHost.new
   end
 end
 

data/lib/cassandra/retry/policies/default.rb

@@ -28,18 +28,24 @@ module Cassandra
           if received >= required && !retrieved
             try_again(consistency)
           else
-            reraise
+            try_next_host
           end
         end
 
         def write_timeout(statement, consistency, type, required, received, retries)
           return reraise if retries > 0
 
-          type == :batch_log ? try_again(consistency) : reraise
+          if statement.idempotent? && received.zero?
+            try_next_host
+          elsif type == :batch_log
+            try_again(consistency)
+          else
+            reraise
+          end
         end
 
         def unavailable(statement, consistency, required, alive, retries)
-          reraise
+          try_next_host
         end
       end
     end

data/lib/cassandra/session.rb

@@ -57,9 +57,13 @@ module Cassandra
     #   initial request.
     # @option options [Array, Hash] :arguments (nil) positional or named
     #   arguments for the statement.
-    # @option options [Array, Hash] :type_hints (nil) override Util.guess_type to
-    #   determine the CQL type for an argument; nil elements will fall-back
+    # @option options [Array, Hash] :type_hints (nil) override Util.guess_type
+    #   to determine the CQL type for an argument; nil elements will fall-back
     #   to Util.guess_type.
+    # @option options [Boolean] :idempotent (false) specify whether this
+    #   statement can be retried safely on timeout.
+    # @option options [Hash<[String, Symbol], String>] :payload (nil) custom
+    #   outgoing payload to be sent with the request.
     #
     # @see Cassandra.cluster Options that can be specified on the cluster-level
     #   and their default values.
@@ -83,7 +87,7 @@ module Cassandra
 
       case statement
       when ::String
-        @client.query(Statements::Simple.new(statement, options.arguments, options.type_hints), options)
+        @client.query(Statements::Simple.new(statement, options.arguments, options.type_hints, options.idempotent?), options)
       when Statements::Simple
         @client.query(statement, options)
       when Statements::Prepared
@@ -91,6 +95,7 @@ module Cassandra
       when Statements::Bound
         @client.execute(statement, options)
       when Statements::Batch
+        Util.assert_not_empty(statement.statements) { "batch cannot be empty" }
         @client.batch(statement, options)
       else
         @futures.error(::ArgumentError.new("unsupported statement #{statement.inspect}"))
@@ -131,6 +136,9 @@ module Cassandra
     # @option options [Boolean] :trace (false) whether to enable request tracing
     # @option options [Numeric] :timeout (nil) if specified, it is a number of
     #   seconds after which to time out the request if it hasn't completed
+    # @option options [Boolean] :idempotent (false) specify whether the
+    #   statement being prepared can be retried safely on timeout during
+    #   execution.
     #
     # @return [Cassandra::Future<Cassandra::Statements::Prepared>] future
     #   prepared statement
@@ -169,7 +177,7 @@ module Cassandra
     # @yieldparam batch [Statements::Batch] a logged batch
     # @return [Statements::Batch] a logged batch
     def logged_batch(&block)
-      statement = Statements::Batch::Logged.new
+      statement = Statements::Batch::Logged.new(@options)
       yield(statement) if block_given?
       statement
     end
@@ -180,7 +188,7 @@ module Cassandra
     # @yieldparam batch [Statements::Batch] an unlogged batch
     # @return [Statements::Batch] an unlogged batch
     def unlogged_batch
-      statement = Statements::Batch::Unlogged.new
+      statement = Statements::Batch::Unlogged.new(@options)
       yield(statement) if block_given?
       statement
     end
@@ -190,7 +198,7 @@ module Cassandra
     # @yieldparam batch [Statements::Batch] a counter batch
     # @return [Statements::Batch] a counter batch
     def counter_batch
-      statement = Statements::Batch::Counter.new
+      statement = Statements::Batch::Counter.new(@options)
       yield(statement) if block_given?
       statement
     end
@@ -222,7 +230,7 @@ module Cassandra
       close_async.get
     end
 
-    # @return [String] a CLI-friendly session representation
+    # @private
     def inspect
       "#<#{self.class.name}:0x#{self.object_id.to_s(16)}>"
     end

data/lib/cassandra/statement.rb

@@ -18,5 +18,10 @@
 
 module Cassandra
   module Statement
+    # Determines whether or not the statement is safe to retry on timeout
+    # @return [Boolean] whether the statement is safe to retry on timeout
+    def idempotent?
+      !!@idempotent
+    end
   end
 end

data/lib/cassandra/statements/batch.rb

@@ -18,7 +18,8 @@
 
 module Cassandra
   module Statements
-    # Batch statement groups several {Cassandra::Statement}. There are several types of Batch statements available:
+    # Batch statement groups several {Cassandra::Statement}. There are several
+    #   types of Batch statements available:
     # @see Cassandra::Session#batch
     # @see Cassandra::Session#logged_batch
     # @see Cassandra::Session#unlogged_batch
@@ -43,6 +44,13 @@ module Cassandra
         def type
           :counter
         end
+
+        # Determines whether or not the statement is safe to retry on timeout
+        # Counter batches are never considered idempotent.
+        # @return [Boolean] whether the statement is safe to retry on timeout
+        def idempotent?
+          false
+        end
       end
 
       include Statement
@@ -51,7 +59,8 @@ module Cassandra
       attr_reader :statements
 
       # @private
-      def initialize
+      def initialize(options)
+        @options    = options
         @statements = []
       end
 
@@ -60,11 +69,16 @@ module Cassandra
       # @param statement [String, Cassandra::Statements::Simple,
       #   Cassandra::Statements::Prepared, Cassandra::Statements::Bound]
       #   statement to add.
-      # @param args [Array, Hash] (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.
-      # @param type_hints [Array, Hash] (nil) specified CQL types for positional
-      #   or named arguments to override type guessing.
+      # @param options [Hash] (nil) a customizable set of options
+      # @option options [Array, Hash] :arguments (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.
+      # @option options [Array, Hash] :type_hints (nil) override Util.guess_type
+      #   to determine the CQL type for an argument; nil elements will fall-back
+      #   to Util.guess_type.
+      # @option options [Boolean] :idempotent (false) specify whether this
+      #   statement can be retried safely on timeout.
       #
       # @note Positional arguments for simple statements are only supported
       #   starting with Apache Cassandra 2.0 and above.
@@ -73,15 +87,18 @@ module Cassandra
       #   starting with Apache Cassandra 2.1 and above.
       #
       # @return [self]
-      def add(statement, args = nil, type_hints = nil)
-        args ||= EMPTY_LIST
-        type_hints ||= EMPTY_LIST
+      def add(statement, options = nil)
+        if options.is_a?(::Hash)
+          options = @options.override(options)
+        else
+          options = @options
+        end
 
         case statement
         when String
-          @statements << Simple.new(statement, args, type_hints)
+          @statements << Simple.new(statement, options.arguments, options.type_hints, options.idempotent?)
         when Prepared
-          @statements << statement.bind(args)
+          @statements << statement.bind(options.arguments)
         when Bound, Simple
           @statements << statement
         else
@@ -91,6 +108,13 @@ module Cassandra
         self
       end
 
+      # Determines whether or not the statement is safe to retry on timeout
+      # Batches are idempotent only when all statements in a batch are.
+      # @return [Boolean] whether the statement is safe to retry on timeout
+      def idempotent?
+        @statements.all?(&:idempotent?)
+      end
+
       # A batch statement doesn't really have any cql of its own as it is composed of multiple different statements
       # @return [nil] nothing
       def cql

data/lib/cassandra/statements/bound.rb

@@ -30,13 +30,14 @@ module Cassandra
       attr_reader :params_types, :result_metadata, :keyspace, :partition_key
 
       # @private
-      def initialize(cql, params_types, result_metadata, params, keyspace = nil, partition_key = nil)
+      def initialize(cql, params_types, result_metadata, params, keyspace = nil, partition_key = nil, idempotent = false)
         @cql             = cql
         @params_types    = params_types
         @result_metadata = result_metadata
         @params          = params
         @keyspace        = keyspace
         @partition_key   = partition_key
+        @idempotent      = idempotent
       end
 
       # @return [String] a CLI-friendly bound statement representation

data/lib/cassandra/statements/prepared.rb

@@ -29,19 +29,24 @@ module Cassandra
       attr_reader :result_metadata
 
       # @private
-      def initialize(cql, params_metadata, result_metadata, trace_id, keyspace, statement, options, hosts, consistency, retries, client, futures_factory, schema)
-        @cql             = cql
-        @params_metadata = params_metadata
-        @result_metadata = result_metadata
-        @trace_id        = trace_id
-        @keyspace        = keyspace
-        @statement       = statement
-        @options         = options
-        @hosts           = hosts
-        @consistency     = consistency
-        @retries         = retries
-        @client          = client
-        @schema          = schema
+      def initialize(payload, warnings, cql, params_metadata, result_metadata, partition_key, trace_id, keyspace, statement, options, hosts, consistency, retries, client, connection_options)
+        @payload            = payload
+        @warnings           = warnings
+        @cql                = cql
+        @params_metadata    = params_metadata
+        @result_metadata    = result_metadata
+        @partition_key      = partition_key
+        @trace_id           = trace_id
+        @keyspace           = keyspace
+        @statement          = statement
+        @options            = options
+        @hosts              = hosts
+        @consistency        = consistency
+        @retries            = retries
+        @client             = client
+        @connection_options = connection_options
+        @idempotent         = options.idempotent?
+        @payload            = payload
       end
 
       # Creates a statement bound with specific arguments
@@ -59,48 +64,114 @@ module Cassandra
           args = EMPTY_LIST
         end
 
-        if args.is_a?(Hash)
-          args = @params_metadata.map do |(_, _, name, type)|
-            unless args.has_key?(name)
-              name = name.to_sym
-              raise ::ArgumentError, "argument :#{name} must be present in #{args.inspect}, but isn't" unless args.has_key?(name)
+        params = []
+        param_types = []
+
+        if args.is_a?(::Hash)
+          @params_metadata.each do |(_, _, name, type)|
+            name = name.to_sym unless args.has_key?(name)
+            value = args.fetch(name, NOT_SET)
+
+            if NOT_SET.eql?(value)
+              if @connection_options.protocol_version < 4
+                raise ::ArgumentError, "argument #{name.inspect} it not present in #{args.inspect}"
+              end
+            else
+              Util.assert_type(type, value) { "argument for #{name.inspect} must be #{type}, #{value} given" }
             end
 
-            args[name]
+            params << value
+            param_types << type
           end
         else
           Util.assert_equal(@params_metadata.size, args.size) { "expecting exactly #{@params_metadata.size} bind parameters, #{args.size} given" }
-        end
+          @params_metadata.zip(args) do |(_, _, name, type), value|
+            if NOT_SET.eql?(value)
+              if @connection_options.protocol_version < 4
+                raise ::ArgumentError, "argument #{name.inspect} it not present in #{args.inspect}"
+              end
+            else
+              Util.assert_type(type, value) { "argument for #{name.inspect} must be #{type}, #{value} given" }
+            end
 
-        params_types = @params_metadata.each_with_index.map do |(_, _, name, type), i|
-          Util.assert_type(type, args[i]) { "argument for #{name.inspect} must be #{type}, #{args[i]} given" }
-          type
+            params << value
+            param_types << type
+          end
         end
 
-        return Bound.new(@cql, params_types, @result_metadata, args) if @params_metadata.empty?
-
-        keyspace, table, _, _ = @params_metadata.first
-        return Bound.new(@cql, params_types, @result_metadata, args, keyspace) unless keyspace && table
-
-        values = ::Hash.new
-        @params_metadata.zip(args) do |(keyspace, table, column, type), value|
-          values[column] = value
-        end
+        keyspace_name, _ = @params_metadata.first
 
-        partition_key = @schema.create_partition_key(keyspace, table, values)
+        partition_key = create_partition_key(params)
 
-        Bound.new(@cql, params_types, @result_metadata, args, keyspace, partition_key)
+        Bound.new(@cql, param_types, @result_metadata, params, keyspace_name, partition_key, @idempotent)
       end
 
       # @return [Cassandra::Execution::Info] execution info for PREPARE request
       def execution_info
-        @info ||= Execution::Info.new(@keyspace, @statement, @options, @hosts, @consistency, @retries, @trace_id ? Execution::Trace.new(@trace_id, @client) : nil)
+        @info ||= Execution::Info.new(@payload, @warnings, @keyspace, @statement, @options, @hosts, @consistency, @retries, @trace_id ? Execution::Trace.new(@trace_id, @client) : nil)
       end
 
       # @return [String] a CLI-friendly prepared statement representation
       def inspect
         "#<#{self.class.name}:0x#{self.object_id.to_s(16)} @cql=#{@cql.inspect}>"
       end
+
+      private
+
+      def create_partition_key(values)
+        partition_key = @partition_key
+        return nil if partition_key.empty? || partition_key.size > values.size
+        params_metadata = @params_metadata
+
+        buffer = Protocol::CqlByteBuffer.new
+        if partition_key.one?
+          i        = partition_key.first
+          value    = values[i]
+          metadata = params_metadata[i]
+          name     = metadata[2]
+          type     = metadata[3]
+
+          if NOT_SET.eql?(value)
+            raise ::ArgumentError, "argument #{name.inspect} is a part of " \
+                                   "the partition key and must be present."
+          end
+
+          if @connection_options.protocol_version >= 3
+            Protocol::Coder.write_value_v3(buffer, value, type)
+          else
+            Protocol::Coder.write_value_v1(buffer, value, type)
+          end
+
+          buffer.discard(4) # discard size
+        else
+          buf = Protocol::CqlByteBuffer.new
+          partition_key.each do |i|
+            value    = values[i]
+            metadata = params_metadata[i]
+            name     = metadata[2]
+            type     = metadata[3]
+
+            if NOT_SET.eql?(value)
+              raise ::ArgumentError, "argument #{name.inspect} is a part of " \
+                                     "the partition key and must be present."
+            end
+
+            if @connection_options.protocol_version >= 3
+              Protocol::Coder.write_value_v3(buf, value, type)
+            else
+              Protocol::Coder.write_value_v1(buf, value, type)
+            end
+
+            buf.discard(4) # discard size
+
+            size = buf.length
+            buffer.append_short(size)
+            buffer << buf.read(size) << NULL_BYTE
+          end
+        end
+
+        buffer.to_str
+      end
     end
   end
 end