cassandra-driver 0.1.0.alpha1 → 1.0.0.beta.1

data/lib/cassandra/protocol/frame_encoder.rb

@@ -0,0 +1,48 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    # @private
+    class FrameEncoder
+      def initialize(protocol_version=1, compressor=nil)
+        @protocol_version = protocol_version
+        @compressor = compressor
+      end
+
+      def encode_frame(request, stream_id=0, buffer=nil)
+        raise InvalidStreamIdError, 'The stream ID must be between 0 and 127' unless 0 <= stream_id && stream_id < 128
+        buffer ||= CqlByteBuffer.new
+        flags = request.trace? ? 2 : 0
+        body = request.write(@protocol_version, CqlByteBuffer.new)
+        if @compressor && request.compressable? && @compressor.compress?(body)
+          flags |= 1
+          body = @compressor.compress(body)
+        end
+        header = [@protocol_version, flags, stream_id, request.opcode, body.bytesize]
+        buffer << header.pack(Formats::HEADER_FORMAT)
+        buffer << body
+        buffer
+      end
+
+      def change_stream_id(new_stream_id, buffer, offset=0)
+        buffer.update(offset + 2, new_stream_id.chr)
+      end
+    end
+  end
+end

data/lib/cassandra/protocol/request.rb

@@ -0,0 +1,38 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class Request
+      attr_reader :opcode, :trace
+
+      def initialize(opcode, trace=false)
+        @opcode = opcode
+        @trace = trace
+      end
+
+      def trace?
+        @trace
+      end
+
+      def compressable?
+        true
+      end
+    end
+  end
+end

data/lib/cassandra/protocol/requests/auth_response_request.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class AuthResponseRequest < Request
+      attr_reader :token
+
+      def initialize(token)
+        super(0x0f)
+        @token = token
+      end
+
+      def write(protocol_version, buffer)
+        buffer.append_bytes(@token)
+      end
+
+      def to_s
+        %(AUTH_RESPONSE #{@token.bytesize})
+      end
+
+      def eql?(other)
+        self.token == other.token
+      end
+      alias_method :==, :eql?
+
+      def hash
+        @token.hash
+      end
+    end
+  end
+end

data/lib/cassandra/protocol/requests/batch_request.rb

@@ -0,0 +1,76 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class BatchRequest < Request
+      LOGGED_TYPE = 0
+      UNLOGGED_TYPE = 1
+      COUNTER_TYPE = 2
+
+      attr_reader :type, :part_count
+      attr_accessor :consistency, :retries
+
+      def initialize(type, consistency, trace=false)
+        super(0x0D, trace)
+        @type = type
+        @part_count = 0
+        @encoded_queries = CqlByteBuffer.new
+        @consistency = consistency
+      end
+
+      def add_query(cql, values=nil, type_hints=nil)
+        @encoded_queries.append(QUERY_KIND)
+        @encoded_queries.append_long_string(cql)
+        QueryRequest.encode_values(@encoded_queries, values, type_hints)
+        @part_count += 1
+        nil
+      end
+
+      def add_prepared(id, metadata, values)
+        @encoded_queries.append(PREPARED_KIND)
+        @encoded_queries.append_short_bytes(id)
+        ExecuteRequest.encode_values(@encoded_queries, metadata, values)
+        @part_count += 1
+        nil
+      end
+
+      def write(protocol_version, buffer)
+        buffer.append(@type.chr)
+        buffer.append_short(@part_count)
+        buffer.append(@encoded_queries)
+        buffer.append_consistency(@consistency)
+      end
+
+      def to_s
+        type_str = case @type
+          when LOGGED_TYPE then 'LOGGED'
+          when UNLOGGED_TYPE then 'UNLOGGED'
+          when COUNTER_TYPE then 'COUNTER'
+        end
+        %(BATCH #{type_str} #{@part_count} #{@consistency.to_s.upcase})
+      end
+
+      private
+
+      TYPE_CONVERTER = TypeConverter.new
+      QUERY_KIND = "\x00".freeze
+      PREPARED_KIND = "\x01".freeze
+    end
+  end
+end

data/lib/cassandra/protocol/requests/credentials_request.rb

@@ -0,0 +1,47 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class CredentialsRequest < Request
+      attr_reader :credentials
+
+      def initialize(credentials)
+        super(4)
+        @credentials = credentials.dup.freeze
+      end
+
+      def write(protocol_version, buffer)
+        buffer.append_string_map(@credentials)
+      end
+
+      def to_s
+        %(CREDENTIALS #{@credentials})
+      end
+
+      def eql?(rq)
+        self.class === rq && rq.credentials.eql?(@credentials)
+      end
+      alias_method :==, :eql?
+
+      def hash
+        @h ||= @credentials.hash
+      end
+    end
+  end
+end

data/lib/cassandra/protocol/requests/execute_request.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class ExecuteRequest < Request
+      attr_reader :metadata, :values, :request_metadata, :serial_consistency, :page_size, :paging_state
+      attr_accessor :consistency, :retries, :id
+
+      def initialize(id, metadata, values, request_metadata, consistency, serial_consistency=nil, page_size=nil, paging_state=nil, trace=false)
+        raise ArgumentError, "Metadata for #{metadata.size} columns, but #{values.size} values given" if metadata.size != values.size
+        raise ArgumentError, %(No such consistency: #{consistency.inspect}) if consistency.nil? || !CONSISTENCIES.include?(consistency)
+        raise ArgumentError, %(No such consistency: #{serial_consistency.inspect}) unless serial_consistency.nil? || CONSISTENCIES.include?(serial_consistency)
+        raise ArgumentError, %(Paging state given but no page size) if paging_state && !page_size
+        super(10, trace)
+        @id = id
+        @metadata = metadata
+        @values = values
+        @request_metadata = request_metadata
+        @consistency = consistency
+        @serial_consistency = serial_consistency
+        @page_size = page_size
+        @paging_state = paging_state
+        @encoded_values = self.class.encode_values(CqlByteBuffer.new, @metadata, @values)
+      end
+
+      def write(protocol_version, buffer)
+        buffer.append_short_bytes(@id)
+        if protocol_version > 1
+          buffer.append_consistency(@consistency)
+          flags  = 0
+          flags |= 0x01 if @values.size > 0
+          flags |= 0x02 unless @request_metadata
+          flags |= 0x04 if @page_size
+          flags |= 0x08 if @paging_state
+          flags |= 0x10 if @serial_consistency
+          buffer.append(flags.chr)
+          if @values.size > 0
+            buffer.append(@encoded_values)
+          end
+          buffer.append_int(@page_size) if @page_size
+          buffer.append_bytes(@paging_state) if @paging_state
+          buffer.append_consistency(@serial_consistency) if @serial_consistency
+        else
+          buffer.append(@encoded_values)
+          buffer.append_consistency(@consistency)
+        end
+        buffer
+      end
+
+      def to_s
+        id = @id.each_byte.map { |x| x.to_s(16) }.join('')
+        %(EXECUTE #{id} #@values #{@consistency.to_s.upcase})
+      end
+
+      def eql?(rq)
+        self.class === rq && rq.id == self.id && rq.metadata == self.metadata && rq.values == self.values && rq.consistency == self.consistency && rq.serial_consistency == self.serial_consistency && rq.page_size == self.page_size && rq.paging_state == self.paging_state
+      end
+      alias_method :==, :eql?
+
+      def hash
+        @h ||= begin
+          h = 0
+          h = ((h & 33554431) * 31) ^ @id.hash
+          h = ((h & 33554431) * 31) ^ @metadata.hash
+          h = ((h & 33554431) * 31) ^ @values.hash
+          h = ((h & 33554431) * 31) ^ @consistency.hash
+          h = ((h & 33554431) * 31) ^ @serial_consistency.hash
+          h = ((h & 33554431) * 31) ^ @page_size.hash
+          h = ((h & 33554431) * 31) ^ @paging_state.hash
+          h
+        end
+      end
+
+      def self.encode_values(buffer, metadata, values)
+        buffer.append_short(metadata.size)
+        metadata.each_with_index do |(_, _, _, type), index|
+          TYPE_CONVERTER.to_bytes(buffer, type, values[index])
+        end
+        buffer
+      end
+
+      private
+
+      TYPE_CONVERTER = TypeConverter.new
+    end
+  end
+end

data/lib/cassandra/protocol/requests/options_request.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class OptionsRequest < Request
+      def initialize
+        super(5)
+      end
+
+      def compressable?
+        false
+      end
+
+      def write(protocol_version, buffer)
+        buffer
+      end
+
+      def to_s
+        %(OPTIONS)
+      end
+    end
+  end
+end

data/lib/cassandra/protocol/requests/prepare_request.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2014 DataStax, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#++
+
+module Cassandra
+  module Protocol
+    class PrepareRequest < Request
+      attr_reader :cql
+      attr_accessor :consistency, :retries
+
+      def initialize(cql, trace=false)
+        raise ArgumentError, 'No CQL given!' unless cql
+        super(9, trace)
+        @cql = cql
+        @consistency = :one
+      end
+
+      def write(protocol_version, buffer)
+        buffer.append_long_string(@cql)
+      end
+
+      def to_s
+        %(PREPARE "#@cql")
+      end
+
+      def eql?(rq)
+        self.class === rq && rq.cql == self.cql
+      end
+      alias_method :==, :eql?
+
+      def hash
+        @h ||= @cql.hash
+      end
+    end
+  end
+end