aerospike 2.29.0 → 4.0.0

data/lib/aerospike/exp/exp.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014-2022 Aerospike, Inc.
+# Copyright 2014-2023 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
@@ -96,7 +96,7 @@ module Aerospike
     end
 
     # Create expression that returns if the primary key is stored in the record meta data
-    # as a boolean expression. This would occur when {@link Policy#send_key}
+    # as a boolean expression. This would occur when {Policy#send_key}
     # is true on record write. This expression usually evaluates quickly because record
     # meta data is cached in memory.
     #
@@ -210,11 +210,11 @@ module Aerospike
     #   # Bin "a" exists in record
     #   Exp.bin_exists("a")
     def self.bin_exists(name)
-      return Exp.ne(Exp.bin_type(name), Exp.int_val(0))
+      Exp.ne(Exp.bin_type(name), Exp.int_val(0))
     end
 
     # Create expression that returns bin's integer particle type::
-    # See {@link ParticleType}.
+    # See {ParticleType}.
     #
     # ==== Examples
     #   # Bin "a" particle type is a list
@@ -223,6 +223,20 @@ module Aerospike
       CmdStr.new(BIN_TYPE, name)
     end
 
+    # Create expression that returns the record size. This expression usually evaluates
+    # quickly because record meta data is cached in memory.
+    # Requires server version 7.0+. This expression replaces {#deviceSize()} and
+    # {#memorySize()} since those older expressions are equivalent on server version 7.0+.
+    #
+    # {@code
+    # // Record size >= 100 KB
+    # Exp.ge(Exp.record_size(), Exp.val(100 * 1024))
+    # }
+    def self.record_size
+      Cmd.new(RECORD_SIZE)
+    end
+
+
     #--------------------------------------------------
     # Misc
     #--------------------------------------------------
@@ -333,7 +347,7 @@ module Aerospike
     # Exp.regex_compare("prefix.*suffix", RegexFlags.ICASE | RegexFlags.NEWLINE, Exp.str_bin("a"))
     #
     # @param regex		regular expression string
-    # @param flags		regular expression bit flags. See {@link Exp::RegexFlags}
+    # @param flags		regular expression bit flags. See {Exp::RegexFlags}
     # @param bin		string bin or string value expression
     def self.regex_compare(regex, flags, bin)
       Regex.new(bin, regex, flags)
@@ -410,6 +424,16 @@ module Aerospike
       Nil.new
     end
 
+    # Create Infinity value.
+    def self.infinity_val
+      Infinity.new
+    end
+
+    # Create Wildcard value.
+    def self.wildcard_val
+      Wildcard.new
+    end
+
     #--------------------------------------------------
     # Boolean Operator
     #--------------------------------------------------
@@ -859,7 +883,7 @@ module Aerospike
     #
     # ==== Examples
     # Args Format: <def1>, <def2>, ..., <exp>
-    # def: {@link Exp#def(String, Exp)}
+    # def: {Exp#def(String, Exp)}
     # exp: Scoped expression
     #
     # ==== Examples
@@ -873,7 +897,7 @@ module Aerospike
       Let.new(exps)
     end
 
-    # Assign variable to a {@link Exp#let(Exp...)} expression that can be accessed later.
+    # Assign variable to a {Exp#let(Exp...)} expression that can be accessed later.
     # Requires server version 5.6.0+.
     #
     # ==== Examples
@@ -906,8 +930,8 @@ module Aerospike
     #--------------------------------------------------
 
     # Create unknown value. Used to intentionally fail an expression.
-    # The failure can be ignored with {@link Exp::WriteFlags#EVAL_NO_FAIL}
-    # or {@link Exp::ReadFlags#EVAL_NO_FAIL}.
+    # The failure can be ignored with {Exp::WriteFlags#EVAL_NO_FAIL}
+    # or {Exp::ReadFlags#EVAL_NO_FAIL}.
     # Requires server version 5.6.0+.
     #
     # ==== Examples
@@ -1010,6 +1034,7 @@ module Aerospike
     KEY_EXISTS = 71
     IS_TOMBSTONE = 72
     MEMORY_SIZE = 73
+    RECORD_SIZE = 74
     KEY = 80
     BIN = 81
     BIN_TYPE = 82
@@ -1051,10 +1076,7 @@ module Aerospike
 
     # For internal use only.
     class Module < Exp
-      attr_reader :bin
-      attr_reader :bytes
-      attr_reader :ret_type
-      attr_reader :module
+      attr_reader :bin, :bytes, :ret_type, :module
 
       def initialize(bin, bytes, ret_type, modul)
         @bin = bin
@@ -1075,8 +1097,7 @@ module Aerospike
     end
 
     class Bin < Exp
-      attr_reader :name
-      attr_reader :type
+      attr_reader :name, :type
 
       def initialize(name, type)
         @name = name
@@ -1092,9 +1113,7 @@ module Aerospike
     end
 
     class Regex < Exp
-      attr_reader :bin
-      attr_reader :regex
-      attr_reader :flags
+      attr_reader :bin, :regex, :flags
 
       def initialize(bin, regex, flags)
         @bin = bin
@@ -1120,7 +1139,7 @@ module Aerospike
 
       def pack(packer)
         # Let wire format: LET <defname1>, <defexp1>, <defname2>, <defexp2>, ..., <scope exp>
-        count = (@exps.length - 1) * 2 + 2
+        count = ((@exps.length - 1) * 2) + 2
         packer.write_array_header(count)
         packer.write(LET)
 
@@ -1131,8 +1150,7 @@ module Aerospike
     end
 
     class Def < Exp
-      attr_reader :name
-      attr_reader :exp
+      attr_reader :name, :exp
 
       def initialize(name, exp)
         @name = name
@@ -1146,8 +1164,7 @@ module Aerospike
     end
 
     class CmdExp < Exp
-      attr_reader :exps
-      attr_reader :cmd
+      attr_reader :exps, :cmd
 
       def initialize(cmd, *exps)
         @exps = exps
@@ -1164,8 +1181,7 @@ module Aerospike
     end
 
     class CmdInt < Exp
-      attr_reader :cmd
-      attr_reader :val
+      attr_reader :cmd, :val
 
       def initialize(cmd, val)
         @cmd = cmd
@@ -1180,8 +1196,7 @@ module Aerospike
     end
 
     class CmdStr < Exp
-      attr_reader :str
-      attr_reader :cmd
+      attr_reader :str, :cmd
 
       def initialize(cmd, str)
         @str = str
@@ -1314,6 +1329,18 @@ module Aerospike
       end
     end
 
+    class Infinity < Exp
+      def pack(packer)
+        InfinityValue.new.pack(packer)
+      end
+    end
+
+    class Wildcard < Exp
+      def pack(packer)
+        WildcardValue.new.pack(packer)
+      end
+    end
+
     class ExpBytes < Exp
       attr_reader :bytes
 

data/lib/aerospike/exp/exp_bit.rb

@@ -15,7 +15,7 @@
 # the License.
 
 module Aerospike
-  # Bit expression generator. See {@link Exp}.
+  # Bit expression generator. See {Exp}.
   #
   # The bin expression argument in these methods can be a reference to a bin or the
   # result of another expression. Expressions that modify bin values are only used
@@ -42,7 +42,7 @@ module Aerospike
     #     Exp.val(2))
     def self.resize(byte_size, resize_flags, bin, policy: CDT::BitPolicy::DEFAULT)
       bytes = Exp.pack(nil, RESIZE, byte_size, policy.flags, resize_flags)
-      self.add_write(bin, bytes)
+      add_write(bin, bytes)
     end
 
     # Create expression that inserts value bytes into byte[] bin at byte_offset and returns byte[].
@@ -60,7 +60,7 @@ module Aerospike
     #     Exp.val(2))
     def self.insert(byte_offset, value, bin, policy: CDT::BitPolicy::DEFAULT)
       bytes = Exp.pack(nil, INSERT, byte_offset, value, policy.flags)
-      self.add_write(bin, bytes)
+      add_write(bin, bytes)
     end
 
     # Create expression that removes bytes from byte[] bin at byte_offset for byte_size and returns byte[].
@@ -78,7 +78,7 @@ module Aerospike
     #     Exp.val(2))
     def self.remove(byte_offset, byte_size, bin, policy: CDT::BitPolicy::DEFAULT)
       bytes = Exp.pack(nil, REMOVE, byte_offset, byte_size, policy.flags)
-      self.add_write(bin, bytes)
+      add_write(bin, bytes)
     end
 
     # Create expression that sets value on byte[] bin at bit_offset for bit_size and returns byte[].
@@ -97,7 +97,7 @@ module Aerospike
     #     Exp.val(2))
     def self.set(bit_offset, bit_size, value, bin, policy: CDT::BitPolicy::DEFAULT)
       bytes = Exp.pack(nil, SET, bit_offset, bit_size, value, policy.flags)
-      self.add_write(bin, bytes)
+      add_write(bin, bytes)
     end
 
     # Create expression that performs bitwise "or" on value and byte[] bin at bit_offset for bit_size
@@ -111,7 +111,7 @@ module Aerospike
     #
     def self.or(bit_offset, bit_size, value, bin, policy: CDT::BitPolicy::DEFAULT)
       bytes = Exp.pack(nil, OR, bit_offset, bit_size, value, policy.flags)
-      self.add_write(bin, bytes)
+      add_write(bin, bytes)
     end
 
     # Create expression that performs bitwise "xor" on value and byte[] bin at bit_offset for bit_size
@@ -125,7 +125,7 @@ module Aerospike
     #
     def self.xor(bit_offset, bit_size, value, bin, policy: CDT::BitPolicy::DEFAULT)
       bytes = Exp.pack(nil, XOR, bit_offset, bit_size, value, policy.flags)
-      self.add_write(bin, bytes)
+      add_write(bin, bytes)
     end
 
     # Create expression that performs bitwise "and" on value and byte[] bin at bit_offset for bit_size
@@ -139,7 +139,7 @@ module Aerospike
     #
     def self.and(bit_offset, bit_size, value, bin, policy: CDT::BitPolicy::DEFAULT)
       bytes = Exp.pack(nil, AND, bit_offset, bit_size, value, policy.flags)
-      self.add_write(bin, bytes)
+      add_write(bin, bytes)
     end
 
     # Create expression that negates byte[] bin starting at bit_offset for bit_size and returns byte[].
@@ -151,7 +151,7 @@ module Aerospike
     #
     def self.not(bit_offset, bit_size, bin, policy: CDT::BitPolicy::DEFAULT)
       bytes = Exp.pack(nil, NOT, bit_offset, bit_size, policy.flags)
-      self.add_write(bin, bytes)
+      add_write(bin, bytes)
     end
 
     # Create expression that shifts left byte[] bin starting at bit_offset for bit_size and returns byte[].
@@ -164,7 +164,7 @@ module Aerospike
     #
     def self.lshift(bit_offset, bit_size, shift, bin, policy: CDT::BitPolicy::DEFAULT)
       bytes = Exp.pack(nil, LSHIFT, bit_offset, bit_size, shift, policy.flags)
-      self.add_write(bin, bytes)
+      add_write(bin, bytes)
     end
 
     # Create expression that shifts right byte[] bin starting at bit_offset for bit_size and returns byte[].
@@ -177,12 +177,12 @@ module Aerospike
     #
     def self.rshift(bit_offset, bit_size, shift, bin, policy: CDT::BitPolicy::DEFAULT)
       bytes = Exp.pack(nil, RSHIFT, bit_offset, bit_size, shift, policy.flags)
-      self.add_write(bin, bytes)
+      add_write(bin, bytes)
     end
 
     # Create expression that adds value to byte[] bin starting at bit_offset for bit_size and returns byte[].
     # BitSize must be <= 64. Signed indicates if bits should be treated as a signed number.
-    # If add overflows/underflows, {@link BitOverflowAction} is used.
+    # If add overflows/underflows, {BitOverflowAction} is used.
     #
     # bin = [0b00000001, 0b01000010, 0b00000011, 0b00000100, 0b00000101]
     # bit_offset = 24
@@ -192,13 +192,13 @@ module Aerospike
     # bin result = [0b00000001, 0b01000010, 0b00000011, 0b00000100, 0b10000101]
     #
     def self.add(bit_offset, bit_size, value, signed, bit_overflow_action, bin, policy: CDT::BitPolicy::DEFAULT)
-      bytes = self.pack_math(ADD, policy, bit_offset, bit_size, value, signed, bit_overflow_action)
-      self.add_write(bin, bytes)
+      bytes = pack_math(ADD, policy, bit_offset, bit_size, value, signed, bit_overflow_action)
+      add_write(bin, bytes)
     end
 
     # Create expression that subtracts value from byte[] bin starting at bit_offset for bit_size and returns byte[].
     # BitSize must be <= 64. Signed indicates if bits should be treated as a signed number.
-    # If add overflows/underflows, {@link BitOverflowAction} is used.
+    # If add overflows/underflows, {BitOverflowAction} is used.
     #
     # bin = [0b00000001, 0b01000010, 0b00000011, 0b00000100, 0b00000101]
     # bit_offset = 24
@@ -208,8 +208,8 @@ module Aerospike
     # bin result = [0b00000001, 0b01000010, 0b00000011, 0b0000011, 0b10000101]
     #
     def self.subtract(bit_offset, bit_size, value, signed, bit_overflow_action, bin, policy: CDT::BitPolicy::DEFAULT)
-      bytes = self.pack_math(SUBTRACT, policy, bit_offset, bit_size, value, signed, bit_overflow_action)
-      self.add_write(bin, bytes)
+      bytes = pack_math(SUBTRACT, policy, bit_offset, bit_size, value, signed, bit_overflow_action)
+      add_write(bin, bytes)
     end
 
     # Create expression that sets value to byte[] bin starting at bit_offset for bit_size and returns byte[].
@@ -223,7 +223,7 @@ module Aerospike
     #
     def self.set_int(bit_offset, bit_size, value, bin, policy: CDT::BitPolicy::DEFAULT)
       bytes = Exp.pack(nil, SET_INT, bit_offset, bit_size, value, policy.flags)
-      self.add_write(bin, bytes)
+      add_write(bin, bytes)
     end
 
     # Create expression that returns bits from byte[] bin starting at bit_offset for bit_size.
@@ -240,7 +240,7 @@ module Aerospike
     #     Exp.val(new byte[] {(byte)0b10000000}))
     def self.get(bit_offset, bit_size, bin)
       bytes = Exp.pack(nil, GET, bit_offset, bit_size)
-      self.add_read(bin, bytes, Exp::Type::BLOB)
+      add_read(bin, bytes, Exp::Type::BLOB)
     end
 
     # Create expression that returns integer count of set bits from byte[] bin starting at
@@ -256,7 +256,7 @@ module Aerospike
     #   Exp.le(BitExp.count(Exp.val(0), Exp.val(5), Exp.blobBin("a")), Exp.val(2))
     def self.count(bit_offset, bit_size, bin)
       bytes = Exp.pack(nil, COUNT, bit_offset, bit_size)
-      self.add_read(bin, bytes, Exp::Type::INT)
+      add_read(bin, bytes, Exp::Type::INT)
     end
 
     # Create expression that returns integer bit offset of the first specified value bit in byte[] bin
@@ -278,7 +278,7 @@ module Aerospike
     # @param bin			bin or blob value expression
     def self.lscan(bit_offset, bit_size, value, bin)
       bytes = Exp.pack(nil, LSCAN, bit_offset, bit_size, value)
-      self.add_read(bin, bytes, Exp::Type::INT)
+      add_read(bin, bytes, Exp::Type::INT)
     end
 
     # Create expression that returns integer bit offset of the last specified value bit in byte[] bin
@@ -301,7 +301,7 @@ module Aerospike
     # @param bin			bin or blob value expression
     def self.rscan(bit_offset, bit_size, value, bin)
       bytes = Exp.pack(nil, RSCAN, bit_offset, bit_size, value)
-      self.add_read(bin, bytes, Exp::Type::INT)
+      add_read(bin, bytes, Exp::Type::INT)
     end
 
     # Create expression that returns integer from byte[] bin starting at bit_offset for bit_size.
@@ -317,8 +317,8 @@ module Aerospike
     #   # getInt(a) == 16899
     #   Exp.eq(BitExp.getInt(Exp.val(8), Exp.val(16), false, Exp.blobBin("a")), Exp.val(16899))
     def self.get_int(bit_offset, bit_size, signed, bin)
-      bytes = self.pack_get_int(bit_offset, bit_size, signed)
-      self.add_read(bin, bytes, Exp::Type::INT)
+      bytes = pack_get_int(bit_offset, bit_size, signed)
+      add_read(bin, bytes, Exp::Type::INT)
     end
 
     private

data/lib/aerospike/exp/exp_hll.rb

@@ -15,7 +15,7 @@
 # the License.
 
 module Aerospike
-  # HyperLogLog (HLL) expression generator. See {@link Exp}.
+  # HyperLogLog (HLL) expression generator. See {Exp}.
   #
   # The bin expression argument in these methods can be a reference to a bin or the
   # result of another expression. Expressions that modify bin values are only used
@@ -25,14 +25,14 @@ module Aerospike
 
     # Create expression that creates a new HLL or resets an existing HLL with minhash bits.
     #
-    # @param policy			write policy, use {@link HLLPolicy#Default} for default
+    # @param policy			write policy, use {HLLPolicy#Default} for default
     # @param index_bit_count		number of index bits. Must be between 4 and 16 inclusive.
     # @param min_hash_bit_count	number of min hash bits. Must be between 4 and 51 inclusive.
     # 							Also, index_bit_count + min_hash_bit_count must be <= 64. Optional.
     # @param bin				HLL bin or value expression
     def self.init(index_bit_count, bin, min_hash_bit_count: Exp.int_val(-1), policy: CDT::HLLPolicy::DEFAULT)
       bytes = Exp.pack(nil, INIT, index_bit_count, min_hash_bit_count, policy.flags)
-      self.add_write(bin, bytes)
+      add_write(bin, bytes)
     end
 
     # Create expression that adds values to a HLL set and returns HLL set. If HLL bin does not
@@ -45,7 +45,7 @@ module Aerospike
     #     HLLExp.add(HLLPolicy.Default, Exp.val(list), Exp.val(10), Exp.val(20), Exp.hllBin("a"))),
     #   Exp.val(7))
     #
-    # @param policy			write policy, use {@link HLLPolicy#Default} for default
+    # @param policy			write policy, use {HLLPolicy#Default} for default
     # @param list				list bin or value expression of values to be added
     # @param index_bit_count		number of index bits expression. Must be between 4 and 16 inclusive.
     # @param min_hash_bit_count   number of min hash bits expression. Must be between 4 and 51 inclusive.
@@ -53,7 +53,7 @@ module Aerospike
     # @param bin				HLL bin or value expression
     def self.add(list, bin, policy: CDT::HLLPolicy::DEFAULT, index_bit_count: Exp.val(-1), min_hash_bit_count: Exp.val(-1))
       bytes = Exp.pack(nil, ADD, list, index_bit_count, min_hash_bit_count, policy.flags)
-      self.add_write(bin, bytes)
+      add_write(bin, bytes)
     end
 
     # Create expression that returns estimated number of elements in the HLL bin.
@@ -63,7 +63,7 @@ module Aerospike
     # Exp.gt(HLLExp.getCount(Exp.hllBin("a")), Exp.val(7))
     def self.get_count(bin)
       bytes = Exp.pack(nil, COUNT)
-      self.add_read(bin, bytes, Exp::Type::INT)
+      add_read(bin, bytes, Exp::Type::INT)
     end
 
     # Create expression that returns a HLL object that is the union of all specified HLL objects
@@ -77,7 +77,7 @@ module Aerospike
     # HLLExp.getUnion(Exp.val(list), Exp.hllBin("b"))
     def self.get_union(list, bin)
       bytes = Exp.pack(nil, UNION, list)
-      self.add_read(bin, bytes, Exp::Type::HLL)
+      add_read(bin, bytes, Exp::Type::HLL)
     end
 
     # Create expression that returns estimated number of elements that would be contained by
@@ -91,7 +91,7 @@ module Aerospike
     # HLLExp.getUnionCount(Exp.val(list), Exp.hllBin("b"))
     def self.get_union_count(list, bin)
       bytes = Exp.pack(nil, UNION_COUNT, list)
-      self.add_read(bin, bytes, Exp::Type::INT)
+      add_read(bin, bytes, Exp::Type::INT)
     end
 
     # Create expression that returns estimated number of elements that would be contained by
@@ -105,7 +105,7 @@ module Aerospike
     # HLLExp.getIntersectCount(Exp.val(list), Exp.hllBin("b"))
     def self.get_intersect_count(list, bin)
       bytes = Exp.pack(nil, INTERSECT_COUNT, list)
-      self.add_read(bin, bytes, Exp::Type::INT)
+      add_read(bin, bytes, Exp::Type::INT)
     end
 
     # Create expression that returns estimated similarity of these HLL objects as a
@@ -116,7 +116,7 @@ module Aerospike
     # Exp.ge(HLLExp.getSimilarity(Exp.hllBin("a"), Exp.hllBin("b")), Exp.val(0.75))
     def self.get_similarity(list, bin)
       bytes = Exp.pack(nil, SIMILARITY, list)
-      self.add_read(bin, bytes, Exp::Type::FLOAT)
+      add_read(bin, bytes, Exp::Type::FLOAT)
     end
 
     # Create expression that returns index_bit_count and min_hash_bit_count used to create HLL bin
@@ -130,7 +130,7 @@ module Aerospike
     #   Exp.val(10))
     def self.describe(bin)
       bytes = Exp.pack(nil, DESCRIBE)
-      self.add_read(bin, bytes, Exp::Type::LIST)
+      add_read(bin, bytes, Exp::Type::LIST)
     end
 
     # Create expression that returns one if HLL bin may contain all items in the list.
@@ -142,7 +142,7 @@ module Aerospike
     # Exp.eq(HLLExp.mayContain(Exp.val(list), Exp.hllBin("a")), Exp.val(1))
     def self.may_contain(list, bin)
       bytes = Exp.pack(nil, MAY_CONTAIN, list)
-      self.add_read(bin, bytes, Exp::Type::INT)
+      add_read(bin, bytes, Exp::Type::INT)
     end
 
     private