cassandra-driver 3.0.0.rc.1-java → 3.0.0.rc.2-java

data/lib/cassandra/execution/options.rb

@@ -52,8 +52,10 @@ module Cassandra
       # @return [nil, Hash<String, String>] custom outgoing payload, a map of
       # string and byte buffers.
       #
-      # @see https://github.com/apache/cassandra/blob/33f1edcce97779c971d4f78712a9a8bf014ffbbc/doc/native_protocol_v4.spec#L127-L133 Description of custom payload in Cassandra native protocol v4.
-      # @see https://datastax.github.io/java-driver/manual/custom_payloads/#enabling-custom-payloads-on-c-nodes Enabling custom payloads on Cassandra nodes.
+      # @see https://github.com/apache/cassandra/blob/cassandra-3.4/doc/native_protocol_v4.spec#L125-L131 Description
+      #   of custom payload in Cassandra native protocol v4.
+      # @see https://datastax.github.io/java-driver/manual/custom_payloads/#enabling-custom-payloads-on-c-nodes
+      #   Enabling custom payloads on Cassandra nodes.
       #
       # @example Sending a custom payload
       #   result = session.execute(payload: {

data/lib/cassandra/future.rb

@@ -46,9 +46,7 @@ module Cassandra
     # @private
     class Error < Future
       def initialize(error)
-        unless error.is_a?(::Exception)
-          raise ::ArgumentError, "error must be an exception, #{error.inspect} given"
-        end
+        raise ::ArgumentError, "error must be an exception, #{error.inspect} given" unless error.is_a?(::Exception)
 
         @error = error
       end
@@ -519,9 +517,7 @@ module Cassandra
       end
 
       def failure(error)
-        unless error.is_a?(::Exception)
-          raise ::ArgumentError, "error must be an exception, #{error.inspect} given"
-        end
+        raise ::ArgumentError, "error must be an exception, #{error.inspect} given" unless error.is_a?(::Exception)
 
         return unless @state == :pending
 
@@ -600,9 +596,7 @@ module Cassandra
         timeout &&= Float(timeout)
 
         if timeout
-          if timeout < 0
-            raise ::ArgumentError, "timeout cannot be negative, #{timeout.inspect} given"
-          end
+          raise ::ArgumentError, "timeout cannot be negative, #{timeout.inspect} given" if timeout < 0
 
           start    = ::Time.now
           now      = start

data/lib/cassandra/host.rb

@@ -18,7 +18,7 @@
 
 module Cassandra
   class Host
-    # @return [IPAddr] host ip
+    # @return [IPAddr] host ip that clients use to connect to this host.
     attr_reader :ip
     # @note Host id can be `nil` before cluster has connected.
     # @return [Cassandra::Uuid, nil] host id.
@@ -37,6 +37,14 @@ module Cassandra
     attr_reader :tokens
     # @return [Symbol] host status. Must be `:up` or `:down`
     attr_reader :status
+    # @note This is the public IP address of the host if the cluster is deployed across multiple Amazon EC2 regions
+    #   (or equivalently multiple networks). Cassandra nodes in other EC2 regions use this address to connect to this
+    #   host.
+    # @return [IPAddr, String] broadcast address, if available.
+    attr_reader :broadcast_address
+    # @note This is the address that other Cassandra nodes use to connect to this host.
+    # @return [IPAddr, String] listen address, if available.
+    attr_reader :listen_address
 
     # @private
     def initialize(ip,
@@ -45,7 +53,9 @@ module Cassandra
                    datacenter = nil,
                    release_version = nil,
                    tokens = EMPTY_LIST,
-                   status = :up)
+                   status = :up,
+                   broadcast_address = nil,
+                   listen_address = nil)
       @ip              = ip
       @id              = id
       @rack            = rack
@@ -53,6 +63,10 @@ module Cassandra
       @release_version = release_version
       @tokens          = tokens
       @status          = status
+      @broadcast_address = broadcast_address.is_a?(String) ?
+          ::IPAddr.new(broadcast_address) : broadcast_address
+      @listen_address = listen_address.is_a?(String) ?
+          ::IPAddr.new(listen_address) : listen_address
     end
 
     # @return [Boolean] whether this host's status is `:up`

data/lib/cassandra/index.rb

@@ -0,0 +1,104 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2016 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
+  # Represents an index on a cassandra table
+  class Index
+    # @return [Cassandra::Table] table that the index applies to.
+    attr_reader :table
+    # @return [String] name of the index.
+    attr_reader :name
+    # @return [Symbol] kind of index: `:keys`, `:composites`, or `:custom`.
+    attr_reader :kind
+    # @return [String] name of column that the index applies to.
+    attr_reader :target
+    # @return [Hash] options of the index.
+    attr_reader :options
+
+    # @private
+    def initialize(table,
+                   name,
+                   kind,
+                   target,
+                   options)
+      @table = table
+      @name = name.freeze
+      @kind = kind
+      @target = target.freeze
+      @options = options.freeze
+    end
+
+    # @return [Boolean] whether or not this index uses a custom class.
+    def custom_index?
+      !@options['class_name'].nil?
+    end
+
+    # @return [String] name of the index class if this is a custom index; nil otherwise.
+    def custom_class_name
+      @options['class_name']
+    end
+
+    # @return [String] a cql representation of this table
+    def to_cql
+      keyspace_name = Util.escape_name(@table.keyspace.name)
+      table_name = Util.escape_name(@table.name)
+      index_name = Util.escape_name(name)
+
+      if custom_index?
+        "CREATE CUSTOM INDEX #{index_name} ON #{keyspace_name}.#{table_name} (#{target}) " \
+        "USING '#{@options['class_name']}' #{options_cql};"
+      else
+        "CREATE INDEX #{index_name} ON #{keyspace_name}.#{table_name} (#{target});"
+      end
+    end
+
+    # @private
+    def eql?(other)
+      other.is_a?(Index) &&
+        @table == other.table &&
+        @name == other.name &&
+        @kind == other.kind &&
+        @target == other.target &&
+        @options == other.options
+    end
+    alias == eql?
+
+    # @private
+    def inspect
+      "#<#{self.class.name}:0x#{object_id.to_s(16)} " \
+          "@name=#{@name} table_name=#{@table.name} kind=#{@kind} target=#{@target}>"
+    end
+
+    private
+
+    def options_cql
+      # exclude 'class_name', 'target' keys
+      filtered_options = @options.reject do |key, _|
+        key == 'class_name' || key == 'target'
+      end
+      return '' if filtered_options.empty?
+
+      result = 'WITH OPTIONS = {'
+      result << filtered_options.map do |key, value|
+        "'#{key}':'#{value}'"
+      end.join(', ')
+      result << '}'
+      result
+    end
+  end
+end

data/lib/cassandra/keyspace.rb

@@ -57,7 +57,8 @@ module Cassandra
                    tables,
                    types,
                    functions,
-                   aggregates)
+                   aggregates,
+                   views)
       @name           = name
       @durable_writes = durable_writes
       @replication    = replication
@@ -65,6 +66,15 @@ module Cassandra
       @types          = types
       @functions      = functions
       @aggregates     = aggregates
+      @views          = views
+
+      # Set the keyspace attribute on the tables and views.
+      @tables.each_value do |t|
+        t.set_keyspace(self)
+      end
+      @views.each_value do |v|
+        v.set_keyspace(self)
+      end
     end
 
     # @return [Boolean] whether durables writes are enabled for this keyspace
@@ -100,6 +110,34 @@ module Cassandra
     end
     alias tables each_table
 
+    # @return [Boolean] whether this keyspace has a materialized view with the given name
+    # @param name [String] materialized view name
+    def has_materialized_view?(name)
+      @views.key?(name)
+    end
+
+    # @return [Cassandra::MaterializedView, nil] a materialized view or nil
+    # @param name [String] materialized view name
+    def materialized_view(name)
+      @views[name]
+    end
+
+    # Yield or enumerate each materialized view defined in this keyspace
+    # @overload each_materialized_view
+    #   @yieldparam view [Cassandra::MaterializedView] current materialized view
+    #   @return [Cassandra::Keyspace] self
+    # @overload each_materialized_view
+    #   @return [Array<Cassandra::MaterializedView>] a list of materialized views
+    def each_materialized_view(&block)
+      if block_given?
+        @views.each_value(&block)
+        self
+      else
+        @views.values
+      end
+    end
+    alias materialized_views each_materialized_view
+
     # @return [Boolean] whether this keyspace has a user-defined type with the
     #   given name
     # @param name [String] user-defined type name
@@ -228,7 +266,8 @@ module Cassandra
                    tables,
                    @types,
                    @functions,
-                   @aggregates)
+                   @aggregates,
+                   @views)
     end
 
     # @private
@@ -241,7 +280,36 @@ module Cassandra
                    tables,
                    @types,
                    @functions,
-                   @aggregates)
+                   @aggregates,
+                   @views)
+    end
+
+    # @private
+    def update_materialized_view(view)
+      views = @views.dup
+      views[view.name] = view
+      Keyspace.new(@name,
+                   @durable_writes,
+                   @replication,
+                   @tables,
+                   @types,
+                   @functions,
+                   @aggregates,
+                   views)
+    end
+
+    # @private
+    def delete_materialized_view(view_name)
+      views = @views.dup
+      views.delete(view_name)
+      Keyspace.new(@name,
+                   @durable_writes,
+                   @replication,
+                   @tables,
+                   @types,
+                   @functions,
+                   @aggregates,
+                   views)
     end
 
     # @private
@@ -254,7 +322,8 @@ module Cassandra
                    @tables,
                    types,
                    @functions,
-                   @aggregates)
+                   @aggregates,
+                   @views)
     end
 
     # @private
@@ -267,7 +336,8 @@ module Cassandra
                    @tables,
                    types,
                    @functions,
-                   @aggregates)
+                   @aggregates,
+                   @views)
     end
 
     # @private
@@ -280,7 +350,8 @@ module Cassandra
                    @tables,
                    @types,
                    functions,
-                   @aggregates)
+                   @aggregates,
+                   @views)
     end
 
     # @private
@@ -293,7 +364,8 @@ module Cassandra
                    @tables,
                    @types,
                    functions,
-                   @aggregates)
+                   @aggregates,
+                   @views)
     end
 
     # @private
@@ -306,7 +378,8 @@ module Cassandra
                    @tables,
                    @types,
                    @functions,
-                   aggregates)
+                   aggregates,
+                   @views)
     end
 
     # @private
@@ -319,7 +392,8 @@ module Cassandra
                    @tables,
                    @types,
                    @functions,
-                   aggregates)
+                   aggregates,
+                   @views)
     end
 
     # @private
@@ -333,6 +407,11 @@ module Cassandra
       @tables
     end
 
+    # @private
+    def raw_materialized_views
+      @views
+    end
+
     # @private
     def raw_types
       @types

data/lib/cassandra/load_balancing/policies/dc_aware_round_robin.rb

@@ -20,6 +20,11 @@ module Cassandra
   module LoadBalancing
     module Policies
       class DCAwareRoundRobin < Policy
+        # @private
+        LOCAL_CONSISTENCIES = [:local_quorum, :local_one].freeze
+        # @private
+        EMPTY_ARRAY         = [].freeze
+
         # @private
         class Plan
           def initialize(local, remote, index)
@@ -62,9 +67,7 @@ module Cassandra
           datacenter              &&= String(datacenter)
           max_remote_hosts_to_use &&= Integer(max_remote_hosts_to_use)
 
-          unless datacenter.nil?
-            Util.assert_not_empty(datacenter) { 'datacenter cannot be empty' }
-          end
+          Util.assert_not_empty(datacenter) { 'datacenter cannot be empty' } unless datacenter.nil?
 
           unless max_remote_hosts_to_use.nil?
             Util.assert(max_remote_hosts_to_use >= 0) do
@@ -145,13 +148,6 @@ module Cassandra
 
           Plan.new(local, remote, position)
         end
-
-        private
-
-        # @private
-        LOCAL_CONSISTENCIES = [:local_quorum, :local_one].freeze
-        # @private
-        EMPTY_ARRAY         = [].freeze
       end
     end
   end

data/lib/cassandra/materialized_view.rb

@@ -0,0 +1,90 @@
+# encoding: utf-8
+
+#--
+# Copyright 2013-2016 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
+  # Represents a cassandra materialized view
+  # @see Cassandra::Keyspace#each_materialized_view
+  # @see Cassandra::Keyspace#materialized_view
+  class MaterializedView < ColumnContainer
+    # @return [Table] the table that this materialized view applies to.
+    attr_reader :base_table
+
+    # @private
+    def initialize(keyspace,
+                   name,
+                   partition_key,
+                   clustering_columns,
+                   other_columns,
+                   options,
+                   include_all_columns,
+                   where_clause,
+                   base_table,
+                   id)
+      super(keyspace, name, partition_key, clustering_columns, other_columns, options, id)
+      @include_all_columns = include_all_columns
+      @where_clause = where_clause
+      @base_table = base_table
+    end
+
+    # @return [String] a cql representation of this materialized view
+    def to_cql
+      keyspace_name = Util.escape_name(@keyspace.name)
+      cql = "CREATE MATERIALIZED VIEW #{keyspace_name}.#{Util.escape_name(@name)} AS\nSELECT "
+      cql << if @include_all_columns
+               '*'
+             else
+               @columns.map do |column|
+                 Util.escape_name(column.name)
+               end.join(', ')
+             end
+      cql << "\nFROM #{keyspace_name}.#{Util.escape_name(@base_table.name)}"
+      cql << "\nWHERE #{@where_clause}" if @where_clause
+      cql << "\nPRIMARY KEY (("
+      cql << @partition_key.map do |column|
+        Util.escape_name(column.name)
+      end.join(', ')
+      cql << ')'
+      unless @clustering_columns.empty?
+        cql << ', '
+        cql << @clustering_columns.map do |column|
+          Util.escape_name(column.name)
+        end.join(', ')
+      end
+      cql << ")\nWITH #{@options.to_cql.split("\n").join("\n ")};"
+    end
+
+    # @private
+    def eql?(other)
+      other.is_a?(MaterializedView) &&
+        super.eql?(other) &&
+        @include_all_columns == other.include_all_columns &&
+        @where_clause == other.where_clause &&
+        @base_table == other.base_table
+    end
+    alias == eql?
+
+    private
+
+    # We need these accessors for eql? to work, but we don't want random users to
+    # get these.
+
+    # @private
+    attr_reader :include_all_columns, :where_clause
+    protected :include_all_columns, :where_clause
+  end
+end