aerospike 2.24.0 → 2.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: edbb7242a54e005f9be1be27da358cca13e6a0ce74013976610eb6c16d99fd45
-  data.tar.gz: fa8f76a0176381cd41ec11a6554589bfed9b90c2630bb2e4a1551d2704dac26a
+  metadata.gz: 569388197af73988d3965e15f8b7caf42605896f21183a0e6f7d507690dec816
+  data.tar.gz: dfe35172403817d176aecfd83747e6155a961b92960a97f8efc713a6b7540d23
 SHA512:
-  metadata.gz: 4369da31ee5502c9aca145e11777ca39c2a1a4c0d08ff539375a0f4c05aea4d6113a70ee2f645c4c5c3b01b483bf481fa1e2ca5598ff099126827101f1bdadf7
-  data.tar.gz: fdc7964d17f671795a3fd09d786b809eeeba88cc435ae336072ca7aff1767b8cd0b778bf28fbb27dd4e3651d976ca74b179d8379c8f57a833c4e3dbaa861dd6e
+  metadata.gz: e4de68155586c168c75a51c71749531becdf066cb22888745f8473237cb775dd9054c6401e44a04b00bee517848859d128141692da3fc7c970df2f202e5e49b9
+  data.tar.gz: 7c041a196f2bf45a3ff575426b9269ba45c10e16f641c82f5ce11e362ace013d2480c407b8f1e9a663a27bcf78df1988d6af46de2bd22d41c0fce5366fb2a52c

data/CHANGELOG.md

@@ -2,6 +2,33 @@
 
 All notable changes to this project will be documented in this file.
 
+## [2.26.0] 2022-12-02
+
+- **New Features**
+  - [CLIENT-1808] Support creating a secondary index on elements within a CDT using `Context`.
+  - [CLIENT-1991] Add base64 encoding methods to `Context`.
+  - [CLIENT-2007] Support using `Context` in query filters.
+
+## [2.25.0] 2022-11-28
+
+- **New Features**
+
+  - [CLIENT-1984] Support scan-show and query-show info commands.
+
+  - [CLIENT-1362] Adds support Aerospike Expression filters. Expression filters are now supported on all commands, including `Client#get`, `Client#put`, `Client#delete`, `Client#operate`, `Client#scan`, `Client#query`, `Client#execute_udf`, etc.
+
+    - Adds `Policy#filter_exp` and `Policy#fail_on_filtered_out`
+
+    - Bit expressions: `Exp::Bit::` `#resize`, `#insert`, `#remove`, `#set`, `#or`, `#xor`, `#and`, `#not`, `#lshift`, `#rshift`, `#add`, `#subtract`, `#set_int`, `#get`, `#count`, `#lscan`, `#rscan`, `#get_int`, `#pack_math`, `#pack_get_int`, `#add_write`, `#add_read`
+
+    - HLL Expressions: `Exp::HLL::` `#init`, `#add`, `#get_count`, `#get_union`, `#get_union_count`, `#get_intersect_count`, `#get_similarity`, `#describe`, `#may_contain`, `#add_write`, `#add_read`
+
+    - Map Expressions: `Exp::Map::` `#put`, `#put_items`, `#increment`, `#clear`, `#remove_by_key`, `#remove_by_key_list`, `#remove_by_key_range`, `#remove_by_key_relative_index_range`, `#remove_by_value`, `#remove_by_value_list`, `#remove_by_value_range`, `#remove_by_value_relative_rank_range`, `#remove_by_value_relative_rank_range`, `#remove_by_index`, `#remove_by_index_range`, `#remove_by_rank`, `#remove_by_rank_range`, `#size`, `#get_by_key`, `#get_by_key_range`, `#get_by_key_list`, `#get_by_key_relative_index_range`, `#get_by_key_relative_index_range`, `#get_by_value`, `#get_by_value_range`, `#get_by_value_list`, `#get_by_value_relative_rank_range`, `#get_by_index`, `#get_by_index_range`, `#get_by_rank`, `#get_by_rank_range`, `#add_write`, `#add_read`, `#get_value_type`
+
+    - List Expressions: `Exp::List::` `#append`, `#append_items`, `#insert`, `#insert_items`, `#increment`, `#set`, `#clear`, `#sort`, `#remove_by_value`, `#remove_by_value_list`, `#remove_by_value_range`, `#remove_by_value_relative_rank_range`, `#remove_by_index`, `#remove_by_index_range`, `#remove_by_rank`, `#remove_by_rank_range`, `#size`, `#get_by_value`, `#get_by_value_range`, `#get_by_value_list`, `#get_by_value_relative_rank_range`, `#get_by_index`, `#get_by_index_range`, `#get_by_index_range`, `#get_by_rank`, `#get_by_rank_range`, `#get_by_rank_range`, `#add_write`, `#add_read`, `#get_value_type`, `#pack_range_operation`
+
+    - Read and Write operations: `Exp::Operation::` `#write`, `#read`
+
 ## [2.24.0] 2022-11-15
 
 - **New Features**

data/lib/aerospike/cdt/context.rb

@@ -17,16 +17,17 @@
 # License for the specific language governing permissions and limitations under
 # the License.
 
+require "base64"
+
 module Aerospike
   module CDT
 
-  	##
-	# Nested CDT context. Identifies the location of nested list/map to apply the operation.
-	# for the current level.
-	# An array of CTX identifies location of the list/map on multiple
-	# levels on nesting.
+    ##
+    # Nested CDT context. Identifies the location of nested list/map to apply the operation.
+    # for the current level.
+    # An array of CTX identifies location of the list/map on multiple
+    # levels on nesting.
     class Context
-
       attr_accessor :id, :value
 
       def initialize(id, value)
@@ -37,64 +38,64 @@ module Aerospike
       ##
       # Create list with given type at index offset, given an order and pad.
       def self.list_index_create(index, order, pad)
-      Context.new(0x10 | ListOrder.flag(order, pad), index)
-      end
-
-	  ##
-	  # Lookup list by index offset.
-	  # If the index is negative, the resolved index starts backwards from end of list.
-	  # If an index is out of bounds, a parameter error will be returned.
-	  # Examples:
-	  # 0: First item.
-	  # 4: Fifth item.
-	  # -1: Last item.
-	  # -3: Third to last item.
-	  def self.list_index(index)
-	  	Context.new(0x10, index)
-	  end
-
-	  ##
-	  # Lookup list by rank.
-	  # 0 = smallest value
-	  # N = Nth smallest value
-	  # -1 = largest value
-	  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.
-	  # If an index is out of bounds, a parameter error will be returned.
-	  # Examples:
-	  # 0: First item.
-	  # 4: Fifth item.
-	  # -1: Last item.
-	  # -3: Third to last item.
-	  def self.map_index(index)
-	  	Context.new(0x20, index)
-	  end
-
-	  ##
-	  # Lookup map by rank.
-	  # 0 = smallest value
-	  # N = Nth smallest value
-	  # -1 = largest value
-	  def self.map_rank(rank)
-	  	Context.new(0x21, rank)
-	  end
-
-	  ##
-	  # Lookup map by key.
-	  def self.map_key(key)
-	  	Context.new(0x22, key)
-	  end
+        Context.new(0x10 | ListOrder.flag(order, pad), index)
+      end
+
+      ##
+      # Lookup list by index offset.
+      # If the index is negative, the resolved index starts backwards from end of list.
+      # If an index is out of bounds, a parameter error will be returned.
+      # Examples:
+      # 0: First item.
+      # 4: Fifth item.
+      # -1: Last item.
+      # -3: Third to last item.
+      def self.list_index(index)
+        Context.new(0x10, index)
+      end
+
+      ##
+      # Lookup list by rank.
+      # 0 = smallest value
+      # N = Nth smallest value
+      # -1 = largest value
+      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.
+      # If an index is out of bounds, a parameter error will be returned.
+      # Examples:
+      # 0: First item.
+      # 4: Fifth item.
+      # -1: Last item.
+      # -3: Third to last item.
+      def self.map_index(index)
+        Context.new(0x20, index)
+      end
+
+      ##
+      # Lookup map by rank.
+      # 0 = smallest value
+      # N = Nth smallest value
+      # -1 = largest value
+      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.
@@ -102,12 +103,78 @@ module Aerospike
         Context.new(0x22 | order[:flag], key)
       end
 
-	  ##
-	  # Lookup map by value.
-	  def self.map_value(key)
-	  	Context.new(0x23, key)
-	  end
+      ##
+      # Lookup map by value.
+      def self.map_value(key)
+        Context.new(0x23, key)
+      end
+
+      ##
+      # Encodes the context via message pack.
+      def self.pack(packer, ctx)
+        unless ctx.to_a.empty?
+          packer.write_array_header(2)
+          ctx.each do |c|
+            packer.write(c.id)
+            Value.of(c.value)
+          end
+        end
+      end
+
+      ##
+      # Encodes the context via message pack and return the results.
+      def self.bytes(ctx)
+        unless ctx.to_a.empty?
+          Packer.use do |packer|
+            packer.write_array_header(ctx.length * 2)
+            ctx.each do |c|
+              packer.write(c.id)
+              Value.of(c.value).pack(packer)
+            end
+            return packer.bytes
+          end
+        end
+        nil
+      end
+
+      def ==(other)
+        self.id == other.id && self.value == other.value
+      end
 
+      ##
+      # decodes the base64 encoded messagepack byte array
+      # and converts it to an array of Context.
+      def self.from_bytes(buf)
+        list = nil
+        Unpacker.use do |unpacker|
+          list = unpacker.unpack(buf)
+        end
+
+        unless list.length % 2 == 0
+          raise Exceptions::Aerospike.new(Aerospike::ResultCode::PARAMETER_ERROR, "Invalid buffer")
+        end
+
+        list.each_slice(2).map { |id, value| Context.new(id, value) }
+      end
+
+      ##
+      # Encodes the context array to messagepack and then encodes
+      # the resulting byte array to base64.
+      def self.base64(ctx)
+        unless ctx.to_a.empty?
+          data = self.bytes(ctx)
+          return Base64.strict_encode64(data).force_encoding("binary")
+        end
+        ""
+      end
+
+      ##
+      # Decodes the byte array to messagepack and then decodes
+      # the resulting byte array to an array of Context.
+      def self.from_base64(buf)
+        bytes = Base64.strict_decode64(buf)
+        self.from_bytes(bytes)
+      end
     end
   end
 end

data/lib/aerospike/cdt/map_policy.rb

@@ -17,8 +17,8 @@
 module Aerospike
   module CDT
     class MapPolicy
-
       attr_accessor :order, :write_mode, :flags
+      attr_accessor :item_command, :items_command, :attributes
 
       def initialize(order: nil, write_mode: nil, flags: nil)
         if write_mode && flags
@@ -28,10 +28,24 @@ module Aerospike
         @order = order || MapOrder::DEFAULT
         @write_mode = write_mode || MapWriteMode::DEFAULT
         @flags = flags || MapWriteFlags::DEFAULT
+        @attributes = order ? order[:attr] : 0
+
+        case @write_mode
+        when CDT::MapWriteMode::DEFAULT
+          @item_command = CDT::MapOperation::PUT
+          @items_command = CDT::MapOperation::PUT_ITEMS
+        when CDT::MapWriteMode::UPDATE_ONLY
+          @item_command = CDT::MapOperation::REPLACE
+          @items_command = CDT::MapOperation::REPLACE_ITEMS
+        when CDT::MapWriteMode::CREATE_ONLY
+          @item_command = CDT::MapOperation::ADD
+          @items_command = CDT::MapOperation::ADD_ITEMS
+        else
+          raise Exceptions.new(ResultCode::PARAMETER_ERROR, "invalid value for MapWriteMode #{write_mode}")
+        end
       end
 
       DEFAULT = MapPolicy.new
-
     end
   end
 end

data/lib/aerospike/cdt/map_return_type.rb

@@ -69,10 +69,18 @@ module Aerospike
       # Return true if count > 0.
       EXISTS = 13
 
+      ##
+      #  :private
+      #
+      # TODO: Should be like ListOperation and Implement InvertibleMapOperation
+      # Inverts meaning of map command and return values. For example:
+      # map_remove_by_key_range(bin_name, key_begin, key_end, MapReturnType::KEY | MapReturnType::INVERTED)
+      # With the INVERTED flag enabled, the keys outside of the specified key range will be removed and returned.
+      INVERTED = 0x10000
+
       ##
       # Default return type: NONE
       DEFAULT_RETURN_TYPE = NONE
-
     end
   end
 end

data/lib/aerospike/client.rb

@@ -15,8 +15,8 @@
 # License for the specific language governing permissions and limitations under
 # the License.
 
-require 'digest'
-require 'base64'
+require "digest"
+require "base64"
 
 module Aerospike
 
@@ -36,7 +36,6 @@ module Aerospike
   # +:fail_if_not_connected+ set to true
 
   class Client
-
     attr_accessor :default_admin_policy
     attr_accessor :default_batch_policy
     attr_accessor :default_info_policy
@@ -48,8 +47,7 @@ module Aerospike
     attr_accessor :cluster
 
     def initialize(hosts = nil, policy: ClientPolicy.new, connect: true)
-
-      hosts = ::Aerospike::Host::Parse.(hosts || ENV['AEROSPIKE_HOSTS'] || 'localhost')
+      hosts = ::Aerospike::Host::Parse.(hosts || ENV["AEROSPIKE_HOSTS"] || "localhost")
       policy = create_policy(policy, ClientPolicy)
       set_default_policies(policy.policies)
       @cluster = Cluster.new(policy, hosts)
@@ -249,7 +247,7 @@ module Aerospike
       end
 
       response = send_info_command(policy, str_cmd, node).upcase
-      return if response == 'OK'
+      return if response == "OK"
       raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::SERVER_ERROR, "Truncate failed: #{response}")
     end
 
@@ -386,7 +384,8 @@ module Aerospike
     def operate(key, operations, options = nil)
       policy = create_policy(options, OperatePolicy, default_operate_policy)
 
-      command = OperateCommand.new(@cluster, policy, key, operations)
+      args = OperateArgs.new(cluster, policy, default_write_policy, default_operate_policy, key, operations)
+      command = OperateCommand.new(@cluster, key, args)
       execute_command(command)
       command.record
     end
@@ -415,7 +414,7 @@ module Aerospike
     def register_udf(udf_body, server_path, language, options = nil)
       policy = create_policy(options, Policy, default_info_policy)
 
-      content = Base64.strict_encode64(udf_body).force_encoding('binary')
+      content = Base64.strict_encode64(udf_body).force_encoding("binary")
       str_cmd = "udf-put:filename=#{server_path};content=#{content};"
       str_cmd << "content-len=#{content.length};udf-type=#{language};"
 
@@ -424,15 +423,15 @@ module Aerospike
 
       res = {}
       response_map.each do |k, response|
-        vals = response.to_s.split(';')
+        vals = response.to_s.split(";")
         vals.each do |pair|
           k, v = pair.split("=", 2)
           res[k] = v
         end
       end
 
-      if res['error']
-        raise Aerospike::Exceptions::CommandRejected.new("Registration failed: #{res['error']}\nFile: #{res['file']}\nLine: #{res['line']}\nMessage: #{res['message']}")
+      if res["error"]
+        raise Aerospike::Exceptions::CommandRejected.new("Registration failed: #{res["error"]}\nFile: #{res["file"]}\nLine: #{res["line"]}\nMessage: #{res["message"]}")
       end
 
       UdfRegisterTask.new(@cluster, server_path)
@@ -454,7 +453,7 @@ module Aerospike
       response_map = @cluster.request_info(policy, str_cmd)
       _, response = response_map.first
 
-      if response == 'ok'
+      if response == "ok"
         UdfRemoveTask.new(@cluster, udf_name)
       else
         raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::SERVER_ERROR, response)
@@ -466,27 +465,27 @@ module Aerospike
     def list_udf(options = nil)
       policy = create_policy(options, Policy, default_info_policy)
 
-      str_cmd = 'udf-list'
+      str_cmd = "udf-list"
 
       # Send command to one node. That node will distribute it to other nodes.
       response_map = @cluster.request_info(policy, str_cmd)
       _, response = response_map.first
 
-      vals = response.split(';')
+      vals = response.split(";")
 
       vals.map do |udf_info|
-        next if udf_info.strip! == ''
+        next if udf_info.strip! == ""
 
-        udf_parts = udf_info.split(',')
+        udf_parts = udf_info.split(",")
         udf = UDF.new
         udf_parts.each do |values|
-          k, v = values.split('=', 2)
+          k, v = values.split("=", 2)
           case k
-          when 'filename'
+          when "filename"
             udf.filename = v
-          when 'hash'
+          when "hash"
             udf.hash = v
-          when 'type'
+          when "type"
             udf.language = v
           end
         end
@@ -501,7 +500,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 = nil)
+    def execute_udf(key, package_name, function_name, args = [], options = nil)
       policy = create_policy(options, WritePolicy, default_write_policy)
 
       command = ExecuteCommand.new(@cluster, policy, key, package_name, function_name, args)
@@ -514,10 +513,10 @@ module Aerospike
       result_map = record.bins
 
       # User defined functions don't have to return a value.
-      key, obj = result_map.detect{ |k, _| k.include?('SUCCESS') }
+      key, obj = result_map.detect { |k, _| k.include?("SUCCESS") }
       return obj if key
 
-      key, obj = result_map.detect{ |k, _| k.include?('FAILURE') }
+      key, obj = result_map.detect { |k, _| k.include?("FAILURE") }
       message = key ? obj.to_s : "Invalid UDF return value"
       raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::UDF_BAD_RESPONSE, message)
     end
@@ -530,7 +529,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 = nil)
+    def execute_udf_on_query(statement, package_name, function_name, function_args = [], options = nil)
       policy = create_policy(options, QueryPolicy, default_query_policy)
 
       nodes = @cluster.nodes
@@ -559,7 +558,6 @@ module Aerospike
       ExecuteTask.new(@cluster, statement)
     end
 
-
     #  Create secondary index.
     #  This asynchronous server call will return before command is complete.
     #  The user can optionally wait for command completion by using the returned
@@ -568,7 +566,8 @@ 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 = nil)
+    #  ctx is an optional list of context. Supported on server v6.1+.
+    def create_index(namespace, set_name, index_name, bin_name, index_type, collection_type = nil, options = nil, ctx: nil)
       if options.nil? && collection_type.is_a?(Hash)
         options, collection_type = collection_type, nil
       end
@@ -577,18 +576,19 @@ module Aerospike
       str_cmd = "sindex-create:ns=#{namespace}"
       str_cmd << ";set=#{set_name}" unless set_name.to_s.strip.empty?
       str_cmd << ";indexname=#{index_name};numbins=1"
+      str_cmd << ";context=#{CDT::Context.base64(ctx)}" unless ctx.to_a.empty?
       str_cmd << ";indextype=#{collection_type.to_s.upcase}" if collection_type
       str_cmd << ";indexdata=#{bin_name},#{index_type.to_s.upcase}"
       str_cmd << ";priority=normal"
 
       # Send index command to one node. That node will distribute the command to other nodes.
       response = send_info_command(policy, str_cmd).upcase
-      if response == 'OK'
+      if response == "OK"
         # Return task that could optionally be polled for completion.
         return IndexTask.new(@cluster, namespace, index_name)
       end
 
-      if response.start_with?('FAIL:200')
+      if response.start_with?("FAIL:200")
         # Index has already been created.  Do not need to poll for completion.
         return IndexTask.new(@cluster, namespace, index_name, true)
       end
@@ -607,10 +607,10 @@ module Aerospike
 
       # Send index command to one node. That node will distribute the command to other nodes.
       response = send_info_command(policy, str_cmd).upcase
-      return if response == 'OK'
+      return if response == "OK"
 
       # Index did not previously exist. Return without error.
-      return if response.start_with?('FAIL:201')
+      return if response.start_with?("FAIL:201")
 
       raise Aerospike::Exceptions::Aerospike.new(Aerospike::ResultCode::INDEX_GENERIC, "Drop index failed: #{response}")
     end
@@ -966,7 +966,5 @@ module Aerospike
 
       threads.each(&:join)
     end
-
   end # class
-
 end # module