aerospike 2.22.0 → 2.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2ad4dc9000e94d5dc8b3c4404e2b68907ba935c196e4061a843f49ec8ad54378
-  data.tar.gz: b55b74f657f46946eccd2ea4005075424234c5d12fa5a9bf77416870c2246928
+  metadata.gz: ee4d21995440d0ab8667220405ddc187b0f9f411563fd5998d7b0b15b6da2be9
+  data.tar.gz: d6e101e2b87b669f7d930b83b19e472d0ddf94ea4e9a1e974425540f273b047a
 SHA512:
-  metadata.gz: 37a3fb668569cbe8ff16318847cd99588f7d54afd342f3d45e397bcf2a241d44c7b1f3f5b2cfe6d98978b65d0babf812d6d51bb5051d9cc6a1aef43845e48c65
-  data.tar.gz: 3c13ca332594f6edc7cafb4eb68aa996afca8d09436053c31f0faf97b3005f011fa97afeb037aa17bc3a0bc9fcb48cfdad22a20639860dada568433055d47d09
+  metadata.gz: d2619ef3fa2d999a0b27211f0859b8b3d62b35ea4dd0f64b76fef6606c1f3ef026aa8cc89bffb63af688b0056e4add4ea189ebcc288c07ad05c18e0cc1445470
+  data.tar.gz: 3461927918426fcc829a81728938db3e5a61788b7c2d22f674f3f5ca011f7e4f71dc87f4953818dbbaa9d1d9bafbffc115d9238401180f00b560a989438bfb63

data/CHANGELOG.md

@@ -2,6 +2,14 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.23.0] 2022-10-25
+
+* **New Features**
+  * [CLIENT-1752] Add 'EXISTS' return type for CDT read operations.
+  * [CLIENT-1195] Support partition scans.
+  * [CLIENT-1238] Support max_records on partition scans.
+  * [CLIENT-1940] Lint and Clean up using Rubocop.
+
 ## [2.22.0] 2022-07-14
 
 * **Fixes**
@@ -10,7 +18,7 @@ All notable changes to this project will be documented in this file.
   * [CLIENT-1789] Authentication Retry fails in certain conditions.
 
 ## [2.21.1] - 2022-06-21
-  
+
 This s hotfix release. It is recommended to upgrade your client if you use authentication.
 
 * **Bug Fixes**

data/lib/aerospike/atomic/atomic.rb

@@ -48,7 +48,7 @@ module Aerospike
         @value = value
       end
     end
-    alias_method 'value='.to_sym, :set
+    alias_method :value=, :set
 
   end # class
 

data/lib/aerospike/cdt/context.rb

@@ -52,7 +52,7 @@ module Aerospike
 	  def self.list_index(index)
 	  	Context.new(0x10, index)
 	  end
-	  
+
 	  ##
 	  # Lookup list by rank.
 	  # 0 = smallest value
@@ -61,13 +61,13 @@ module Aerospike
 	  def self.list_rank(rank)
 	  	Context.new(0x11, rank)
 	  end
-	  
+
 	  ##
 	  # Lookup list by value.
 	  def self.list_value(key)
 	  	Context.new(0x13, key)
 	  end
-	  
+
 	  ##
 	  # Lookup map by index offset.
 	  # If the index is negative, the resolved index starts backwards from end of list.
@@ -80,7 +80,7 @@ module Aerospike
 	  def self.map_index(index)
 	  	Context.new(0x20, index)
 	  end
-	  
+
 	  ##
 	  # Lookup map by rank.
 	  # 0 = smallest value
@@ -89,13 +89,13 @@ module Aerospike
 	  def self.map_rank(rank)
 	  	Context.new(0x21, rank)
 	  end
-	  
+
 	  ##
 	  # Lookup map by key.
 	  def self.map_key(key)
 	  	Context.new(0x22, key)
 	  end
-	  
+
       ##
       # Create map with given type at map key.
       def self.map_key_create(key, order)
@@ -106,7 +106,7 @@ module Aerospike
 	  # Lookup map by value.
 	  def self.map_value(key)
 	  	Context.new(0x23, key)
-	  end      
+	  end
 
     end
   end

data/lib/aerospike/cdt/list_return_type.rb

@@ -60,6 +60,10 @@ module Aerospike
       # Return value for single key read and value list for range read.
       VALUE = 7
 
+      ##
+      # Return true if count > 0.
+      EXISTS = 13
+
       ##
       # :private
       #

data/lib/aerospike/cdt/map_operation.rb

@@ -138,9 +138,7 @@ module Aerospike
       # The map policy dictates the type of map to create when it does not exist.
       # The map policy also specifies the flags used when writing items to the map.
       def self.put(bin_name, key, value, ctx: nil, policy: MapPolicy::DEFAULT)
-        if policy.flags != MapWriteFlags::DEFAULT
-          MapOperation.new(Operation::CDT_MODIFY, PUT, bin_name, key, value, policy.order[:attr], policy.flags, ctx: ctx)
-        else
+        if policy.flags == MapWriteFlags::DEFAULT
           case policy.write_mode
           when MapWriteMode::UPDATE_ONLY
             # Replace doesn't allow map order because it does not create on non-existing key.
@@ -150,6 +148,8 @@ module Aerospike
           else
             MapOperation.new(Operation::CDT_MODIFY, PUT, bin_name, key, value, policy.order[:attr], ctx: ctx)
           end
+        else
+          MapOperation.new(Operation::CDT_MODIFY, PUT, bin_name, key, value, policy.order[:attr], policy.flags, ctx: ctx)
         end
       end
 
@@ -160,9 +160,7 @@ module Aerospike
       # The map policy dictates the type of map to create when it does not exist.
       # The map policy also specifies the flags used when writing items to the map.
       def self.put_items(bin_name, values, ctx: nil, policy: MapPolicy::DEFAULT)
-        if policy.flags != MapWriteFlags::DEFAULT
-          MapOperation.new(Operation::CDT_MODIFY, PUT_ITEMS, bin_name, values, policy.order[:attr], policy.flags, ctx: ctx)
-        else
+        if policy.flags == MapWriteFlags::DEFAULT
           case policy.write_mode
           when MapWriteMode::UPDATE_ONLY
             # Replace doesn't allow map order because it does not create on non-existing key.
@@ -172,6 +170,8 @@ module Aerospike
           else
             MapOperation.new(Operation::CDT_MODIFY, PUT_ITEMS, bin_name, values, policy.order[:attr], ctx: ctx)
           end
+        else
+          MapOperation.new(Operation::CDT_MODIFY, PUT_ITEMS, bin_name, values, policy.order[:attr], policy.flags, ctx: ctx)
         end
       end
 

data/lib/aerospike/cdt/map_return_type.rb

@@ -65,6 +65,10 @@ module Aerospike
       # Return key/value items.
       KEY_VALUE = 8
 
+      ##
+      # Return true if count > 0.
+      EXISTS = 13
+
       ##
       # Default return type: NONE
       DEFAULT_RETURN_TYPE = NONE

data/lib/aerospike/client.rb

@@ -624,13 +624,15 @@ module Aerospike
     # Scan Operations
     #-------------------------------------------------------
 
-    def scan_all(namespace, set_name, bin_names = nil, options = nil)
+    # Reads records in specified namespace and set using partition filter.
+    # If the policy's concurrent_nodes is specified, each server node will be read in
+    # parallel. Otherwise, server nodes are read sequentially.
+    # If partition_filter is nil, all partitions will be scanned.
+    # If the policy is nil, the default relevant policy will be used.
+    # This method is only supported by Aerospike 4.9+ servers.
+    def scan_partitions(partition_filter, namespace, set_name, bin_names = nil, options = nil)
       policy = create_policy(options, ScanPolicy, default_scan_policy)
 
-      # wait until all migrations are finished
-      # TODO: implement
-      # @cluster.WaitUntillMigrationIsFinished(policy.timeout)
-
       # Retry policy must be one-shot for scans.
       # copy on write for policy
       new_policy = policy.clone
@@ -640,80 +642,53 @@ module Aerospike
         raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::SERVER_NOT_AVAILABLE, "Scan failed because cluster is empty.")
       end
 
-      recordset = Recordset.new(policy.record_queue_size, nodes.length, :scan)
-
-      if policy.concurrent_nodes
-        # Use a thread per node
-        nodes.each do |node|
-          partitions = node.cluster.node_partitions(node, namespace)
-          Thread.new do
-            Thread.current.abort_on_exception = true
-            command = ScanCommand.new(node, new_policy, namespace, set_name, bin_names, recordset, partitions)
-            begin
-              execute_command(command)
-            rescue => e
-              Aerospike.logger.error(e.backtrace.join("\n")) unless e == SCAN_TERMINATED_EXCEPTION
-              recordset.cancel(e)
-            ensure
-              recordset.thread_finished
-            end
-          end
-        end
-      else
-        Thread.new do
-          Thread.current.abort_on_exception = true
-          nodes.each do |node|
-            partitions = node.cluster.node_partitions(node, namespace)
-            command = ScanCommand.new(node, new_policy, namespace, set_name, bin_names, recordset, partitions)
-            begin
-              execute_command(command)
-            rescue => e
-              Aerospike.logger.error(e.backtrace.join("\n")) unless e == SCAN_TERMINATED_EXCEPTION
-              recordset.cancel(e)
-            ensure
-              recordset.thread_finished
-            end
-          end
-        end
+      tracker = Aerospike::PartitionTracker.new(policy, nodes, partition_filter)
+      recordset = Recordset.new(policy.record_queue_size, 1, :scan)
+      Thread.new do
+        Thread.current.abort_on_exception = true
+        ScanExecutor.scan_partitions(policy, @cluster, tracker, namespace, set_name, recordset, bin_names)
       end
 
       recordset
     end
 
-    # 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 = nil, options = nil)
+    # Reads all records in specified namespace and set for one node only.
+    # If the policy is nil, the default relevant policy will be used.
+    def scan_node_partitions(node, namespace, set_name, bin_names = nil, options = nil)
       policy = create_policy(options, ScanPolicy, default_scan_policy)
-      # wait until all migrations are finished
-      # TODO: implement
-      # @cluster.WaitUntillMigrationIsFinished(policy.timeout)
 
       # Retry policy must be one-shot for scans.
       # copy on write for policy
       new_policy = policy.clone
-      new_policy.max_retries = 0
 
-      node = @cluster.get_node_by_name(node) unless node.is_a?(Aerospike::Node)
+      unless node.active?
+        raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::SERVER_NOT_AVAILABLE, "Scan failed because cluster is empty.")
+      end
 
+      tracker = Aerospike::PartitionTracker.new(policy, [node])
       recordset = Recordset.new(policy.record_queue_size, 1, :scan)
-
-      partitions = node.cluster.node_partitions(node, namespace)
       Thread.new do
         Thread.current.abort_on_exception = true
-        command = ScanCommand.new(node, new_policy, namespace, set_name, bin_names, recordset, partitions)
-        begin
-          execute_command(command)
-        rescue => e
-          Aerospike.logger.error(e.backtrace.join("\n")) unless e == SCAN_TERMINATED_EXCEPTION
-          recordset.cancel(e)
-        ensure
-          recordset.thread_finished
-        end
+        ScanExecutor.scan_partitions(policy, @cluster, tracker, namespace, set_name, recordset, bin_names)
       end
 
       recordset
     end
 
+    # Reads all records in specified namespace and set from all nodes.
+    # If the policy's concurrent_nodes is specified, each server node will be read in
+    # parallel. Otherwise, server nodes are read sequentially.
+    # If the policy is nil, the default relevant policy will be used.
+    def scan_all(namespace, set_name, bin_names = nil, options = nil)
+      scan_partitions(Aerospike::PartitionFilter.all, namespace, set_name, bin_names, options)
+    end
+
+    # 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 = nil, options = nil)
+      scan_node_partitions(node, namespace, set_name, bin_names, options)
+    end
+
     #--------------------------------------------------------
     # Query functions (Supported by Aerospike 3 servers only)
     #--------------------------------------------------------

data/lib/aerospike/command/admin_command.rb

@@ -653,7 +653,7 @@ module Aerospike
         list << s
       end
 
-      list      
+      list
     end
 
   end

data/lib/aerospike/command/batch_index_node.rb

@@ -30,7 +30,7 @@ module Aerospike
 
     def initialize(node, keys_with_idx)
       @node = node
-      @keys_by_idx = Hash[keys_with_idx.map(&:reverse)]
+      @keys_by_idx = keys_with_idx.map(&:reverse).to_h
     end
 
     def keys

data/lib/aerospike/command/batch_item.rb

@@ -28,7 +28,7 @@ module Aerospike
         .map { |key, keys_with_idx|
           [key.digest, BatchItem.new(key, keys_with_idx.map(&:last))]
         }
-      Hash[map]
+      map.to_h
     end
 
     def initialize(key, indexes)

data/lib/aerospike/command/command.rb

@@ -112,7 +112,7 @@ module Aerospike
     def set_write(policy, operation, key, bins)
       begin_cmd
       field_count = estimate_key_size(key, policy)
-      
+
       predexp_size = estimate_predexp(policy.predexp)
       field_count += 1 if predexp_size > 0
 
@@ -138,7 +138,7 @@ module Aerospike
     def set_delete(policy, key)
       begin_cmd
       field_count = estimate_key_size(key)
-      
+
       predexp_size = estimate_predexp(policy.predexp)
       field_count += 1 if predexp_size > 0
 
@@ -153,7 +153,7 @@ module Aerospike
     def set_touch(policy, key)
       begin_cmd
       field_count = estimate_key_size(key)
-      
+
       predexp_size = estimate_predexp(policy.predexp)
       field_count += 1 if predexp_size > 0
 
@@ -170,7 +170,7 @@ module Aerospike
     def set_exists(policy, key)
       begin_cmd
       field_count = estimate_key_size(key)
-      
+
       predexp_size = estimate_predexp(policy.predexp)
       field_count += 1 if predexp_size > 0
 
@@ -185,7 +185,7 @@ module Aerospike
     def set_read_for_key_only(policy, key)
       begin_cmd
       field_count = estimate_key_size(key)
-      
+
       predexp_size = estimate_predexp(policy.predexp)
       field_count += 1 if predexp_size > 0
 
@@ -201,7 +201,7 @@ module Aerospike
       if bin_names && bin_names.length > 0
         begin_cmd
         field_count = estimate_key_size(key)
-        
+
         predexp_size = estimate_predexp(policy.predexp)
         field_count += 1 if predexp_size > 0
 
@@ -229,7 +229,7 @@ module Aerospike
     def set_read_header(policy, key)
       begin_cmd
       field_count = estimate_key_size(key)
-      
+
       predexp_size = estimate_predexp(policy.predexp)
       field_count += 1 if predexp_size > 0
 
@@ -252,7 +252,7 @@ module Aerospike
     def set_operate(policy, key, operations)
       begin_cmd
       field_count = estimate_key_size(key, policy)
-      
+
       predexp_size = estimate_predexp(policy.predexp)
       field_count += 1 if predexp_size > 0
 
@@ -263,7 +263,7 @@ module Aerospike
 
       operations.each do |operation|
         case operation.op_type
-        when Aerospike::Operation::READ, Aerospike::Operation::CDT_READ, 
+        when Aerospike::Operation::READ, Aerospike::Operation::CDT_READ,
               Aerospike::Operation::HLL_READ, Aerospike::Operation::BIT_READ
           read_attr |= INFO1_READ
 
@@ -282,7 +282,7 @@ module Aerospike
           write_attr = INFO2_WRITE
         end
 
-        if [Aerospike::Operation::HLL_MODIFY, Aerospike::Operation::HLL_READ, 
+        if [Aerospike::Operation::HLL_MODIFY, Aerospike::Operation::HLL_READ,
               Aerospike::Operation::BIT_MODIFY, Aerospike::Operation::BIT_READ].include?(operation.op_type)
           record_bin_multiplicity = true
         end
@@ -294,10 +294,10 @@ module Aerospike
 
       write_attr |= INFO2_RESPOND_ALL_OPS if write_attr != 0 && record_bin_multiplicity
 
-      if write_attr != 0
-        write_header_with_policy(policy, read_attr, write_attr, field_count, operations.length)
-      else
+      if write_attr == 0
         write_header(policy, read_attr, write_attr, field_count, operations.length)
+      else
+        write_header_with_policy(policy, read_attr, write_attr, field_count, operations.length)
       end
       write_key(key, policy)
       write_predexp(policy.predexp, predexp_size)
@@ -315,7 +315,7 @@ module Aerospike
     def set_udf(policy, key, package_name, function_name, args)
       begin_cmd
       field_count = estimate_key_size(key, policy)
-      
+
       predexp_size = estimate_predexp(policy.predexp)
       field_count += 1 if predexp_size > 0
 
@@ -335,11 +335,15 @@ module Aerospike
       mark_compressed(policy)
     end
 
-    def set_scan(policy, namespace, set_name, bin_names, partitions)
+    def set_scan(policy, namespace, set_name, bin_names, node_partitions)
       # Estimate buffer size
       begin_cmd
       field_count = 0
 
+      parts_full_size = node_partitions.parts_full.length * 2
+      parts_partial_size = node_partitions.parts_partial.length * 20
+      max_records = node_partitions.record_max
+
       if namespace
         @data_offset += namespace.bytesize + FIELD_HEADER_SIZE
         field_count += 1
@@ -349,7 +353,22 @@ module Aerospike
         @data_offset += set_name.bytesize + FIELD_HEADER_SIZE
         field_count += 1
       end
-      
+
+      if parts_full_size > 0
+        @data_offset += parts_full_size + FIELD_HEADER_SIZE
+        field_count += 1
+      end
+
+      if parts_partial_size > 0
+        @data_offset += parts_partial_size + FIELD_HEADER_SIZE
+        field_count += 1
+      end
+
+      if max_records > 0
+        @data_offset += 8 + FIELD_HEADER_SIZE
+        field_count += 1
+      end
+
       if policy.records_per_second > 0
         @data_offset += 4 + FIELD_HEADER_SIZE
         field_count += 1
@@ -362,9 +381,6 @@ module Aerospike
       # @data_offset += 2 + FIELD_HEADER_SIZE
       # field_count += 1
 
-      @data_offset += partitions.length * 2 + FIELD_HEADER_SIZE
-      field_count += 1
-
       # Estimate scan timeout size.
       @data_offset += 4 + FIELD_HEADER_SIZE
       field_count += 1
@@ -378,7 +394,7 @@ module Aerospike
       size_buffer
       read_attr = INFO1_READ
 
-      if !policy.include_bin_data
+      unless policy.include_bin_data
         read_attr |= INFO1_NOBINDATA
       end
 
@@ -397,10 +413,26 @@ module Aerospike
         write_field_string(set_name, Aerospike::FieldType::TABLE)
       end
 
-      write_field_header(partitions.length * 2, Aerospike::FieldType::PID_ARRAY)
-      for pid in partitions
-          @data_buffer.write_uint16_little_endian(pid, @data_offset)
-          @data_offset += 2
+      if parts_full_size > 0
+        write_field_header(parts_full_size, Aerospike::FieldType::PID_ARRAY)
+
+        node_partitions.parts_full.each do |part|
+          @data_buffer.write_uint16_little_endian(part.id, @data_offset)
+          @data_offset+=2
+        end
+      end
+
+      if parts_partial_size > 0
+        write_field_header(parts_partial_size, Aerospike::FieldType::DIGEST_ARRAY)
+
+        node_partitions.parts_partial.each do |part|
+          @data_buffer.write_binary(part.digest, @data_offset)
+          @data_offset+=part.digest.length
+        end
+      end
+
+      if max_records > 0
+        write_field_int64(max_records, Aerospike::FieldType::MAX_RECORDS)
       end
 
       if policy.records_per_second > 0
@@ -809,6 +841,12 @@ module Aerospike
       @data_offset += 4
     end
 
+    def write_field_int64(i, ftype)
+      @data_buffer.write_int64(i, @data_offset+FIELD_HEADER_SIZE)
+      write_field_header(8, ftype)
+      @data_offset += 8
+    end
+
     def write_field_bytes(bytes, ftype)
       @data_buffer.write_binary(bytes, @data_offset+FIELD_HEADER_SIZE)
       write_field_header(bytes.bytesize, ftype)

data/lib/aerospike/command/field_type.rb

@@ -33,6 +33,9 @@ module Aerospike
     SCAN_TIMEOUT = 9
     RECORDS_PER_SECOND = 10
     PID_ARRAY = 11
+    DIGEST_ARRAY = 12
+    MAX_RECORDS = 13
+    BVAL_ARRAY = 15
     INDEX_NAME = 21
     INDEX_RANGE = 22
     INDEX_FILTER = 23

data/lib/aerospike/command/login_command.rb

@@ -69,7 +69,7 @@ module Aerospike
 
         result = @data_buffer.read(RESULT_CODE)
 
-        if result != 0 
+        if result != 0
           return if result == Aerospike::ResultCode::SECURITY_NOT_ENABLED
           raise Exceptions::Aerospike.new(result, "Authentication failed")
         end
@@ -128,11 +128,11 @@ module Aerospike
     def authenticate_via_token(conn, cluster)
       @data_offset = 8
       policy = cluster.client_policy
-      if policy.auth_mode != Aerospike::AuthMode::PKI
+      if policy.auth_mode == Aerospike::AuthMode::PKI
+        write_header(AUTHENTICATE, 1)
+      else
         write_header(AUTHENTICATE, 2)
         write_field_str(USER, policy.user)
-      else
-        write_header(AUTHENTICATE, 1)
       end
 
       write_field_bytes(SESSION_TOKEN, cluster.session_token) if cluster.session_token

data/lib/aerospike/command/multi_command.rb

@@ -32,6 +32,9 @@ module Aerospike
       @compressed_data_buffer = nil
       @compressed_data_offset = nil
 
+      @node_partitions = nil
+      @tracker = nil
+
       self
     end
 
@@ -97,8 +100,9 @@ module Aerospike
 
         # The only valid server return codes are "ok", "not found" and "filtered out".
         # If other return codes are received, then abort the batch.
-        if result_code != 0 
+        if result_code != 0
             if result_code == Aerospike::ResultCode::KEY_NOT_FOUND_ERROR || result_code == Aerospike::ResultCode::FILTERED_OUT
+              # NOOP
             else
               raise Aerospike::Exceptions::Aerospike.new(result_code)
             end
@@ -142,12 +146,14 @@ module Aerospike
           set_name = @data_buffer.read(1, size).force_encoding('utf-8')
         when Aerospike::FieldType::KEY
           user_key = Aerospike::bytes_to_key_value(@data_buffer.read(1).ord, @data_buffer, 2, size-1)
+        when Aerospike::FieldType::BVAL_ARRAY
+          bval = @data_buffer.read_uint64_little_endian(1)
         end
 
         i = i.succ
       end
 
-      Aerospike::Key.new(namespace, set_name, user_key, digest)
+      Aerospike::Key.new(namespace, set_name, user_key, digest, bval: bval)
     end
 
     def skip_key(field_count)

data/lib/aerospike/command/read_command.rb

@@ -98,7 +98,7 @@ module Aerospike
       receive_size = (sz & 0xFFFFFFFFFFFF) - header_length
 
       # Read remaining message bytes.
-      if compressed_sz 
+      if compressed_sz
         @data_buffer.eat!(MSG_TOTAL_HEADER_SIZE)
       elsif receive_size > 0
         size_buffer_sz(receive_size)
@@ -117,7 +117,7 @@ module Aerospike
           @record = Record.new(@node, @key, nil, generation, expiration)
           return
         end
-  
+
         @record = parse_record(op_count, field_count, generation, expiration)
         return
       end

data/lib/aerospike/connection/authenticate.rb

@@ -38,9 +38,7 @@ module Aerospike
 
         def call(conn, cluster)
           command = LoginCommand.new
-          if !cluster.session_valid?
-            command.authenticate_new(conn, cluster)
-          else
+          if cluster.session_valid?
             begin
               command.authenticate_via_token(conn, cluster)
             rescue => ae
@@ -54,6 +52,8 @@ module Aerospike
               end
               raise ae
             end
+          else
+            command.authenticate_new(conn, cluster)
           end
 
           true