aerospike 2.14.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0452d4d35ee6d5ce56586cc99b3a68c7e1b4a6c4f6334c6794414a483e2ef01
-  data.tar.gz: 328a5672510bb68e044a92c39fc1f04059daa53b4332eaa5a64dda04f5b3de78
+  metadata.gz: 703f1af2ab5b0050745490618dc48f4f1135b457523ebe69b6c35d9111c67037
+  data.tar.gz: 9fba2d0c3a53c93a46f3fc1635f9fcabfa2e7804191cf9f20bf79c306099e6ce
 SHA512:
-  metadata.gz: 44c883336f3993d532c7989e1c6bf737deca2773cb444a4cfa6021bca35311c9d4fe5c74ddb73fa1274661435a127892f9a368bd1d94120e6965bee38b870216
-  data.tar.gz: ebac442b5b2ddc345b7d7713b0e8d7f0aaaba9da24aabe811e1a10a26555c2a85ba1d2bad0a0266674fdcc1c3deb573ed1839ffe98294dc979ccc69e42eab187
+  metadata.gz: eba3f39bbfd7399f7e424894521aeed62cbd4b28e74f81b1d5207485eca59d236497d05c5f5dbfdfadd2e8e52c01eebcf4a06c71ea5eedf272f3ee6efd5f23b5
+  data.tar.gz: 3d2b651ccc051d95255acf0affdebd41822fcd0d36461653987186183bf84100a4507601eb5a640a0972827968b765645e31c6f6eb1f2f82b25f564704cb2aa7

data/CHANGELOG.md

@@ -2,16 +2,24 @@
 
 All notable changes to this project will be documented in this file.
 
-## [2.14.0] - 2019-08-06
+## [2.15.0] - 2020-10-05
 
 * **New Features**
-  * Adds support for rake-aware reads.
+  * [CLIENT-1254] Adds support for HyperLogLog.
+
+* **Changes**
+  * `Client#operate` now uses `OperatePolicy` by default.
+
+## [2.14.0] - 2020-08-06
+
+* **New Features**
+  * Adds support for rack-aware reads.
   * Adds support for client-server compression.
 
 * **Improvements**
   * Adds support for `truncate-namespace` command.
 
-## [2.13.0] - 2019-07-17
+## [2.13.0] - 2020-07-17
 
 * **New Features**
   * Adds support for replica policies.

data/lib/aerospike.rb

@@ -77,6 +77,9 @@ require 'aerospike/cdt/map_return_type'
 require 'aerospike/cdt/map_write_flags'
 require 'aerospike/cdt/map_write_mode'
 require 'aerospike/cdt/map_policy'
+require 'aerospike/cdt/hll_operation'
+require 'aerospike/cdt/hll_write_flags'
+require 'aerospike/cdt/hll_policy'
 require 'aerospike/geo_json'
 require 'aerospike/ttl'
 

data/lib/aerospike/cdt/hll_operation.rb

@@ -0,0 +1,200 @@
+# encoding: utf-8
+# Copyright 2016-2020 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
+#
+# 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.
+
+module Aerospike
+  module CDT
+
+    # HyperLogLog (HLL) operations.
+    # Requires server versions >= 4.9.
+    #
+    # HyperLogLog operations on HLL items nested in lists/maps are not currently
+    # supported by the server.
+    class HLLOperation < Operation
+
+      INIT            = 0
+      ADD             = 1
+      SET_UNION       = 2
+      SET_COUNT       = 3
+      FOLD            = 4
+      COUNT           = 50
+      UNION           = 51
+      UNION_COUNT     = 52
+      INTERSECT_COUNT = 53
+      SIMILARITY      = 54
+      DESCRIBE        = 55
+
+      attr_reader :hll_op, :values, :return_type, :policy, :index_bit_count, :minhash_bit_count
+
+      def initialize(op_type, hll_op, bin_name, values: nil, index_bit_count: nil, minhash_bit_count: nil, policy: nil)
+        @policy = policy
+        @op_type = op_type
+        @bin_name = bin_name
+        @bin_value = nil
+        @hll_op = hll_op
+        @index_bit_count = index_bit_count
+        @minhash_bit_count = minhash_bit_count
+        @values = values
+
+        self
+      end
+
+      ##
+      # Create HLL init operation with minhash bits.
+      # Server creates a new HLL or resets an existing HLL.
+      # Server does not return a value.
+      #
+      # policy      write policy, HLLPolicy::DEFAULT is default
+      # bin_name     name of bin
+      # index_bit_count   number of index bits. Must be between 4 and 16 inclusive.
+      # minhash_bit_count   number of min hash bits. Must be between 4 and 58 inclusive.
+      def self.init(bin_name, index_bit_count, minhash_bit_count, policy = HLLPolicy::DEFAULT)
+        HLLOperation.new(Operation::HLL_MODIFY, INIT, bin_name, index_bit_count: index_bit_count, minhash_bit_count: minhash_bit_count, policy: policy)
+      end
+
+      ##
+      # Create HLL add operation with minhash bits.
+      # Server adds values to HLL set. If HLL bin does not exist, use index_bit_count and minhash_bit_count
+      # to create HLL bin. Server returns number of entries that caused HLL to update a register.
+      #
+      # policy      write policy, HLLPolicy::DEFAULT is default
+      # bin_name     name of bin
+      # list        list of values to be added
+      # index_bit_count   number of index bits. Must be between 4 and 16 inclusive.
+      # minhash_bit_count   number of min hash bits. Must be between 4 and 58 inclusive.
+      def self.add(bin_name, *values, policy: HLLPolicy::DEFAULT, index_bit_count: -1, minhash_bit_count: -1)
+        HLLOperation.new(Operation::HLL_MODIFY, ADD, bin_name, index_bit_count: index_bit_count, minhash_bit_count: minhash_bit_count, values: values, policy: policy)
+      end
+
+      ##
+      # Create HLL set union operation.
+      # Server sets union of specified HLL objects with HLL bin.
+      # Server does not return a value.
+      #
+      # policy      write policy, HLLPolicy::DEFAULT is default
+      # bin_name     name of bin
+      # list        list of HLL objects
+      def self.set_union(bin_name, *values, policy: HLLPolicy::DEFAULT)
+        HLLOperation.new(Operation::HLL_MODIFY, SET_UNION, bin_name, values: values, policy: policy)
+      end
+
+      ##
+      # Create HLL refresh operation.
+      # Server updates the cached count (if stale) and returns the count.
+      #
+      # bin_name     name of bin
+      def self.refresh_count(bin_name)
+        HLLOperation.new(Operation::HLL_MODIFY, SET_COUNT, bin_name)
+      end
+
+      ##
+      # Create HLL fold operation.
+      # Servers folds index_bit_count to the specified value.
+      # This can only be applied when minhash_bit_count on the HLL bin is 0.
+      # Server does not return a value.
+      #
+      # bin_name     name of bin
+      # index_bit_count   number of index bits. Must be between 4 and 16 inclusive.
+      def self.fold(bin_name, index_bit_count)
+        HLLOperation.new(Operation::HLL_MODIFY, FOLD, bin_name, index_bit_count: index_bit_count)
+      end
+
+      ##
+      # Create HLL getCount operation.
+      # Server returns estimated number of elements in the HLL bin.
+      #
+      # bin_name     name of bin
+      def self.get_count(bin_name)
+        HLLOperation.new(Operation::HLL_READ, COUNT, bin_name)
+      end
+
+      ##
+      # Create HLL getUnion operation.
+      # Server returns an HLL object that is the union of all specified HLL objects in the list
+      # with the HLL bin.
+      #
+      # bin_name     name of bin
+      # list        list of HLL objects
+      def self.get_union(bin_name, *values)
+        HLLOperation.new(Operation::HLL_READ, UNION, bin_name, values: values)
+      end
+
+      ##
+      # Create HLL getUnionCount operation.
+      # Server returns estimated number of elements that would be contained by the union of these
+      # HLL objects.
+      # bin_name     name of bin
+      # list        list of HLL objects
+      def self.get_union_count(bin_name, *values)
+        HLLOperation.new(Operation::HLL_READ, UNION_COUNT, bin_name, values: values)
+      end
+
+      ##
+      # Create HLL getIntersectCount operation.
+      # Server returns estimated number of elements that would be contained by the intersection of
+      # these HLL objects.
+      #
+      # bin_name     name of bin
+      # list        list of HLL objects
+      def self.get_intersect_count(bin_name, *values)
+        HLLOperation.new(Operation::HLL_READ, INTERSECT_COUNT, bin_name, values: values)
+      end
+
+      ##
+      # Create HLL getSimilarity operation.
+      # Server returns estimated similarity of these HLL objects. Return type is a double.
+      #
+      # bin_name     name of bin
+      # list        list of HLL objects
+      def self.get_similarity(bin_name, *values)
+        HLLOperation.new(Operation::HLL_READ, SIMILARITY, bin_name, values: values)
+      end
+
+      ##
+      # Create HLL describe operation.
+      # Server returns index_bit_count and minhash_bit_count used to create HLL bin in a list of longs.
+      # The list size is 2.
+      #
+      # bin_name     name of bin
+      def self.describe(bin_name)
+        HLLOperation.new(Operation::HLL_READ, DESCRIBE, bin_name)
+      end
+
+      def bin_value
+        @bin_value ||= pack_bin_value
+      end
+
+      private
+
+      def pack_bin_value
+        bytes = nil
+        Packer.use do |packer|
+          args = [hll_op]
+          args << values if values
+          args << index_bit_count if index_bit_count
+          args << minhash_bit_count if minhash_bit_count
+          args << policy.flags if policy
+
+          vv = ListValue.new(args)
+          vv.pack(packer)
+          bytes = packer.bytes
+        end
+        BytesValue.new(bytes)
+      end
+
+    end
+
+  end
+end

data/lib/aerospike/cdt/hll_policy.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# Copyright 2020 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
+#
+# 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.
+
+module Aerospike
+  module CDT
+    class HLLPolicy
+
+      attr_accessor :flags
+
+      def initialize(write_flags: HLLWriteFlags::DEFAULT)
+        @flags = write_flags
+      end
+
+      DEFAULT = HLLPolicy.new
+
+    end
+  end
+end

data/lib/aerospike/cdt/hll_write_flags.rb

@@ -0,0 +1,53 @@
+# encoding: utf-8
+# Copyright 2020 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
+#
+# 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.
+
+module Aerospike
+  module CDT
+
+    ##
+    # Map write bit flags.
+    # Requires server versions >= 4.3.
+    module HLLWriteFlags
+
+      ##
+      # Default is Default. Allow create or update.
+      DEFAULT = 0
+
+      ##
+      # CREATE_ONLY behaves like the following:
+      # If the bin already exists, the operation will be denied.
+      # If the bin does not exist, a new bin will be created.
+      CREATE_ONLY = 1
+
+      ##
+      # UPDATE_ONLY behaves like the following:
+      # If the bin already exists, the bin will be overwritten.
+      # If the bin does not exist, the operation will be denied.
+      UPDATE_ONLY = 2
+
+      ##
+      # NO_FAIL does not raise error if operation is denied.
+      NO_FAIL = 4
+
+      ##
+      # ALLOW_FOLD allows the resulting set to be the minimum of provided index bits.
+      # Also, allow the usage of less precise HLL algorithms when minHash bits
+      # of all participating sets do not match.
+      ALLOW_FOLD = 8
+
+    end
+  end
+end

data/lib/aerospike/client.rb

@@ -44,6 +44,7 @@ module Aerospike
     attr_accessor :default_read_policy
     attr_accessor :default_scan_policy
     attr_accessor :default_write_policy
+    attr_accessor :default_operate_policy
     attr_accessor :cluster
 
     def initialize(hosts = nil, policy: ClientPolicy.new, connect: true)
@@ -383,7 +384,7 @@ module Aerospike
     #  read the result, all in one database call. Operations are executed in
     #  the order they are specified.
     def operate(key, operations, options = nil)
-      policy = create_policy(options, WritePolicy, default_write_policy)
+      policy = create_policy(options, OperatePolicy, default_operate_policy)
 
       command = OperateCommand.new(@cluster, policy, key, operations)
       execute_command(command)
@@ -827,6 +828,7 @@ module Aerospike
       self.default_query_policy = create_policy(policies[:query], QueryPolicy)
       self.default_scan_policy = create_policy(policies[:scan], ScanPolicy)
       self.default_write_policy = create_policy(policies[:write], WritePolicy)
+      self.default_operate_policy = create_policy(policies[:operate], OperatePolicy)
     end
 
     def send_info_command(policy, command, node = nil)

data/lib/aerospike/command/command.rb

@@ -59,6 +59,9 @@ module Aerospike
   # Create only. Fail if record already exists.
   INFO2_CREATE_ONLY = Integer(1 << 5)
 
+  # Return a result for every operation.
+  INFO2_RESPOND_ALL_OPS = Integer(1 << 7)
+
   # This is the last of a multi-part message.
   INFO3_LAST = Integer(1 << 0)
   # Commit to master only before declaring success.
@@ -254,6 +257,7 @@ module Aerospike
       read_attr = 0
       write_attr = 0
       read_header = false
+      record_bin_multiplicity = policy.record_bin_multiplicity == RecordBinMultiplicity::ARRAY
 
       operations.each do |operation|
         case operation.op_type
@@ -271,17 +275,24 @@ module Aerospike
           read_attr |= INFO1_READ
           read_header = true
 
-        when Aerospike::Operation::CDT_READ
+        when Aerospike::Operation::CDT_READ,Aerospike::Operation::HLL_READ
           read_attr |= INFO1_READ
 
         else
           write_attr = INFO2_WRITE
         end
 
+        if [Aerospike::Operation::HLL_MODIFY, Aerospike::Operation::HLL_READ].include?(operation.op_type)
+          record_bin_multiplicity = true
+        end
+
         estimate_operation_size_for_operation(operation)
       end
       size_buffer
 
+
+      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

data/lib/aerospike/operation.rb

@@ -32,6 +32,8 @@ module Aerospike
     PREPEND     = 10
     TOUCH       = 11
     DELETE      = 14
+    HLL_READ    = 15
+    HLL_MODIFY  = 16
 
     def initialize(op_type, bin_name=nil, bin_value=NullValue.new)
       @op_type = op_type

data/lib/aerospike/policy/replica.rb

@@ -31,7 +31,7 @@ module Aerospike
     # Try node on the same rack as the client first.  If there are no nodes on the
     # same rack, use SEQUENCE instead.
     #
-    # ClientPolicy#rack_aware}, ClientPolicy#rack_id, and server rack
+    # ClientPolicy#rack_aware, ClientPolicy#rack_id, and server rack
     # configuration must also be set to enable this functionality.
     PREFER_RACK = 3
 

data/lib/aerospike/result_code.rb

@@ -60,6 +60,10 @@ module Aerospike
     # exists.
     KEY_EXISTS_ERROR = 5
 
+    # Bin already exists on a create-only operation.
+    BIN_EXISTS_ERROR = 6
+
+
     # Expected cluster ID was not received.
     CLUSTER_KEY_MISMATCH = 7
 
@@ -91,6 +95,9 @@ module Aerospike
     # Unsupported Server Feature (e.g. Scan + UDF)
     UNSUPPORTED_FEATURE = 16
 
+    # Bin not found on update-only operation.
+    BIN_NOT_FOUND = 17
+
     # Specified bin name does not exist in record.
     DEVICE_OVERLOAD = 18
 
@@ -244,6 +251,9 @@ module Aerospike
       when KEY_EXISTS_ERROR
         "Key already exists"
 
+      when BIN_EXISTS_ERROR
+        "Bin already exists on a create-only operation"
+
       when CLUSTER_KEY_MISMATCH
         "Cluster key mismatch"
 
@@ -274,6 +284,9 @@ module Aerospike
       when UNSUPPORTED_FEATURE
         "Unsupported Server Feature"
 
+      when BIN_NOT_FOUND
+        "Bin not found on update-only operation"
+
       when DEVICE_OVERLOAD
         "Device overload"
 

data/lib/aerospike/value/particle_type.rb

@@ -36,7 +36,7 @@ module Aerospike
     #RTA_DICT = 15
     #RTA_APPEND_DICT = 16
     #RTA_APPEND_LIST = 17
-    #LUA_BLOB = 18
+    HLL = 18
     MAP = 19
     LIST = 20
     GEOJSON = 23

data/lib/aerospike/value/value.rb

@@ -526,6 +526,49 @@ module Aerospike
 
   end
 
+  # #######################################/
+
+  # HLLValue value. Encapsulates a HyperLogLog value.
+  # Supported by Aerospike server version 4.9 and later.
+  class HLLValue < Value #:nodoc:
+
+    def initialize(value)
+      @bytes = value
+      @bytes.force_encoding('binary')
+
+      self
+    end
+
+    def type
+      Aerospike::ParticleType::HLL
+    end
+
+    def get
+      self
+    end
+
+    def to_s
+      @bytes.to_s
+    end
+
+    def to_bytes
+      @bytes
+    end
+
+    def estimate_size
+      @bytes.bytesize
+    end
+
+    def write(buffer, offset)
+      buffer.write_binary(@bytes, offset)
+    end
+
+    def pack(packer)
+      packer.write(Aerospike::ParticleType::BLOB.chr + @bytes)
+    end
+
+  end
+
   #######################################
 
   def self.encoding
@@ -572,6 +615,10 @@ module Aerospike
       hdrsz = 1 + 2 + (ncells * 8)
       Aerospike::GeoJSON.new(buf.read(offset + hdrsz, length - hdrsz))
 
+    when Aerospike::ParticleType::HLL
+      bytes = buf.read(offset,length)
+      Aerospike::HLLValue.new(bytes)
+
     else
       nil
     end

data/lib/aerospike/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aerospike
 version: !ruby/object:Gem::Version
-  version: 2.14.0
+  version: 2.15.0
 platform: ruby
 authors:
 - Khosrow Afroozeh
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-06 00:00:00.000000000 Z
+date: 2020-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -55,6 +55,9 @@ files:
 - lib/aerospike/aerospike_exception.rb
 - lib/aerospike/atomic/atomic.rb
 - lib/aerospike/bin.rb
+- lib/aerospike/cdt/hll_operation.rb
+- lib/aerospike/cdt/hll_policy.rb
+- lib/aerospike/cdt/hll_write_flags.rb
 - lib/aerospike/cdt/list_operation.rb
 - lib/aerospike/cdt/list_order.rb
 - lib/aerospike/cdt/list_policy.rb