aerospike 3.0.0 → 4.0.0

data/lib/aerospike/policy/batch_delete_policy.rb

@@ -0,0 +1,71 @@
+# encoding: utf-8
+# Copyright 2014-2024 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
+
+  # Policy attributes used in batch delete commands.
+  class BatchDeletePolicy
+    attr_accessor :filter_exp, :commit_level, :generation_policy, :generation, :durable_delete, :send_key
+
+    def initialize(opt = {})
+      # Optional expression filter. If filter_exp exists and evaluates to false, the specific batch key
+      # request is not performed and {BatchRecord#result_code} is set to
+      # {ResultCode#FILTERED_OUT}.
+      #
+      # If exists, this filter overrides the batch parent filter {Policy#filter_exp}
+      # for the specific key in batch commands that allow a different policy per key.
+      # Otherwise, this filter is ignored.
+      #
+      # Default: nil
+      @filter_exp = opt[:filter_exp]
+
+      # Desired consistency guarantee when committing a transaction on the server. The default
+      # (COMMIT_ALL) indicates that the server should wait for master and all replica commits to
+      # be successful before returning success to the client.
+      #
+      # Default: CommitLevel.COMMIT_ALL
+      @commit_level = opt[:commit_level] || CommitLevel::COMMIT_ALL
+
+      # Qualify how to handle record deletes based on record generation. The default (NONE)
+      # indicates that the generation is not used to restrict deletes.
+      #
+      # Default: GenerationPolicy.NONE
+      @generation_policy = opt[:generation_policy] || GenerationPolicy::NONE
+
+      # Expected generation. Generation is the number of times a record has been modified
+      # (including creation) on the server. This field is only relevant when generationPolicy
+      # is not NONE.
+      #
+      # Default: 0
+      @generation = opt[:generation] || 0
+
+      # If the transaction results in a record deletion, leave a tombstone for the record.
+      # This prevents deleted records from reappearing after node failures.
+      # Valid for Aerospike Server Enterprise Edition only.
+      #
+      # Default: false (do not tombstone deleted records).
+      @durable_delete = opt[:durable_delete] || false
+
+      # Send user defined key in addition to hash digest.
+      # If true, the key will be stored with the tombstone record on the server.
+      #
+      # Default: false (do not send the user defined key)
+      @send_key = opt[:send_key] || false
+
+      self
+    end
+  end
+end

data/lib/aerospike/policy/batch_policy.rb

@@ -21,12 +21,14 @@ module Aerospike
 
   # Container object for batch policy command.
   class BatchPolicy < Policy
-
-    attr_accessor :use_batch_direct
+    attr_accessor :allow_inline_ssd, :respond_all_keys, :send_key
 
     def initialize(opt={})
-      super(opt)
+      super
 
+      # [:nodoc:]
+      # DEPRECATED
+      # This setting does not have any effect anymore.
       # Use old batch direct protocol where batch reads are handled by direct
       # low-level batch server database routines. The batch direct protocol can
       # be faster when there is a single namespace. But there is one important
@@ -38,11 +40,58 @@ module Aerospike
       # index protocol will perform this record proxy when necessary.
       #
       # Default: false (use new batch index protocol if server supports it)
-      @use_batch_direct = opt.fetch(:use_batch_direct) { false }
+      @use_batch_direct = opt.fetch(:use_batch_direct, false)
+
+
+      # Allow batch to be processed immediately in the server's receiving thread for SSD
+      # namespaces. If false, the batch will always be processed in separate service threads.
+      # Server versions &lt; 6.0 ignore this field.
+      #
+      # Inline processing can introduce the possibility of unfairness because the server
+      # can process the entire batch before moving onto the next command.
+      #
+      # Default: false
+      @allow_inline_ssd = opt.fetch(:allow_inline_ssd, false)
+
+
+      # Should all batch keys be attempted regardless of errors. This field is used on both
+      # the client and server. The client handles node specific errors and the server handles
+      # key specific errors.
+      #
+      # If true, every batch key is attempted regardless of previous key specific errors.
+      # Node specific errors such as timeouts stop keys to that node, but keys directed at
+      # other nodes will continue to be processed.
+      #
+      # If false, the server will stop the batch to its node on most key specific errors.
+      # The exceptions are {ResultCode#KEY_NOT_FOUND_ERROR} and
+      # {ResultCode#FILTERED_OUT} which never stop the batch.
+      # The client will stop the entire batch on node specific errors. The client will
+      # not stop the entire batch commands run in parallel.
+      #
+      # Server versions < 6.0 do not support this field and treat this value as false
+      # for key specific errors.
+      #
+      # Default: true
+      @respond_all_keys = opt.fetch(:respond_all_keys, true)
+
+
+      # Send user defined key in addition to hash digest on a record put.
+      # The default is to _not_ send the user defined key.
+      @send_key = opt.fetch(:send_key, false)
 
       self
     end
 
+    def self.read_default
+      BatchPolicy.new
+    end
+
+    def self.write_default
+      bp = BatchPolicy.new
+      bp.max_retries = 0
+      bp
+    end
+
   end # class
 
 end # module

data/lib/aerospike/{command/batch_direct_node.rb → policy/batch_read_policy.rb}

@@ -17,24 +17,22 @@
 
 module Aerospike
 
-  BatchNamespace = Struct.new :namespace, :keys
-
-  class BatchDirectNode #:nodoc:
-
-    attr_accessor :node
-    attr_accessor :batch_namespaces
-
-    def self.generate_list(cluster, replica_policy, keys)
-      keys.group_by { |key| cluster.get_node_for_key(replica_policy, key) }
-        .map { |node, keys_for_node| BatchDirectNode.new(node, keys_for_node) }
+  # Policy attributes used in batch read commands.
+  class BatchReadPolicy
+
+    attr_accessor :filter_exp
+
+    def initialize(opt={})
+      # Optional expression filter. If filter_exp exists and evaluates to false, the specific batch key
+      # request is not performed and {BatchRecord#result_code} is set to
+      # {ResultCode#FILTERED_OUT}.
+      #
+      # If exists, this filter overrides the batch parent filter {Policy#filter_exp}
+      # for the specific key in batch commands that allow a different policy per key.
+      # Otherwise, this filter is ignored.
+      #
+      # Default: nil
+      @filter_exp = opt[:filter_exp]
     end
-
-    def initialize(node, keys)
-      @node = node
-      @batch_namespaces = keys.group_by(&:namespace)
-        .map { |ns, keys_for_ns| BatchNamespace.new(ns, keys_for_ns) }
-    end
-
   end
-
-end
+end

data/lib/aerospike/policy/batch_udf_policy.rb

@@ -0,0 +1,75 @@
+# Copyright 2014-2023 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
+
+  # Policy attributes used in batch UDF execute commands.
+  class BatchUDFPolicy
+
+    attr_accessor :filter_exp, :commit_level, :ttl, :durable_delete, :send_key
+
+    alias expiration ttl
+    alias expiration= ttl=
+
+    def initialize(opt={})
+      # Optional expression filter. If filter_exp exists and evaluates to false, the specific batch key
+      # request is not performed and {BatchRecord#resultCode} is set to
+      # {ResultCode#FILTERED_OUT}.
+      #
+      # If exists, this filter overrides the batch parent filter {Policy#filter_exp}
+      # for the specific key in batch commands that allow a different policy per key.
+      # Otherwise, this filter is ignored.
+      #
+      # Default: nil
+      @filter_exp = opt[:filter_exp]
+
+      # Desired consistency guarantee when committing a transaction on the server. The default
+      # (COMMIT_ALL) indicates that the server should wait for master and all replica commits to
+      # be successful before returning success to the client.
+      #
+      # Default: CommitLevel::COMMIT_ALL
+      @commit_level = opt.fetch(:commit_level, CommitLevel::COMMIT_ALL)
+
+      # Record expiration; also known as time-to-live (TTL).
+      # Seconds record will live before being removed by the server.
+      #
+      # Supported values:
+      # - `Aerospike::TTL::NEVER_EXPIRE`: Never expire record; requires Aerospike 2
+      #    server versions >= 2.7.2 or Aerospike 3 server versions >= 3.1.4. Do
+      #    not use for older servers.
+      # - `Aerospike::TTL::NAMESPACE_DEFAULT`: Default to namespace configuration
+      #    variable "default-ttl" on the server.
+      # - `Aerospike::TTL::DONT_UPDATE`: Do not change a record's expiration date
+      #   when updating the record. Requires Aerospike server v3.10.1 or later.
+      # - Any value > 0: Actual time-to-live in seconds.
+      @ttl = opt[:ttl] || opt[:expiration] || 0
+
+      # If the transaction results in a record deletion, leave a tombstone for the record.
+      # This prevents deleted records from reappearing after node failures.
+      # Valid for Aerospike Server Enterprise Edition only.
+      #
+      # Default: false (do not tombstone deleted records).
+      @durable_delete = opt.fetch(:durable_delete, false)
+
+      # Send user defined key in addition to hash digest.
+      # If true, the key will be stored with the record on the server.
+      #
+      # Default: false (do not send the user defined key)
+      @send_key = opt.fetch(:send_key, false)
+    end
+  end
+end

data/lib/aerospike/policy/batch_write_policy.rb

@@ -0,0 +1,105 @@
+# Copyright 2014-2023 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
+
+
+  # Policy attributes used in batch write commands.
+  class BatchWritePolicy
+
+    attr_accessor :filter_exp, :record_exists_action, :commit_level,
+                  :generation_policy, :generation, :ttl, :durable_delete,
+                  :send_key
+
+    alias expiration ttl
+    alias expiration= ttl=
+
+    def initialize(opt={})
+      # Optional expression filter. If filter_exp exists and evaluates to false, the specific batch key
+      # request is not performed and {BatchRecord#result_code} is set to
+      # {ResultCode#FILTERED_OUT}.
+      #
+      # If exists, this filter overrides the batch parent filter {Policy#filter_exp}
+      # for the specific key in batch commands that allow a different policy per key.
+      # Otherwise, this filter is ignored.
+      #
+      # Default: nil
+      @filter_exp = opt[:filter_exp]
+
+      # Qualify how to handle writes where the record already exists.
+      #
+      # Default: RecordExistsAction::UPDATE
+      @record_exists_action = opt.fetch(:record_exists_action, RecordExistsAction::UPDATE)
+
+      # Desired consistency guarantee when committing a transaction on the server. The default
+      # (COMMIT_ALL) indicates that the server should wait for master and all replica commits to
+      # be successful before returning success to the client.
+      #
+      # Default: CommitLevel::COMMIT_ALL
+      @commit_level = opt.fetch(:commit_level, CommitLevel::COMMIT_ALL)
+
+      # Qualify how to handle record writes based on record generation. The default (NONE)
+      # indicates that the generation is not used to restrict writes.
+      #
+      # The server does not support this field for UDF execute() calls. The read-modify-write
+      # usage model can still be enforced inside the UDF code itself.
+      #
+      # Default: GenerationPolicy::NONE
+      @generation_policy = opt.fetch(:generation_policy, GenerationPolicy::NONE)
+
+      # Expected generation. Generation is the number of times a record has been modified
+      # (including creation) on the server. If a write operation is creating a record,
+      # the expected generation would be <code>0</code>. This field is only relevant when
+      # generationPolicy is not NONE.
+      #
+      # The server does not support this field for UDF execute() calls. The read-modify-write
+      # usage model can still be enforced inside the UDF code itself.
+      #
+      # Default: 0
+      @generation = opt.fetch(:generation, 0)
+
+      # Record expiration; also known as time-to-live (TTL).
+      # Seconds record will live before being removed by the server.
+      #
+      # Supported values:
+      # - `Aerospike::TTL::NEVER_EXPIRE`: Never expire record; requires Aerospike 2
+      #    server versions >= 2.7.2 or Aerospike 3 server versions >= 3.1.4. Do
+      #    not use for older servers.
+      # - `Aerospike::TTL::NAMESPACE_DEFAULT`: Default to namespace configuration
+      #    variable "default-ttl" on the server.
+      # - `Aerospike::TTL::DONT_UPDATE`: Do not change a record's expiration date
+      #   when updating the record. Requires Aerospike server v3.10.1 or later.
+      # - Any value > 0: Actual time-to-live in seconds.
+      @ttl = opt[:ttl] || opt[:expiration] || 0
+
+      # If the transaction results in a record deletion, leave a tombstone for the record.
+      # This prevents deleted records from reappearing after node failures.
+      # Valid for Aerospike Server Enterprise Edition only.
+      #
+      # Default: false (do not tombstone deleted records).
+      @durable_delete = opt.fetch(:durable_delete, false)
+
+      # Send user defined key in addition to hash digest.
+      # If true, the key will be stored with the record on the server.
+      #
+      # Default: false (do not send the user defined key)
+      @send_key = opt.fetch(:send_key, false)
+
+      self
+    end
+  end
+end

data/lib/aerospike/policy/policy.rb

@@ -22,7 +22,7 @@ module Aerospike
   # Container object for client policy command.
   class Policy
     attr_accessor :filter_exp, :priority, :timeout, :max_retries, :sleep_between_retries, :consistency_level,
-                  :predexp, :fail_on_filtered_out, :replica, :use_compression, :socket_timeout
+                  :fail_on_filtered_out, :replica, :use_compression, :socket_timeout
 
     alias total_timeout timeout
     alias total_timeout= timeout=
@@ -31,7 +31,7 @@ module Aerospike
       # Container object for transaction policy attributes used in all database
       # operation calls.
 
-      # Optional expression filter. If filterExp exists and evaluates to false, the
+      # Optional expression filter. If filter_exp exists and evaluates to false, the
       # transaction is ignored.
       #
       # Default: nil
@@ -57,44 +57,7 @@ module Aerospike
       # TODO: Remove for next major release
       @priority = opt[:priority] || Priority::DEFAULT
 
-      # Set optional predicate expression filters in postfix notation.
-      # Predicate expression filters are applied on the query results on the server.
-      # Predicate expression filters may occur on any bin in the record.
-      # Requires Aerospike Server versions >= 3.12
-      #
-      # Postfix notation is described here: http://wiki.c2.com/?PostfixNotation
-      #
-      # Example:
-      #
-      # (c >= 11 and c <= 20) or (d > 3 and (d < 5)
-      # policy.predexp = [
-      #   PredExp.integer_bin("c"),
-      #   PredExp.integer_value(11),
-      #   PredExp.integer_greater_eq(),
-      #   PredExp.integer_bin("c"),
-      #   PredExp.integer_value(20),
-      #   PredExp.integer_less_eq(),
-      #   PredExp.and(2),
-      #   PredExp.integer_bin("d"),
-      #   PredExp.integer_value(3),
-      #   PredExp.integer_greater(),
-      #   PredExp.integer_bin("d"),
-      #   PredExp.integer_value(5),
-      #   PredExp.integer_less(),
-      #   PredExp.and(2),
-      #   PredExp.or(2)
-      # ]
-      #
-      # # Record last update time > 2017-01-15
-      # policy.predexp = [
-      #   PredExp.rec_last_update(),
-      #   PredExp.integer_value(Time.new(2017, 1, 15).to_i),
-      #   PredExp.integer_greater(),
-      #   PredExp.integer_greater()
-      # ]
-      @predexp = opt[:predexp] || nil
-
-      # Throw exception if @predexp is defined and that filter evaluates
+      # Throw exception if @filter_exp is defined and that filter evaluates
       # to false (transaction ignored). The Aerospike::Exceptions::Aerospike
       # will contain result code Aerospike::ResultCode::FILTERED_OUT.
       # This field is not applicable to batch, scan or query commands.

data/lib/aerospike/query/server_command.rb

@@ -38,6 +38,7 @@ module Aerospike
 
     def parse_row(result_code)
       field_count = @data_buffer.read_int16(18)
+      result_code = @data_buffer.read(5).ord & 0xFF
       skip_key(field_count)
 
       if result_code != 0

data/lib/aerospike/query/statement.rb

@@ -21,9 +21,7 @@ module Aerospike
   # index name, filters, and operations.
   class Statement
 
-    attr_accessor :namespace, :set_name, :index_name, :bin_names, :task_id
-    attr_accessor :filters, :package_name, :function_name, :function_args, :operations
-    attr_accessor :predexp, :return_data, :records_per_second
+    attr_accessor :namespace, :set_name, :index_name, :bin_names, :task_id, :filters, :package_name, :function_name, :function_args, :operations, :return_data, :records_per_second
 
     def initialize(namespace, set_name, bin_names=[])
       # Namespace determines query Namespace
@@ -46,16 +44,6 @@ module Aerospike
       # aggregation function.
       @filters = []
 
-      # Predicate expressions in postfix notation. If the expression is evaluated to false,
-      # the record will be ommited in the results.
-      #
-      # This method is redundant because PredExp can now be set in the base Policy for
-      # any transaction (including queries).
-      #
-      # NOTE : Policy.predexp takes precedence to this value. This value will be
-      # deprecated in the future.
-      @predexp = nil
-
       @package_name  = nil
       @function_name = nil
       @function_args = nil
@@ -83,27 +71,23 @@ module Aerospike
     end
 
     def is_scan?
-      return (filters.nil? || (filters.empty?))
+      filters.nil? || filters.empty?
     end
 
     def set_task_id
-      while @task_id == 0
-        @task_id = rand(RAND_MAX)
-      end
+      @task_id = rand(RAND_MAX) while @task_id == 0
     end
 
     def reset_task_id
       @task_id = rand(RAND_MAX)
-      while @task_id == 0
-        @task_id = rand(RAND_MAX)
-      end
+      @task_id = rand(RAND_MAX) while @task_id == 0
     end
 
 
 
     private
 
-    RAND_MAX = 2**63 - 1
+    RAND_MAX = (2**63) - 1
 
   end # class
 end

data/lib/aerospike/utils/buffer.rb

@@ -25,7 +25,7 @@ module Aerospike
   # Buffer class to ease the work around
   class Buffer #:nodoc:
     @@buf_pool = Pool.new
-    @@buf_pool.create_proc = Proc.new { Buffer.new }
+    @@buf_pool.create_proc = proc { Buffer.new }
 
     attr_accessor :buf
 
@@ -43,7 +43,7 @@ module Aerospike
     MAX_BUFFER_SIZE = 10 * 1024 * 1024
 
     def initialize(size = DEFAULT_BUFFER_SIZE, buf = nil)
-      @buf = (buf ? buf : ("%0#{size}d" % 0))
+      @buf = buf || format("%0#{size}d", 0)
       @buf.force_encoding("binary")
       @slice_end = @buf.bytesize
     end
@@ -60,7 +60,7 @@ module Aerospike
       @buf.bytesize
     end
 
-    alias_method :length, :size
+    alias length size
 
     def eat!(n)
       @buf.replace(@buf[n..-1])
@@ -74,7 +74,7 @@ module Aerospike
       end
 
       if @buf.bytesize < length
-        @buf.concat("%0#{length - @buf.bytesize}d" % 0)
+        @buf.concat(format("%0#{length - @buf.bytesize}d", 0))
       end
       @slice_end = length
     end
@@ -144,37 +144,37 @@ module Aerospike
 
     def read_int16(offset)
       vals = @buf[offset..offset + 1]
-      vals.unpack(INT16)[0]
+      vals.unpack1(INT16)
     end
 
     def read_uint16(offset)
       vals = @buf[offset..offset + 1]
-      vals.unpack(UINT16)[0]
+      vals.unpack1(UINT16)
     end
 
     def read_int32(offset)
       vals = @buf[offset..offset + 3]
-      vals.unpack(INT32)[0]
+      vals.unpack1(INT32)
     end
 
     def read_uint32(offset)
       vals = @buf[offset..offset + 3]
-      vals.unpack(UINT32)[0]
+      vals.unpack1(UINT32)
     end
 
     def read_int64(offset)
       vals = @buf[offset..offset + 7]
-      vals.unpack(INT64)[0]
+      vals.unpack1(INT64)
     end
 
     def read_uint64_little_endian(offset)
       vals = @buf[offset..offset + 7]
-      vals.unpack(UINT64LE)[0]
+      vals.unpack1(UINT64LE)
     end
 
     def read_uint64(offset)
       vals = @buf[offset..offset + 7]
-      vals.unpack(UINT64)[0]
+      vals.unpack1(UINT64)
     end
 
     def read_var_int64(offset, len)
@@ -190,7 +190,7 @@ module Aerospike
 
     def read_double(offset)
       vals = @buf[offset..offset + 7]
-      vals.unpack(DOUBLE)[0]
+      vals.unpack1(DOUBLE)
     end
 
     def read_bool(offset, length)
@@ -219,13 +219,13 @@ module Aerospike
       @buf.bytes[start...finish].each do |c|
         if counter >= start
           print "%02x " % c
-          ascii << (c.between?(32, 126) ? c : ?.)
-          print " " if ascii.length == (width / 2 + 1)
+          ascii << (c.between?(32, 126) ? c : '.')
+          print " " if ascii.length == ((width / 2) + 1)
           if ascii.length > width
             ascii << "|"
             puts ascii
             ascii = "|"
-            print "%08x  " % (counter + 1)
+            print format("%08x  ", (counter + 1))
           end
         end
         counter += 1

data/lib/aerospike/version.rb

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