aerospike 2.25.0 → 2.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12a4c3d56df63146053710f4438b8030672d76d9fa01cf4ddf5453429d275e11
-  data.tar.gz: '025678955679feb936123140c4bce14117a85ac954eb0e3d294960269cfa9b92'
+  metadata.gz: 569388197af73988d3965e15f8b7caf42605896f21183a0e6f7d507690dec816
+  data.tar.gz: dfe35172403817d176aecfd83747e6155a961b92960a97f8efc713a6b7540d23
 SHA512:
-  metadata.gz: 2e5d828c912aaa9a189de8c7d1441bb255b4ae73a6075d262b75b3cb10f8315b4afc2d5853cf015cfd829f9fd4cbc14014bd007a76f2e2de2426aad6e489ae62
-  data.tar.gz: 53d8e293b39e14b99ce747c06f125b2cdc695c7654ea7d21cbce927e2f8f1064eab0ab2f0b585308353a36a8f345eeafb4c21854b0184ebe652a32a83afddf19
+  metadata.gz: e4de68155586c168c75a51c71749531becdf066cb22888745f8473237cb775dd9054c6401e44a04b00bee517848859d128141692da3fc7c970df2f202e5e49b9
+  data.tar.gz: 7c041a196f2bf45a3ff575426b9269ba45c10e16f641c82f5ce11e362ace013d2480c407b8f1e9a663a27bcf78df1988d6af46de2bd22d41c0fce5366fb2a52c

data/CHANGELOG.md

@@ -2,10 +2,19 @@
 
 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`

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/client.rb

@@ -566,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
@@ -575,6 +576,7 @@ 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"

data/lib/aerospike/query/filter.rb

@@ -15,39 +15,51 @@
 # the License.
 
 module Aerospike
-
   class Filter
+    attr_reader :packed_ctx
 
-    def self.Equal(bin_name, value)
-      Filter.new(bin_name, value, value)
-    end
+    # open up the class to alias the class methods for naming consistency
+    class << self
+      def equal(bin_name, value, ctx: nil)
+        Filter.new(bin_name, value, value, nil, nil, ctx)
+      end
 
-    def self.Contains(bin_name, value, col_type)
-      Filter.new(bin_name, value, value, nil, col_type)
-    end
+      def contains(bin_name, value, col_type, ctx: nil)
+        Filter.new(bin_name, value, value, nil, col_type, ctx)
+      end
 
-    def self.Range(bin_name, from, to, col_type = nil)
-      Filter.new(bin_name, from, to, nil, col_type)
-    end
+      def range(bin_name, from, to, col_type = nil, ctx: nil)
+        Filter.new(bin_name, from, to, nil, col_type, ctx)
+      end
 
-    def self.geoWithinGeoJSONRegion(bin_name, region, col_type = nil)
-      region = region.to_json
-      Filter.new(bin_name, region, region, ParticleType::GEOJSON, col_type)
-    end
+      def geo_within_geo_region(bin_name, region, col_type = nil, ctx: nil)
+        region = region.to_json
+        Filter.new(bin_name, region, region, ParticleType::GEOJSON, col_type, ctx)
+      end
 
-    def self.geoWithinRadius(bin_name, lon, lat, radius_meter, col_type = nil)
-      region = GeoJSON.new({type: "AeroCircle", coordinates: [[lon, lat], radius_meter]})
-      geoWithinGeoJSONRegion(bin_name, region, col_type)
-    end
+      def geo_within_radius(bin_name, lon, lat, radius_meter, col_type = nil, ctx: nil)
+        region = GeoJSON.new({ type: "AeroCircle", coordinates: [[lon, lat], radius_meter] })
+        geo_within_geo_region(bin_name, region, col_type, ctx: ctx)
+      end
 
-    def self.geoContainsGeoJSONPoint(bin_name, point, col_type = nil)
-      point = point.to_json
-      Filter.new(bin_name, point, point, ParticleType::GEOJSON, col_type)
-    end
+      def geo_contains_geo_point(bin_name, point, col_type = nil, ctx: nil)
+        point = point.to_json
+        Filter.new(bin_name, point, point, ParticleType::GEOJSON, col_type, ctx)
+      end
 
-    def self.geoContainsPoint(bin_name, lon, lat, col_type = nil)
-      point = GeoJSON.new({type: "Point", coordinates: [lon, lat]})
-      geoContainsGeoJSONPoint(bin_name, point, col_type)
+      def geo_contains_point(bin_name, lon, lat, col_type = nil, ctx: nil)
+        point = GeoJSON.new({ type: "Point", coordinates: [lon, lat] })
+        geo_contains_geo_point(bin_name, point, col_type, ctx: ctx)
+      end
+
+      # alias the old names for compatibility
+      alias :Equal :equal
+      alias :Contains :contains
+      alias :Range :range
+      alias :geoWithinGeoJSONRegion :geo_within_geo_region
+      alias :geoWithinRadius :geo_within_radius
+      alias :geoContainsGeoJSONPoint :geo_contains_geo_point
+      alias :geoContainsPoint :geo_contains_point
     end
 
     def estimate_size
@@ -56,21 +68,21 @@ module Aerospike
 
     def write(buf, offset)
       # Write name.
-      len = buf.write_binary(@name, offset+1)
+      len = buf.write_binary(@name, offset + 1)
       buf.write_byte(len, offset)
       offset += len + 1
 
       # Write particle type.
       buf.write_byte(@val_type, offset)
-      offset+=1
+      offset += 1
 
       # Write filter begin.
-      len = @begin.write(buf, offset+4)
+      len = @begin.write(buf, offset + 4)
       buf.write_int32(len, offset)
       offset += len + 4
 
       # Write filter end.
-      len = @end.write(buf, offset+4)
+      len = @end.write(buf, offset + 4)
       buf.write_int32(len, offset)
       offset += len + 4
 
@@ -98,7 +110,7 @@ module Aerospike
 
     private
 
-    def initialize(bin_name, begin_value, end_value, val_type = nil, col_type = nil)
+    def initialize(bin_name, begin_value, end_value, val_type = nil, col_type = nil, ctx = nil)
       @name = bin_name
       @begin = Aerospike::Value.of(begin_value)
       @end = Aerospike::Value.of(end_value)
@@ -107,8 +119,8 @@ module Aerospike
       # but in certain cases caller can override the type.
       @val_type = val_type || @begin.type
       @col_type = col_type
-    end
 
+      @packed_ctx = CDT::Context.bytes(ctx)
+    end
   end # class
-
 end

data/lib/aerospike/query/query_partition_command.rb

@@ -82,12 +82,11 @@ module Aerospike
         @data_offset += filter_size
         field_count += 1
 
-        # TODO: Implement
-        # packed_ctx = filter.packed_ctx
-        # if packed_ctx
-        #   @data_offset += FIELD_HEADER_SIZE + packed_ctx.length
-        #   field_count+=1
-        # end
+        packed_ctx = filter.packed_ctx
+        if packed_ctx
+          @data_offset += FIELD_HEADER_SIZE + packed_ctx.length
+          field_count += 1
+        end
       end
 
       @statement.set_task_id
@@ -210,11 +209,10 @@ module Aerospike
         @data_offset += @data_buffer.write_byte(1, @data_offset)
         @data_offset = filter.write(@data_buffer, @data_offset)
 
-        # TODO: Implement
-        # if packed_ctx
-        #   write_field_header(packed_ctx.length, FieldType::INDEX_CONTEXT)
-        #   @data_buffer.write_binary(packed_ctx, @data_offset)
-        # end
+        if packed_ctx
+          write_field_header(packed_ctx.length, FieldType::INDEX_CONTEXT)
+          @data_offset += @data_buffer.write_binary(packed_ctx, @data_offset)
+        end
       end
 
       if @statement.function_name

data/lib/aerospike/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Aerospike
-  VERSION = "2.25.0"
+  VERSION = "2.26.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aerospike
 version: !ruby/object:Gem::Version
-  version: 2.25.0
+  version: 2.26.0
 platform: ruby
 authors:
 - Khosrow Afroozeh
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-28 00:00:00.000000000 Z
+date: 2022-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack