aerospike 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cf4004182c5166b136433e8be338b9187718684c2783808d18b3ed31f1dbd17
-  data.tar.gz: 3a18cdde5294fb88ee0d4d710fb870c29db3273f5e29bd2d2ea92fd824857f00
+  metadata.gz: 2351767e50e34f9aec1da0eb58c6d5fb5b8a39f83d3aa2d2f9c88ed5d446b15a
+  data.tar.gz: 7104f9494a571dcf34a4809f0e4331acc76981649a53df06dd5f5c3ceddbcd0d
 SHA512:
-  metadata.gz: ab75f0c1d0d57c37f3d3f16966a27017b706067e414306c25a3388ad4a02571cdb18b1f019d67472e35386ad659db1d23d8685664ea6a7f2279e904b4c52383b
-  data.tar.gz: 501dabb13c9eb471e83cbda40aa22f2df7ae7e2c6083d447917a02e71017b9b64abe4bbff37798ef2517bced052c17347a109c842b97ab6b16f921939c6ebe23
+  metadata.gz: a48674b7bf187a0660d0a2b0e9c070f1b9f270d31dda522a2264cb2821470c193d2714944f35e4c65c2f05ee06fc299894d4721e348b8c986d5124f8d95ae2ef
+  data.tar.gz: febaffccf38b34e5b6653ce078630eacf73fead0d2cd840d09a87016a3adc3a8ff26a00460031a18d52d8a3bda6e9def1c7259917291f79857e020212812ebb1

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+v2.7.0 / 2018-04-12
+===================
+
+* **New Features**
+  * Batch Index protocol support. Thanks to [@deenbandhu-agarwal](https://github.com/deenbandhu-agarwal)! [[#61](https://github.com/aerospike/aerospike-client-ruby/pull/61)]
+  * Memory optimization: Avoid easy allocations. Thanks to [@wallin](https://github.com/wallin)! [[#62](https://github.com/aerospike/aerospike-client-ruby/pull/62)]
+  * New node removal strategy. Thanks to [@wallin](https://github.com/wallin)! [[#63](https://github.com/aerospike/aerospike-client-ruby/pull/63)]
+  * Support for IPv6. Requires Aerospike Enterprise Edition v3.10 or later. Thanks to [@wallin](https://github.com/wallin)! [[#65](https://github.com/aerospike/aerospike-client-ruby/pull/65)]
+
 v2.6.0 / 2018-03-27
 ===================
 

data/README.md

@@ -1,7 +1,9 @@
-# Aerospike Ruby Client [![travis][travis-image]][travis-url] [![gem][gem-image]][gem-url]
+# Aerospike Ruby Client [![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url] [![gem][gem-image]][gem-url]
 
 [travis-image]: https://travis-ci.org/aerospike/aerospike-client-ruby.svg?branch=master
 [travis-url]: https://travis-ci.org/aerospike/aerospike-client-ruby
+[codecov-image]: https://codecov.io/gh/aerospike/aerospike-client-ruby/branch/master/graph/badge.svg
+[codecov-url]: https://codecov.io/gh/aerospike/aerospike-client-ruby
 [gem-image]: https://img.shields.io/gem/v/aerospike.svg
 [gem-url]: https://rubygems.org/gems/aerospike
 

data/lib/aerospike.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # Copyright 2014-2018 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
@@ -41,7 +40,8 @@ require 'aerospike/version'
 require 'aerospike/value/particle_type'
 require 'aerospike/value/value'
 require 'aerospike/command/single_command'
-require 'aerospike/command/batch_node'
+require 'aerospike/command/batch_direct_node'
+require 'aerospike/command/batch_index_node'
 require 'aerospike/command/field_type'
 require 'aerospike/command/command'
 require 'aerospike/command/execute_command'
@@ -49,11 +49,13 @@ require 'aerospike/command/write_command'
 require 'aerospike/command/batch_item'
 require 'aerospike/command/operate_command'
 require 'aerospike/command/exists_command'
-require 'aerospike/command/batch_command_get'
-require 'aerospike/command/batch_command'
+require 'aerospike/command/multi_command'
+require 'aerospike/command/batch_direct_command'
+require 'aerospike/command/batch_direct_exists_command'
+require 'aerospike/command/batch_index_command'
+require 'aerospike/command/batch_index_exists_command'
 require 'aerospike/command/read_header_command'
 require 'aerospike/command/touch_command'
-require 'aerospike/command/batch_command_exists'
 require 'aerospike/command/read_command'
 require 'aerospike/command/delete_command'
 require 'aerospike/command/admin_command'
@@ -74,6 +76,7 @@ require 'aerospike/policy/priority'
 require 'aerospike/policy/record_exists_action'
 require 'aerospike/policy/generation_policy'
 require 'aerospike/policy/policy'
+require 'aerospike/policy/batch_policy'
 require 'aerospike/policy/write_policy'
 require 'aerospike/policy/scan_policy'
 require 'aerospike/policy/query_policy'
@@ -91,6 +94,7 @@ require 'aerospike/connection/create'
 require 'aerospike/cluster'
 require 'aerospike/cluster/create_connection'
 require 'aerospike/cluster/partition'
+require 'aerospike/cluster/find_nodes_to_remove'
 require 'aerospike/cluster/find_node'
 require 'aerospike/cluster/partition_tokenizer_new'
 require 'aerospike/cluster/partition_tokenizer_old'

data/lib/aerospike/client.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
 # Copyright 2014-2018 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
@@ -112,7 +111,7 @@ module Aerospike
     #
     #  client.put key, {'bin', 'value string'}, :timeout => 0.001
 
-    def put(key, bins, options={})
+    def put(key, bins, options = nil)
       policy = create_policy(options, WritePolicy)
       command = WriteCommand.new(@cluster, policy, key, hash_to_bins(bins), Aerospike::Operation::WRITE)
       execute_command(command)
@@ -135,7 +134,7 @@ module Aerospike
     #
     #  client.append key, {'bin', 'value to append'}, :timeout => 0.001
 
-    def append(key, bins, options={})
+    def append(key, bins, options = nil)
       policy = create_policy(options, WritePolicy)
       command = WriteCommand.new(@cluster, policy, key, hash_to_bins(bins), Aerospike::Operation::APPEND)
       execute_command(command)
@@ -154,7 +153,7 @@ module Aerospike
     #
     #  client.prepend key, {'bin', 'value to prepend'}, :timeout => 0.001
 
-    def prepend(key, bins, options={})
+    def prepend(key, bins, options = nil)
       policy = create_policy(options, WritePolicy)
       command = WriteCommand.new(@cluster, policy, key, hash_to_bins(bins), Aerospike::Operation::PREPEND)
       execute_command(command)
@@ -177,7 +176,7 @@ module Aerospike
     #
     #  client.add key, {'bin', -1}, :timeout => 0.001
 
-    def add(key, bins, options={})
+    def add(key, bins, options = nil)
       policy = create_policy(options, WritePolicy)
       command = WriteCommand.new(@cluster, policy, key, hash_to_bins(bins), Aerospike::Operation::ADD)
       execute_command(command)
@@ -199,7 +198,7 @@ module Aerospike
     #
     #  existed = client.delete key, :timeout => 0.001
 
-    def delete(key, options={})
+    def delete(key, options = nil)
       policy = create_policy(options, WritePolicy)
       command = DeleteCommand.new(@cluster, policy, key)
       execute_command(command)
@@ -247,7 +246,7 @@ module Aerospike
     #
     #  client.touch key, :timeout => 0.001
 
-    def touch(key, options={})
+    def touch(key, options = nil)
       policy = create_policy(options, WritePolicy)
       command = TouchCommand.new(@cluster, policy, key)
       execute_command(command)
@@ -260,38 +259,20 @@ module Aerospike
     ##
     #  Determines if a record key exists.
     #  The policy can be used to specify timeouts.
-    def exists(key, options={})
+    def exists(key, options = nil)
       policy = create_policy(options, Policy)
       command = ExistsCommand.new(@cluster, policy, key)
       execute_command(command)
       command.exists
     end
 
-    #  Check if multiple record keys exist in one batch call.
-    #  The returned array bool is in positional order with the original key array order.
-    #  The policy can be used to specify timeouts.
-    def batch_exists(keys, options={})
-      policy = create_policy(options, Policy)
-
-      # same array can be used without sychronization;
-      # when a key exists, the corresponding index will be marked true
-      exists_array = Array.new(keys.length)
-
-      key_map = BatchItem.generate_map(keys)
-
-      batch_execute(keys) do |node, bns|
-        BatchCommandExists.new(node, bns, policy, key_map, exists_array)
-      end
-      exists_array
-    end
-
     #-------------------------------------------------------
     # Read Record Operations
     #-------------------------------------------------------
 
     #  Read record header and bins for specified key.
     #  The policy can be used to specify timeouts.
-    def get(key, bin_names=[], options={})
+    def get(key, bin_names = nil, options = nil)
       policy = create_policy(options, Policy)
 
       command = ReadCommand.new(@cluster, policy, key, bin_names)
@@ -301,7 +282,7 @@ module Aerospike
 
     #  Read record generation and expiration only for specified key.  Bins are not read.
     #  The policy can be used to specify timeouts.
-    def get_header(key, options={})
+    def get_header(key, options = nil)
       policy = create_policy(options, Policy)
       command = ReadHeaderCommand.new(@cluster, policy, key)
       execute_command(command)
@@ -315,48 +296,62 @@ module Aerospike
     #  Read multiple record headers and bins for specified keys in one batch call.
     #  The returned records are in positional order with the original key array order.
     #  If a key is not found, the positional record will be nil.
-    #  The policy can be used to specify timeouts.
-    def batch_get(keys, bin_names=[], options={})
-      policy = create_policy(options, Policy)
-
-      # wait until all migrations are finished
-      # TODO: implement
-      # @cluster.WaitUntillMigrationIsFinished(policy.timeout)
-
-      # same array can be used without sychronization;
-      # when a key exists, the corresponding index will be set to record
-      records = Array.new(keys.length)
-
-      key_map = BatchItem.generate_map(keys)
+    #  The policy can be used to specify timeouts and protocol type.
+    def batch_get(keys, bin_names = nil, options = nil)
+      policy = create_policy(options, BatchPolicy)
+      results = Array.new(keys.length)
+      info_flags = INFO1_READ
+
+      case bin_names
+      when :all, nil, []
+        info_flags |= INFO1_GET_ALL
+        bin_names = nil
+      when :none
+        info_flags |= INFO1_NOBINDATA
+        bin_names = nil
+      end
 
-      batch_execute(keys) do |node, bns|
-        BatchCommandGet.new(node, bns, policy, key_map, bin_names.uniq, records, INFO1_READ)
+      if policy.use_batch_direct
+        key_map = BatchItem.generate_map(keys)
+        execute_batch_direct_commands(keys) do |node, batch|
+          BatchDirectCommand.new(node, batch, policy, key_map, bin_names, results, info_flags)
+        end
+      else
+        execute_batch_index_commands(keys) do |node, batch|
+          BatchIndexCommand.new(node, batch, policy, bin_names, results, info_flags)
+        end
       end
-      records
+
+      results
     end
 
     #  Read multiple record header data for specified keys in one batch call.
     #  The returned records are in positional order with the original key array order.
     #  If a key is not found, the positional record will be nil.
-    #  The policy can be used to specify timeouts.
-    def batch_get_header(keys, options={})
-      policy = create_policy(options, Policy)
-
-      # wait until all migrations are finished
-      # TODO: Fix this and implement
-      # @cluster.WaitUntillMigrationIsFinished(policy.timeout)
-
-      # same array can be used without sychronization;
-      # when a key exists, the corresponding index will be set to record
-      records = Array.new(keys.length)
-
-      key_map = BatchItem.generate_map(keys)
+    #  The policy can be used to specify timeouts and protocol type.
+    def batch_get_header(keys, options = nil)
+      batch_get(keys, :none, options)
+    end
 
-      batch_execute(keys) do |node, bns|
-        BatchCommandGet.new(node, bns, policy, key_map, nil, records, INFO1_READ | INFO1_NOBINDATA)
+    #  Check if multiple record keys exist in one batch call.
+    #  The returned boolean array is in positional order with the original key array order.
+    #  The policy can be used to specify timeouts and protocol type.
+    def batch_exists(keys, options = nil)
+      policy = create_policy(options, BatchPolicy)
+      results = Array.new(keys.length)
+
+      if policy.use_batch_direct
+        key_map = BatchItem.generate_map(keys)
+        execute_batch_direct_commands(keys) do |node, batch|
+          BatchDirectExistsCommand.new(node, batch, policy, key_map, results)
+        end
+      else
+        execute_batch_index_commands(keys) do |node, batch|
+          BatchIndexExistsCommand.new(node, batch, policy, results)
+        end
       end
 
-      records
+      results
     end
 
     #-------------------------------------------------------
@@ -367,7 +362,7 @@ module Aerospike
     #  An example would be to add an integer value to an existing record and then
     #  read the result, all in one database call. Operations are executed in
     #  the order they are specified.
-    def operate(key, operations, options={})
+    def operate(key, operations, options = nil)
       policy = create_policy(options, WritePolicy)
 
       command = OperateCommand.new(@cluster, policy, key, operations)
@@ -385,7 +380,7 @@ module Aerospike
     #  RegisterTask instance.
     #
     #  This method is only supported by Aerospike 3 servers.
-    def register_udf_from_file(client_path, server_path, language, options={})
+    def register_udf_from_file(client_path, server_path, language, options = nil)
       udf_body = File.read(client_path)
       register_udf(udf_body, server_path, language, options)
     end
@@ -396,7 +391,7 @@ module Aerospike
     #  RegisterTask instance.
     #
     #  This method is only supported by Aerospike 3 servers.
-    def register_udf(udf_body, server_path, language, options={})
+    def register_udf(udf_body, server_path, language, options = nil)
       content = Base64.strict_encode64(udf_body).force_encoding('binary')
 
       str_cmd = "udf-put:filename=#{server_path};content=#{content};"
@@ -426,7 +421,7 @@ module Aerospike
     #  RemoveTask instance.
     #
     #  This method is only supported by Aerospike 3 servers.
-    def remove_udf(udf_name, options={})
+    def remove_udf(udf_name, options = nil)
       str_cmd = "udf-remove:filename=#{udf_name};"
 
       # Send command to one node. That node will distribute it to other nodes.
@@ -443,7 +438,7 @@ module Aerospike
 
     #  ListUDF lists all packages containing user defined functions in the server.
     #  This method is only supported by Aerospike 3 servers.
-    def list_udf(options={})
+    def list_udf(options = nil)
       str_cmd = 'udf-list'
 
       # Send command to one node. That node will distribute it to other nodes.
@@ -479,7 +474,7 @@ module Aerospike
     #  udf file = <server udf dir>/<package name>.lua
     #
     #  This method is only supported by Aerospike 3 servers.
-    def execute_udf(key, package_name, function_name, args=[], options={})
+    def execute_udf(key, package_name, function_name, args=[], options = nil)
       policy = create_policy(options, WritePolicy)
 
       command = ExecuteCommand.new(@cluster, policy, key, package_name, function_name, args)
@@ -508,7 +503,7 @@ module Aerospike
     #
     # This method is only supported by Aerospike 3 servers.
     # If the policy is nil, the default relevant policy will be used.
-    def execute_udf_on_query(statement, package_name, function_name, function_args=[], options={})
+    def execute_udf_on_query(statement, package_name, function_name, function_args=[], options = nil)
       policy = create_policy(options, QueryPolicy)
 
       nodes = @cluster.nodes
@@ -545,7 +540,7 @@ module Aerospike
     #  This method is only supported by Aerospike 3 servers.
     #  index_type should be :string, :numeric or :geo2dsphere (requires server version 3.7 or later)
     #  collection_type should be :list, :mapkeys or :mapvalues
-    def create_index(namespace, set_name, index_name, bin_name, index_type, collection_type=nil, options={})
+    def create_index(namespace, set_name, index_name, bin_name, index_type, collection_type=nil, options = nil)
       if options.nil? && collection_type.is_a?(Hash)
         options, collection_type = collection_type, nil
       end
@@ -574,7 +569,7 @@ module Aerospike
 
     #  Delete secondary index.
     #  This method is only supported by Aerospike 3 servers.
-    def drop_index(namespace, set_name, index_name, options={})
+    def drop_index(namespace, set_name, index_name, options = nil)
       policy = create_policy(options, WritePolicy)
       str_cmd = "sindex-delete:ns=#{namespace}"
       str_cmd << ";set=#{set_name}" unless set_name.to_s.strip.empty?
@@ -598,7 +593,7 @@ module Aerospike
     # Scan Operations
     #-------------------------------------------------------
 
-    def scan_all(namespace, set_name, bin_names=[], options={})
+    def scan_all(namespace, set_name, bin_names = nil, options = nil)
       policy = create_policy(options, ScanPolicy)
 
       # wait until all migrations are finished
@@ -654,7 +649,7 @@ module Aerospike
 
     # ScanNode reads all records in specified namespace and set, from one node only.
     # The policy can be used to specify timeouts.
-    def scan_node(node, namespace, set_name, bin_names=[], options={})
+    def scan_node(node, namespace, set_name, bin_names = nil, options = nil)
       policy = create_policy(options, ScanPolicy)
       # wait until all migrations are finished
       # TODO: implement
@@ -696,7 +691,7 @@ module Aerospike
     #
     # This method is only supported by Aerospike 3 servers.
     # If the policy is nil, a default policy will be generated.
-    def query(statement, options={})
+    def query(statement, options = nil)
       policy = create_policy(options, QueryPolicy)
       new_policy = policy.clone
 
@@ -732,7 +727,7 @@ module Aerospike
 
     # Create user with password and roles. Clear-text password will be hashed using bcrypt
     # before sending to server.
-    def create_user(user, password, roles, options={})
+    def create_user(user, password, roles, options = nil)
       policy = create_policy(options, AdminPolicy)
       hash = AdminCommand.hash_password(password)
       command = AdminCommand.new
@@ -740,14 +735,14 @@ module Aerospike
     end
 
     # Remove user from cluster.
-    def drop_user(user, options={})
+    def drop_user(user, options = nil)
       policy = create_policy(options, AdminPolicy)
       command = AdminCommand.new
       command.drop_user(@cluster, policy, user)
     end
 
     # Change user's password. Clear-text password will be hashed using bcrypt before sending to server.
-    def change_password(user, password, options={})
+    def change_password(user, password, options = nil)
       raise Aerospike::Exceptions::Aerospike.new(INVALID_USER) unless @cluster.user && @cluster.user != ""
       policy = create_policy(options, AdminPolicy)
 
@@ -766,28 +761,28 @@ module Aerospike
     end
 
     # Add roles to user's list of roles.
-    def grant_roles(user, roles, options={})
+    def grant_roles(user, roles, options = nil)
       policy = create_policy(options, AdminPolicy)
       command = AdminCommand.new
       command.grant_roles(@cluster, policy, user, roles)
     end
 
     # Remove roles from user's list of roles.
-    def revoke_roles(user, roles, options={})
+    def revoke_roles(user, roles, options = nil)
       policy = create_policy(options, AdminPolicy)
       command = AdminCommand.new
       command.revoke_roles(@cluster, policy, user, roles)
     end
 
     # Retrieve roles for a given user.
-    def query_user(user, options={})
+    def query_user(user, options = nil)
       policy = create_policy(options, AdminPolicy)
       command = AdminCommand.new
       command.query_user(@cluster, policy, user)
     end
 
     # Retrieve all users and their roles.
-    def query_users(options={})
+    def query_users(options = nil)
       policy = create_policy(options, AdminPolicy)
       command = AdminCommand.new
       command.query_users(@cluster, policy)
@@ -862,18 +857,41 @@ module Aerospike
       command.execute
     end
 
-    def batch_execute(keys)
-      batch_nodes = BatchNode.generate_list(@cluster, keys)
+    def execute_batch_index_commands(keys)
+      if @cluster.nodes.empty?
+        raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::SERVER_NOT_AVAILABLE, "Executing Batch Index command failed because cluster is empty.")
+      end
+
+      batch_nodes = BatchIndexNode.generate_list(@cluster, keys)
+      threads = []
+
+      batch_nodes.each do |batch|
+        threads << Thread.new do
+          Thread.current.abort_on_exception = true
+          command = yield batch.node, batch
+          execute_command(command)
+        end
+      end
+
+      threads.each(&:join)
+    end
+
+    def execute_batch_direct_commands(keys)
+      if @cluster.nodes.empty?
+        raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::SERVER_NOT_AVAILABLE, "Executing Batch Direct command failed because cluster is empty.")
+      end
+
+      batch_nodes = BatchDirectNode.generate_list(@cluster, keys)
       threads = []
 
       # Use a thread per namespace per node
       batch_nodes.each do |batch_node|
         # copy to avoid race condition
         bn = batch_node
-        bn.batch_namespaces.each do |bns|
+        bn.batch_namespaces.each do |batch|
           threads << Thread.new do
             Thread.current.abort_on_exception = true
-            command = yield bn.node, bns
+            command = yield batch_node.node, batch
             execute_command(command)
           end
         end