cassandra-driver 1.0.0.beta.2-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1f273c3e73482362317afef768c8bccfbe88d6a0
+  data.tar.gz: d94cb5c4c732c8bfba726f4e87ee43a8c3f927b6
+SHA512:
+  metadata.gz: 35193ec4431c65f84ecc1baf5271925dcfab5cdf5ece7d8fc069427f10fc255c7c47515dd47c6a58b0939dbbedda8f70768da7c1e6cbf8d45097f291d132b144
+  data.tar.gz: 3223ac7e2459bd6c0f3ed7bbda85534284ddf88981207b3ed7aff448da78b5289fee230da6d5cc63cbbc2e947122cc779df8edd20194554c43be5e064d79f522

data/.yardopts

@@ -0,0 +1,4 @@
+--no-private
+--markup markdown
+lib/**/*.rb
+-- README

data/README.md

@@ -0,0 +1,125 @@
+# Datastax Ruby Driver for Apache Cassandra
+
+[![Build Status](https://travis-ci.org/datastax/ruby-driver.svg?branch=master)](https://travis-ci.org/datastax/ruby-driver)
+
+A Ruby client driver for Apache Cassandra. This driver works exclusively with
+the Cassandra Query Language version 3 (CQL3) and Cassandra's native protocol.
+
+- Code: https://github.com/datastax/ruby-driver
+- Docs: http://datastax.github.io/ruby-driver/
+- JIRA: https://datastax-oss.atlassian.net/browse/RUBY
+- MAILING LIST: https://groups.google.com/a/lists.datastax.com/forum/#!forum/ruby-driver-user
+- IRC: #datastax-drivers on [irc.freenode.net](http://freenode.net>)
+- TWITTER: Follow the latest news about DataStax Drivers - [@avalanche123](http://twitter.com/avalanche123), [@mfiguiere](http://twitter.com/mfiguiere), [@al3xandru](https://twitter.com/al3xandru) 
+
+This driver is based on [the cql-rb gem](https://github.com/iconara/cql-rb) by [Theo Hultberg](https://github.com/iconara) and we added support for:
+
+* [asynchronous execution](http://datastax.github.io/ruby-driver/features/asynchronous_io/)
+* one-off, [prepared](http://datastax.github.io/ruby-driver/features/basics/prepared_statements/) and [batch statements](http://datastax.github.io/ruby-driver/features/basics/batch_statements/)
+* automatic peer discovery and cluster metadata
+* various [load-balancing](http://datastax.github.io/ruby-driver/features/load_balancing/), [retry](http://datastax.github.io/ruby-driver/features/retry_policies/) and reconnection policies, [with ability to write your own](http://datastax.github.io/ruby-driver/features/load_balancing/implementing_a_policy/)
+
+## Compability
+
+This driver works exclusively with the Cassandra Query Language v3 (CQL3) and Cassandra's native protocol. The current version works with:
+
+* Cassandra versions 1.2 and 2.0
+* Ruby 1.9.3 and 2.0
+* JRuby 1.7
+* Rubinius 2.1
+
+__Note__: JRuby 1.6 is not officially supported, although 1.6.8 should work.
+
+## Quick start
+
+```ruby
+require 'cassandra'
+
+cluster = Cassandra.connect # connects to localhost by default
+
+cluster.each_host do |host| # automatically discovers all peers
+  puts "Host #{host.ip}: id=#{host.id} datacenter=#{host.datacenter} rack=#{host.rack}"
+end
+
+keyspace = 'system'
+session  = cluster.connect(keyspace) # create session, optionally scoped to a keyspace, to execute queries
+
+future = session.execute_async('SELECT keyspace_name, columnfamily_name FROM schema_columnfamilies') # fully asynchronous api
+future.on_success do |rows|
+  rows.each do |row|
+    puts "The keyspace #{row['keyspace_name']} has a table called #{row['columnfamily_name']}"
+  end
+end
+future.join
+```
+
+The host you specify is just a seed node, the driver will automatically discover all peers in the cluster.
+
+Read more:
+
+* [`Cassandra.connect` options](http://datastax.github.io/ruby-driver/api/#connect-class_method)
+* [`Session#execute_async` options](http://datastax.github.io/ruby-driver/api/session/#execute_async-instance_method)
+* [Usage documentation](http://datastax.github.io/ruby-driver/features)
+
+## Installation
+
+Install via rubygems
+
+```bash
+gem install cassandra-driver --pre
+```
+
+Install via Gemfile
+
+```ruby
+gem 'cassandra-driver', '~> 1.0.0.beta'
+```
+
+Note: if you want to use compression you should also install [snappy](http://rubygems.org/gems/snappy) or [lz4-ruby](http://rubygems.org/gems/lz4-ruby). [Read more about compression.](http://datastax.github.io/ruby-driver/features/#compression)
+
+
+## Upgrading from cql-rb
+
+Some of the new features added to the driver have unfortunately led to changes in the original cql-rb API. In the examples directory, you can find [an example of how to wrap the ruby driver to achieve almost complete interface parity with cql-rb](https://github.com/datastax/ruby-driver/blob/master/examples/cql-rb-wrapper.rb) to assist you with gradual upgrade.
+
+## What's new in v1.0.0.beta.2
+
+Current release introduces the following new features:
+
+* TokenAware load balancing policy
+* Domain names
+* SSL encryption
+
+## Changelog & versioning
+
+Check out the [releases on GitHub](https://github.com/datastax/ruby-driver/releases) and [changelog](https://github.com/datastax/ruby-driver/blob/master/CHANGELOG.md). Version numbering follows the [semantic versioning](http://semver.org/) scheme.
+
+Private and experimental APIs, defined as whatever is not in the [public API documentation][1], i.e. classes and methods marked as `@private`, will change without warning. If you've been recommended to try an experimental API by the maintainers, please let them know if you depend on that API. Experimental APIs will eventually become public, and knowing how they are used helps in determining their maturity.
+
+Prereleases will be stable, in the sense that they will have finished and properly tested features only, but may introduce APIs that will change before the final release. Please use the prereleases and report bugs, but don't deploy them to production without consulting the maintainers, or doing extensive testing yourself. If you do deploy to production please let the maintainers know as this helps determining the maturity of the release.
+
+## Known bugs & limitations
+
+* JRuby 1.6 is not officially supported, although 1.6.8 should work, if you're stuck in JRuby 1.6.8 try and see if it works for you.
+* Because the driver reactor is using `IO.select`, the maximum number of tcp connections allowed is 1024.
+
+
+## Credits
+
+This driver is based on the original work of [Theo Hultberg](https://github.com/iconara) on [cql-rb](https://github.com/iconara/cql-rb/) and adds a series of advanced features that are common across all other DataStax drivers for Apache Cassandra.
+
+The development effort to provide an up to date, high performance, fully featured Ruby Driver for Apache Cassandra will continue on this project, while [cql-rb](https://github.com/iconara/cql-rb/) will be discontinued. 
+
+
+## Copyright
+
+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](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.
+
+  [1]: http://datastax.github.io/ruby-driver/api
+

data/lib/cassandra/auth/providers/password.rb

@@ -0,0 +1,73 @@
+# 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 Auth
+    module Providers
+      # Auth provider used for Cassandra's built in authentication.
+      #
+      # @note No need to instantiate this class manually, use `:username` and
+      #   `:password` options when calling {Cassandra.connect} and one will be
+      #   created automatically for you.
+      class Password < Provider
+        # Authenticator used for Cassandra's built in authentication,
+        # see {Cassandra::Auth::Providers::Password}
+        # @private
+        class Authenticator
+          # @private
+          def initialize(username, password)
+            @username = username
+            @password = password
+          end
+
+          def initial_response
+            "\x00#{@username}\x00#{@password}"
+          end
+
+          def challenge_response(token)
+          end
+
+          def authentication_successful(token)
+          end
+        end
+
+        # @param username [String] username to use for authentication to Cassandra
+        # @param password [String] password to use for authentication to Cassandra
+        def initialize(username, password)
+          @username = username
+          @password = password
+        end
+
+        # Returns a Password Authenticator only if `org.apache.cassandra.auth.PasswordAuthenticator` is given.
+        # @param authentication_class [String] must equal to `org.apache.cassandra.auth.PasswordAuthenticator`
+        # @return [Cassandra::Auth::Authenticator] when `authentication_class == "org.apache.cassandra.auth.PasswordAuthenticator"`
+        # @return [nil] for all other values of `authentication_class`
+        def create_authenticator(authentication_class)
+          if authentication_class == PASSWORD_AUTHENTICATOR_FQCN
+            Authenticator.new(@username, @password)
+          end
+        end
+
+        private
+
+        # @private
+        PASSWORD_AUTHENTICATOR_FQCN = 'org.apache.cassandra.auth.PasswordAuthenticator'.freeze
+      end
+    end
+  end
+end

data/lib/cassandra/auth/providers.rb

@@ -0,0 +1,16 @@
+# 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.
+#++
+
+require 'cassandra/auth/providers/password'

data/lib/cassandra/auth.rb

@@ -0,0 +1,97 @@
+# 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 Auth
+    # An auth provider is a factory for {Cassandra::Auth::Authenticator} instances
+    # (or objects matching that interface). Its {#create_authenticator} will be
+    # called once for each connection that requires authentication.
+    #
+    # If the authentication requires keeping state, keep that in the
+    # authenticator instances, not in the auth provider.
+    #
+    # @note Creating an authenticator must absolutely not block, or the whole
+    #   connection process will block.
+    #
+    # @abstract Auth providers given to {Cassandra.connect} don't need to be
+    #   subclasses of this class, but need to implement the same methods. This
+    #   class exists only for documentation purposes.
+    #
+    # @see Cassandra::Auth::Providers
+    class Provider
+      # @!method create_authenticator(authentication_class, protocol_version)
+      #
+      # Create a new authenticator object. This method will be called once per
+      # connection that requires authentication. The auth provider can create
+      # different authenticators for different authentication classes, or return
+      # nil if it does not support the authentication class.
+      #
+      # @note This method must absolutely not block.
+      #
+      # @param authentication_class [String] the authentication class used by
+      #   the server.
+      # @return [Cassandra::Auth::Authenticator, nil] an object with an
+      #   interface matching {Cassandra::Auth::Authenticator} or `nil` if the
+      #   authentication class is not supported.
+    end
+
+    # An authenticator handles the authentication challenge/response cycles of
+    # a single connection. It can be stateful, but it must not for any reason
+    # block. If any of the method calls block, the whole connection process
+    # will be blocked.
+    #
+    # @abstract Authenticators created by auth providers don't need to be
+    #   subclasses of this class, but need to implement the same methods. This
+    #   class exists only for documentation purposes.
+    #
+    # @see https://github.com/apache/cassandra/blob/trunk/doc/native_protocol_v2.spec#L257-L273 Cassandra native protocol v2 SASL authentication
+    # @see Cassandra::Auth::Provider#create_authenticator
+    class Authenticator
+      # @!method initial_response
+      #
+      # This method must return the initial authentication token to be sent to
+      # the server.
+      #
+      # @note This method must absolutely not block.
+      #
+      # @return [String] the initial authentication token
+
+      # @!method challenge_response(token)
+      #
+      # If the authentication requires multiple challenge/response cycles this
+      # method will be called when a challenge is returned by the server. A
+      # response token must be created and will be sent back to the server.
+      #
+      # @note This method must absolutely not block.
+      #
+      # @param token [String] a challenge token sent by the server
+      # @return [String] the authentication token to send back to the server
+
+      # @!method authentication_successful(token)
+      #
+      # Called when the authentication is successful.
+      #
+      # @note This method must absolutely not block.
+      #
+      # @param token [String] a token sent by the server
+      # @return [void]
+    end
+  end
+end
+
+require 'cassandra/auth/providers'

data/lib/cassandra/client/batch.rb

@@ -0,0 +1,212 @@
+# 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 Client
+    # Batches let you send multiple queries (`INSERT`, `UPDATE` and `DELETE`) in
+    # one go. This can lead to better performance, and depending on the options
+    # you specify can also give you different consistency guarantees.
+    #
+    # Batches can contain a mix of different queries and prepared statements.
+    #
+    # @see Cassandra::Client::Client#batch
+    class Batch
+      # @!method add(cql_or_prepared_statement, *bound_values)
+      #
+      # Add a query or a prepared statement to the batch.
+      #
+      # @example Adding a mix of statements to a batch
+      #   batch.add(%(UPDATE people SET name = 'Miriam' WHERE id = 3435))
+      #   batch.add(%(UPDATE people SET name = ? WHERE id = ?), 'Miriam', 3435)
+      #   batch.add(prepared_statement, 'Miriam', 3435)
+      #
+      # @param [String, Cassandra::Client::PreparedStatement] cql_or_prepared_statement
+      #   a CQL string or a prepared statement object (obtained through
+      #   {Cassandra::Client::Client#prepare})
+      # @param [Array] bound_values a list of bound values -- only applies when
+      #   adding prepared statements and when there are binding markers in the
+      #   given CQL. If the last argument is a hash and it has the key
+      #   `:type_hints` this will be passed as type hints to the request encoder
+      #   (if the last argument is any other hash it will be assumed to be a
+      #   bound value of type MAP). See {Cassandra::Client::Client#execute} for more
+      #   info on type hints.
+      # @return [nil]
+
+      # @!method execute(options={})
+      #
+      # Execute the batch and return the result.
+      #
+      # @param [Hash] options an options hash or a symbol (as a shortcut for
+      #   specifying the consistency), see {Cassandra::Client::Client#execute} for
+      #   full details about how this value is interpreted.
+      # @raise [Cassandra::Errors::QueryError] raised when there is an error on the server side
+      # @raise [Cassandra::Errors::NotPreparedError] raised in the unlikely event that a
+      #   prepared statement was not prepared on the chosen connection
+      # @return [Cassandra::Client::VoidResult] a batch always returns a void result
+    end
+
+    # A convenient wrapper that makes it easy to build batches of multiple
+    # executions of the same prepared statement.
+    #
+    # @see Cassandra::Client::PreparedStatement#batch
+    class PreparedStatementBatch
+      # @!method add(*bound_values)
+      #
+      # Add the statement to the batch with the specified bound values.
+      #
+      # @param [Array] bound_values the values to bind to the added statement,
+      #   see {Cassandra::Client::PreparedStatement#execute}.
+      # @return [nil]
+
+      # @!method execute(options={})
+      #
+      # Execute the batch and return the result.
+      #
+      # @raise [Cassandra::Errors::QueryError] raised when there is an error on the server side
+      # @raise [Cassandra::Errors::NotPreparedError] raised in the unlikely event that a
+      #   prepared statement was not prepared on the chosen connection
+      # @return [Cassandra::Client::VoidResult] a batch always returns a void result
+    end
+
+    # @private
+    class AsynchronousBatch < Batch
+      def initialize(type, execute_options_decoder, connection_manager, options=nil)
+        raise ArgumentError, "Unknown batch type: #{type}" unless BATCH_TYPES.include?(type)
+        @type = type
+        @execute_options_decoder = execute_options_decoder
+        @connection_manager = connection_manager
+        @options = options
+        @request_runner = RequestRunner.new
+        @parts = []
+      end
+
+      def add(*args)
+        @parts << args
+        nil
+      end
+
+      def execute(options=nil)
+        options = @execute_options_decoder.decode_options(@options, options)
+        connection = @connection_manager.random_connection
+        request = Protocol::BatchRequest.new(BATCH_TYPES[@type], options[:consistency], options[:trace])
+        unprepared_statements = nil
+        @parts.each do |part, *bound_args|
+          if part.is_a?(String) || part.prepared?(connection)
+            add_part(connection, request, part, bound_args)
+          else
+            unprepared_statements ||= []
+            unprepared_statements << [part, bound_args]
+          end
+        end
+        @parts = []
+        if unprepared_statements.nil?
+          @request_runner.execute(connection, request, options[:timeout])
+        else
+          fs = unprepared_statements.map do |statement, _|
+            if statement.respond_to?(:async)
+              statement.async.prepare(connection)
+            else
+              statement.prepare(connection)
+            end
+          end
+          Ione::Future.all(*fs).flat_map do
+            unprepared_statements.each do |statement, bound_args|
+              add_part(connection, request, statement, bound_args)
+            end
+            @request_runner.execute(connection, request, options[:timeout])
+          end
+        end
+      end
+
+      private
+
+      BATCH_TYPES = {
+        :logged => Protocol::BatchRequest::LOGGED_TYPE,
+        :unlogged => Protocol::BatchRequest::UNLOGGED_TYPE,
+        :counter => Protocol::BatchRequest::COUNTER_TYPE,
+      }.freeze
+
+      def add_part(connection, request, part, bound_args)
+        if part.is_a?(String)
+          type_hints = nil
+          if bound_args.last.is_a?(Hash) && bound_args.last.include?(:type_hints)
+            bound_args = bound_args.dup
+            type_hints = bound_args.pop[:type_hints]
+          end
+          request.add_query(part, bound_args, type_hints)
+        else
+          part.add_to_batch(request, connection, bound_args)
+        end
+      end
+    end
+
+    # @private
+    class SynchronousBatch < Batch
+      include SynchronousBacktrace
+
+      def initialize(asynchronous_batch)
+        @asynchronous_batch = asynchronous_batch
+      end
+
+      def async
+        @asynchronous_batch
+      end
+
+      def add(*args)
+        @asynchronous_batch.add(*args)
+      end
+
+      def execute(options=nil)
+        synchronous_backtrace { @asynchronous_batch.execute(options).value }
+      end
+    end
+
+    # @private
+    class AsynchronousPreparedStatementBatch < PreparedStatementBatch
+      def initialize(prepared_statement, batch)
+        @prepared_statement = prepared_statement
+        @batch = batch
+      end
+
+      def add(*args)
+        @batch.add(@prepared_statement, *args)
+      end
+
+      def execute(options=nil)
+        @batch.execute(options)
+      end
+    end
+
+    # @private
+    class SynchronousPreparedStatementBatch < PreparedStatementBatch
+      include SynchronousBacktrace
+
+      def initialize(asynchronous_batch)
+        @asynchronous_batch = asynchronous_batch
+      end
+
+      def add(*args)
+        @asynchronous_batch.add(*args)
+      end
+
+      def execute(options=nil)
+        synchronous_backtrace { @asynchronous_batch.execute(options).value }
+      end
+    end
+  end
+end