aerospike 2.6.0 → 2.7.0

data/lib/aerospike/connection/create.rb

@@ -21,10 +21,10 @@ module Aerospike
   module Connection # :nodoc:
     module Create
       class << self
-        def call(host, port, timeout: 30, tls_name: nil, ssl_options: nil)
-          if !ssl_options.nil? && ssl_options[:enable] != false
+        def call(host, port, timeout: 30, tls_name: nil, tls_options: nil)
+          if !tls_options.nil? && tls_options[:enable] != false
             ::Aerospike::Socket::SSL.connect(
-              host, port, timeout, tls_name, ssl_options
+              host, port, timeout, tls_name, tls_options
             )
           else
             ::Aerospike::Socket::TCP.connect(host, port, timeout)

data/lib/aerospike/host/parse.rb

@@ -23,7 +23,14 @@ module Aerospike
       INTEGER_REGEX = /\A\d+\z/
 
       class << self
-        # Parse hosts from string format: hostname1[:tlsname1][:port1],...
+        ##
+        #  Parse hosts from string format: hostname1[:tlsname1][:port1],...
+        #
+        #  Hostname may also be an IP address in the following formats:
+        #  - xxx.xxx.xxx.xxx
+        #  - [xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx:xxxx]
+        #  - [xxxx::xxxx]
+        #
         def call(hosts, default_port = 3000)
           case hosts
           when Host
@@ -32,7 +39,7 @@ module Aerospike
             hosts
           when String
             hosts.split(?,).map { |host|
-              addr, tls_name, port = host.split(?:)
+              addr, tls_name, port = components(host)
               if port.nil? && tls_name && tls_name.match(INTEGER_REGEX)
                 port = tls_name
                 tls_name = nil
@@ -44,6 +51,25 @@ module Aerospike
             fail TypeError, "hosts should be a Host object, an Array of Host objects, or a String"
           end
         end
+
+        # Extract addr, tls_name and port components from a host strin
+        def components(host_string)
+          host_string = host_string.strip
+
+          # IPv6
+          if host_string.start_with?('[')
+            end_idx = host_string.index(']')
+            raise ::Aerospike::Exceptions::Parse, 'Invalid IPv6 host' if end_idx.nil?
+
+            # Slice away brackets and what's inside them, then split on : and
+            # replace first entry with string inside brackets
+            host_string.slice(end_idx+1..-1).split(':').tap do |result|
+              result[0] = host_string[1...end_idx]
+            end
+          else
+            host_string.split(?:)
+          end
+        end
       end
     end
   end

data/lib/aerospike/node.rb

@@ -139,6 +139,10 @@ module Aerospike
       @reference_count.value = 0
     end
 
+    def referenced?
+      @reference_count.value > 0
+    end
+
     def responded!
       @responded.value = true
     end
@@ -155,8 +159,8 @@ module Aerospike
       @peers_count.value > 0
     end
 
-    def failed?
-      @failures.value > 0
+    def failed?(threshold = 1)
+      @failures.value >= threshold
     end
 
     def failed!

data/lib/aerospike/node/refresh/friends.rb

@@ -60,7 +60,7 @@ module Aerospike
               host,
               cluster.connection_timeout,
               cluster.cluster_name,
-              cluster.ssl_options
+              cluster.tls_options
             )
 
             node = peers.find_node_by_name(nv.name)

data/lib/aerospike/node/refresh/peers.rb

@@ -41,7 +41,7 @@ module Aerospike
 
               peer.hosts.each do |host|
                 begin
-                  nv = NodeValidator.new(cluster, host, cluster.connection_timeout, cluster.cluster_name, cluster.ssl_options)
+                  nv = NodeValidator.new(cluster, host, cluster.connection_timeout, cluster.cluster_name, cluster.tls_options)
 
                   if nv.name != peer.node_name
                     ::Aerospike.logger.warn("Peer node #{peer.node_name} is different than actual node #{nv.name} for host #{host}");

data/lib/aerospike/node_validator.rb

@@ -21,15 +21,15 @@ module Aerospike
   class NodeValidator # :nodoc:
     VERSION_REGEXP = /(?<v1>\d+)\.(?<v2>\d+)\.(?<v3>\d+).*/.freeze
 
-    attr_reader :host, :aliases, :name, :use_new_info, :features, :cluster_name, :ssl_options, :conn
+    attr_reader :host, :aliases, :name, :use_new_info, :features, :cluster_name, :tls_options, :conn
 
-    def initialize(cluster, host, timeout, cluster_name, ssl_options = {})
+    def initialize(cluster, host, timeout, cluster_name, tls_options = {})
       @cluster = cluster
       @use_new_info = true
       @features = Set.new
       @host = host
       @cluster_name = cluster_name
-      @ssl_options = ssl_options
+      @tls_options = tls_options
 
       set_aliases(host)
       set_address(timeout)

data/lib/aerospike/peers.rb

@@ -37,6 +37,10 @@ module Aerospike
       @generation_changed == true
     end
 
+    def reset_refresh_count!
+      @refresh_count = 0
+    end
+
     def use_peers?
       @use_peers == true
     end

data/lib/aerospike/peers/parse.rb

@@ -72,15 +72,35 @@ module Aerospike
         end
 
         def parse_hosts(parser, peer)
+          result = []
           parser.expect('[')
-          return [] if parser.current == ']'
+          return result if parser.current == ']'
 
-          # TODO(wallin): handle IPv6
-          raise ::Aerospike::Exceptions::Parse if parser.current == '['
-          parser.read_until(']').split(',').map do |host|
-            hostname, port = host.split(':')
-            ::Aerospike::Host.new(hostname, port, peer.tls_name)
+          loop do
+            result << parse_host(parser, peer)
+            break if parser.current == ']'
           end
+
+          result
+        end
+
+        def parse_host(parser, peer)
+          if parser.current == '[' # IPv6
+            parser.step
+            host = parser.read_until(']')
+            # skip one extra if port is detected, to match read behavior below
+            parser.step if parser.current == ':'
+          else
+            host = parser.read_until(',', ':', ']')
+          end
+
+          port = parser.prev == ':' ? parser.read_until(',', ']').to_i : nil
+
+          if parser.prev == ',' || parser.prev == ']'
+            return ::Aerospike::Host.new(host, port, peer.tls_name)
+          end
+
+          raise ::Aerospike::Exceptions::Parse, "Unterminated host in response"
         end
       end
     end

data/lib/aerospike/policy/batch_policy.rb

@@ -1,17 +1,19 @@
-# encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2018 Aerospike, 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
+# Portions may be licensed to Aerospike, Inc. under one or more contributor
+# license agreements.
 #
-# http:#www.apache.org/licenses/LICENSE-2.0
+# 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.
+# 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 'aerospike/policy/policy'
 
@@ -20,15 +22,23 @@ module Aerospike
   # Container object for batch policy command.
   class BatchPolicy < Policy
 
-    attr_accessor :max_concurrent_nodes, :record_queue_size, 
-      :wait_until_migrations_are_over
+    attr_accessor :use_batch_direct
 
     def initialize(opt={})
       super(opt)
 
-      @max_concurrent_nodes = opt[:max_concurrent_nodes] || 0
-      @record_queue_size = opt[:record_queue_size] || 5000
-      @wait_until_migrations_are_over = opt[:wait_until_migrations_are_over].nil? ? false : wait_until_migrations_are_over
+      # Use old batch direct protocol where batch reads are handled by direct
+      # low-level batch server database routines. The batch direct protocol can
+      # be faster when there is a single namespace. But there is one important
+      # drawback: The batch direct protocol will not proxy to a different
+      # server node when the mapped node has migrated a record to another node
+      # (resulting in not found record). This can happen after a node has been
+      # added/removed from the cluster and there is a lag between records being
+      # migrated and client partition map update (once per second). The batch
+      # index protocol will perform this record proxy when necessary.
+      #
+      # Default: false (use new batch index protocol if server supports it)
+      @use_batch_direct = opt.fetch(:use_batch_direct) { false }
 
       self
     end

data/lib/aerospike/policy/client_policy.rb

@@ -25,7 +25,7 @@ module Aerospike
     attr_accessor :user, :password
     attr_accessor :timeout, :connection_queue_size, :fail_if_not_connected, :tend_interval
     attr_accessor :cluster_name
-    attr_accessor :ssl_options
+    attr_accessor :tls
 
     def initialize(opt={})
       # Initial host connection timeout in seconds. The timeout when opening a connection
@@ -51,7 +51,7 @@ module Aerospike
       # Cluster Name
       @cluster_name = opt[:cluster_name]
 
-      @ssl_options = opt[:ssl_options]
+      @tls = opt[:tls] || opt[:ssl_options]
     end
 
     def requires_authentication

data/lib/aerospike/policy/query_policy.rb

@@ -1,34 +1,47 @@
-# encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2018 Aerospike, 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
+# Portions may be licensed to Aerospike, Inc. under one or more contributor
+# license agreements.
 #
-# http:#www.apache.org/licenses/LICENSE-2.0
+# 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.
+# 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 'aerospike/policy/batch_policy'
+require 'aerospike/policy/policy'
 
 module Aerospike
 
   # Container object for query policy command.
-  class QueryPolicy < BatchPolicy
+  class QueryPolicy < Policy
 
     attr_accessor :include_bin_data
+    attr_accessor :record_queue_size
 
     def initialize(opt={})
       super(opt)
 
       @max_retries = 0
 
+      # Indicates if bin data is retrieved. If false, only record digests (and
+      # user keys if stored on the server) are retrieved.
+      # Default is true.
       @include_bin_data = opt.fetch(:include_bin_data, true)
 
+      # Number of records to place in queue before blocking. Records received
+      # from multiple server nodes will be placed in a queue. A separate thread
+      # consumes these records in parallel. If the queue is full, the producer
+      # threads will block until records are consumed.
+      # Default is 5000.
+      @record_queue_size = opt[:record_queue_size] || 5000
+
       self
     end
 

data/lib/aerospike/policy/scan_policy.rb

@@ -1,40 +1,63 @@
-# encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2018 Aerospike, 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
+# Portions may be licensed to Aerospike, Inc. under one or more contributor
+# license agreements.
 #
-# http:#www.apache.org/licenses/LICENSE-2.0
+# 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.
+# 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 'aerospike/policy/batch_policy'
+require 'aerospike/policy/policy'
 
 module Aerospike
 
   # Container object for scan policy command.
-  class ScanPolicy < BatchPolicy
+  class ScanPolicy < Policy
 
     attr_accessor :scan_percent
     attr_accessor :concurrent_nodes
     attr_accessor :include_bin_data
     attr_accessor :fail_on_cluster_change
     attr_accessor :socket_timeout
+    attr_accessor :record_queue_size
 
     def initialize(opt={})
       super(opt)
 
+      @max_retries = 0
+
+      # Percent of data to scan. Valid integer range is 1 to 100.
+      # Default is 100.
       @scan_percent = opt[:scan_percent] || 100
-      @concurrent_nodes = opt[:concurrent_nodes].nil? ? true : concurrent_nodes
-      @include_bin_data = opt[:include_bin_data].nil? ? true : include_bin_data
-      @fail_on_cluster_change = opt[:fail_on_cluster_change].nil? ? true : fail_on_cluster_change
+
+      # Issue scan requests in parallel or serially.
+      @concurrent_nodes = opt.fetch(:concurrent_nodes) { true }
+
+      # Indicates if bin data is retrieved. If false, only record digests (and
+      # user keys if stored on the server) are retrieved.
+      # Default is true.
+      @include_bin_data = opt.fetch(:include_bin_data) { true }
+
+      # Terminate scan if cluster in fluctuating state.
+      # Default is true.
+      @fail_on_cluster_change = opt.fetch(:fail_on_cluster_change) { true }
+
       @socket_timeout = opt[:socket_timeout] || 10000
-      @max_retries = 0
+
+      # Number of records to place in queue before blocking. Records received
+      # from multiple server nodes will be placed in a queue. A separate thread
+      # consumes these records in parallel. If the queue is full, the producer
+      # threads will block until records are consumed.
+      # Default is 5000.
+      @record_queue_size = opt[:record_queue_size] || 5000
 
       self
     end

data/lib/aerospike/query/stream_command.rb

@@ -1,12 +1,13 @@
-# encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2018 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
 #
 # 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
+# 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
@@ -24,9 +25,9 @@ module Aerospike
 
   private
 
-  class StreamCommand < BatchCommand #:nodoc:
+  class StreamCommand < MultiCommand #:nodoc:
 
-    def parse_record_results(receive_size)
+    def parse_group(receive_size)
       @data_offset = 0
 
       while @data_offset < receive_size

data/lib/aerospike/record.rb

@@ -1,12 +1,13 @@
-# encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2018 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
 #
 # 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
+# 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