aerospike 3.0.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89cd439991384bc1b01465f9c28e9be14f9cb31ba283801ba6f3297eea240015
-  data.tar.gz: 6eab65e105f999420692a1757dcaaae9908384851e2f43fe49f6e805be2a3bf7
+  metadata.gz: cbbb3eae452fb9c1bbe7a0a99e7505b4fa774396b9591edc80ae707abb9896e0
+  data.tar.gz: cd2bf9f22247dbc8f49581507b17f6347edf0a6f46a0c307f87eae45c3bf775b
 SHA512:
-  metadata.gz: 984c705a6d1604c95ec428f30a05e1f7385d935aaee6d7acab50fb604ff3718836a6184af107e6e842377e177a4bbac46f28954a49d86fa97b9755ef290ee212
-  data.tar.gz: fc47757f4a1c55d25c56fba9d663e93dcc81a4c6d0c0d6e691d2d8d80722a32e9901f09415b1958a294ba45fd8dae9aa6d2b433fcb77e96bd957b6bf00fc4a0c
+  metadata.gz: 88c12b118fcdf74f170a06ac3158b47f3e81076ee7c851d5ca06ea80b82d2b668c2df6588444e22c011dd43cbddce6586ecaaa30c895e54cefd47573e75b55ac
+  data.tar.gz: ffc436ee1b5696765fdc8ab00f87ef0c6e33afea3ae3ddc2d63dcd01fed91e62f3ddb8b109acf9fae65bc5bcabd9c1f36af8c60b87e86fb25c8b1528ed5e926b

data/CHANGELOG.md

@@ -2,6 +2,27 @@
 
 All notable changes to this project will be documented in this file.
 
+## [4.0.0] 2024-08-14
+
+- **New Features**
+  - [CLIENT-2177] Add support for `MapReturnType#MAP_ORDERED` and `MapReturnType#MAP_UNORDERED`.
+  - [CLIENT-2308] Add `Exp#infinity_val` and `Exp#wildcard_val`.
+  - [CLIENT_1731] Support Batch Operations.
+
+- **Updates**
+  - [CLIENT-3055] Remove Unsupported Server Features (`Predexp` and `BatchDirect`).
+
+- **Improvements**
+  - [CLIENT-3056] Fix Github Actions Workflow. Tests still fail due to runner constraints, but we are now on the right track.
+  - [CLIENT-2682] Code Coverage - obtain current code coverage numbers for automated unit/integration functional tests.
+
+- **Fixes**
+  - [CLIENT-3080] Set correct return types in list/map read expressions.
+    Set `bool` return type for list read expressions with `ListReturnType.EXISTS`.
+    Set `bool` return type for map read expressions with `MapReturnType.EXISTS`.
+    Set `map` return type for map read expressions with `MapReturnType.UNORDERED_MAP` or  `MapReturnType.ORDERED_MAP`.
+  - [CLIENT-3072] Fix an issue where `Statement#return_data` is not respected.
+
 ## [3.0.0] 2023-12-15
 Notice: This version of the client only supports Aerospike Server v6.0 and later. Some features will work for the older server versions.
 - **new_features**

data/README.md

@@ -11,14 +11,18 @@ An Aerospike library for Ruby.
 
 This library is compatible with Ruby 2.3+ and supports Linux, Mac OS X and various other BSDs.
 
-- [Usage](#Usage)
-- [Prerequisites](#Prerequisites)
-- [Installation](#Installation)
-- [Benchmarks](#Benchmarks)
-- [API Documentaion](#API-Documentation)
-- [Tests](#Tests)
-- [Examples](#Examples)
-  - [Tools](#Tools)
+- [Aerospike Ruby Client   ](#aerospike-ruby-client---)
+  - [Usage:](#usage)
+  - [Prerequisites](#prerequisites)
+  - [Installation](#installation)
+    - [Installation from Ruby gems](#installation-from-ruby-gems)
+    - [Installation from source](#installation-from-source)
+  - [Tests](#tests)
+  - [Examples](#examples)
+    - [Tools](#tools)
+  - [Benchmarks](#benchmarks)
+  - [API Documentation](#api-documentation)
+  - [License](#license)
 
 
 ## Usage:
@@ -97,7 +101,7 @@ This library is packaged with a number of tests.
 
 To run all the test cases:
 
-    $ AEROSPIKE_HOSTS="<host:port>[,<hoist:port>]" AEROSPIKE_USER="<user>" AEROSPIKE_PASSWORD="<pass>" bundle exec rspec
+    $ AEROSPIKE_HOSTS="<host:port>[,<host:port>]" AEROSPIKE_USER="<user>" AEROSPIKE_PASSWORD="<pass>" bundle exec rspec
 
 <a name="Examples"></a>
 ## Examples

data/lib/aerospike/batch_attr.rb

@@ -0,0 +1,292 @@
+# frozen_string_literal: true
+
+# Copyright 2014-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
+
+  class BatchAttr
+
+    attr_reader :filter_exp, :read_attr, :write_attr, :info_attr, :expiration, :generation, :has_write, :send_key
+
+    def initialize(ops = nil, opt = {})
+      rp = create_policy(opt, BatchPolicy, nil)
+      wp = create_policy(opt, BatchWritePolicy, nil)
+
+      read_all_bins = false
+      read_header = false
+      has_read = false
+      has_write_op = false
+
+      ops&.each do |op|
+        case op.op_type
+        when Operation::BIT_READ, Operation::EXP_READ, Operation::HLL_READ, Operation::CDT_READ, Operation::READ	# Read all bins if no bin is specified.
+          read_all_bins = op.bin_name.nil?
+          has_read = true
+
+        when Operation::READ_HEADER
+          read_header = true
+          has_read = true
+
+        else
+          has_write_op = true
+        end
+      end
+
+      if has_write_op
+        set_batch_write(wp)
+
+        if has_read
+          @read_attr |= Aerospike::INFO1_READ
+
+          if read_all_bins
+            @read_attr |= Aerospike::INFO1_GET_ALL
+          elsif read_header
+            @read_attr |= Aerospike::INFO1_NOBINDATA
+          end
+        end
+      else
+        set_batch_read(rp)
+
+        if read_all_bins
+          @read_attr |= Aerospike::INFO1_GET_ALL
+        elsif read_header
+          @read_attr |= Aerospike::INFO1_NOBINDATA
+        end
+      end
+    end
+
+    def set_read(rp)
+      @filter_exp = nil
+      @read_attr = Aerospike::INFO1_READ
+
+      @write_attr = 0
+      @info_attr = 0
+
+      @expiration = 0
+      @generation = 0
+      @has_write = false
+      @send_key = false
+    end
+
+    def set_batch_read(rp)
+      @filter_exp = rp.filter_exp
+      @read_attr = Aerospike::INFO1_READ
+
+      @write_attr = 0
+      @info_attr = 0
+
+      @expiration = 0
+      @generation = 0
+      @has_write = false
+      @send_key = false
+    end
+
+    def adjust_read(ops)
+        read_all_bins = false
+        read_header = false
+
+        ops.each do |op|
+       case op.op_type
+       when Operation::BIT_READ, Operation::EXP_READ, Operation::HLL_READ, Operation::CDT_READ, Operation::READ	# Read all bins if no bin is specified.
+              read_all_bins = op.bin_name.nil?
+       when Operation::READ_HEADER
+            read_header = true
+       end
+        end
+
+        if read_all_bins
+          @read_attr |= Aerospike::INFO1_GET_ALL
+        elsif read_header
+          @read_attr |= Aerospike::INFO1_NOBINDATA
+        end
+    end
+
+    def adjust_read_all_bins(read_all_bins)
+      @read_attr |= read_all_bins ? Aerospike::INFO1_GET_ALL : Aerospike::INFO1_NOBINDATA
+    end
+
+    def set_write(wp)
+      @filter_exp = nil
+      @read_attr = 0
+      @write_attr = Aerospike::INFO2_WRITE | Aerospike::INFO2_RESPOND_ALL_OPS
+      @info_attr = 0
+      @expiration = 0
+      @generation = 0
+      @has_write = true
+      @send_key = wp.send_key
+    end
+
+    def set_batch_write(wp)
+      @filter_exp = wp.filter_exp
+      @read_attr = 0
+      @write_attr = Aerospike::INFO2_WRITE | Aerospike::INFO2_RESPOND_ALL_OPS
+      @info_attr = 0
+      @expiration = wp.expiration
+      @has_write = true
+      @send_key = wp.send_key
+
+      case wp.generation_policy
+      when GenerationPolicy::NONE
+        @generation = 0
+      when GenerationPolicy::EXPECT_GEN_EQUAL
+        @generation = wp.generation
+        @write_attr |= Aerospike::INFO2_GENERATION
+      when GenerationPolicy::EXPECT_GEN_GT
+        @generation = wp.generation
+        @write_attr |= Aerospike::INFO2_GENERATION_GT
+      else
+        @generation = 0
+      end
+
+      case wp.record_exists_action
+      when RecordExistsAction::UPDATE
+      # NOOP
+      when RecordExistsAction::UPDATE_ONLY
+        @info_attr |= Aerospike::INFO3_UPDATE_ONLY
+      when RecordExistsAction::REPLACE
+        @info_attr |= Aerospike::INFO3_CREATE_OR_REPLACE
+      when RecordExistsAction::REPLACE_ONLY
+        @info_attr |= Aerospike::INFO3_REPLACE_ONLY
+      when RecordExistsAction::CREATE_ONLY
+        @write_attr |= Aerospike::INFO2_CREATE_ONLY
+      end
+
+      if wp.durable_delete
+        @write_attr |= Aerospike::INFO2_DURABLE_DELETE
+      end
+
+      if wp.commit_level == CommitLevel::COMMIT_MASTER
+        @info_attr |= Aerospike::INFO3_COMMIT_MASTER
+      end
+    end
+
+    def adjust_write(ops)
+      read_all_bins = false
+      read_header = false
+      has_read = false
+
+      ops.each do |op|
+        case op.op_type
+        when Operation::BIT_READ, Operation::EXP_READ, Operation::HLL_READ, Operation::CDT_READ, Operation::READ	# Read all bins if no bin is specified.
+          read_all_bins = op.bin_name.nil?
+          has_read = true
+
+        when Operation::READ_HEADER
+          read_header = true
+          has_read = true
+
+        end
+      end
+
+      if has_read
+        @read_attr |= Aerospike::INFO1_READ
+
+        if read_all_bins
+          @read_attr |= Aerospike::INFO1_GET_ALL
+        elsif read_header
+          @read_attr |= Aerospike::INFO1_NOBINDATA
+        end
+      end
+    end
+
+    def set_udf(up)
+      @filter_exp = nil
+      @read_attr = 0
+      @write_attr = Aerospike::INFO2_WRITE
+      @info_attr = 0
+      @expiration = 0
+      @generation = 0
+      @has_write = true
+      @send_key = up.send_key
+    end
+
+    def set_batch_udf(up)
+      @filter_exp = up.filter_exp
+      @read_attr = 0
+      @write_attr = Aerospike::INFO2_WRITE
+      @info_attr = 0
+      @expiration = up.expiration
+      @generation = 0
+      @has_write = true
+      @send_key = up.send_key
+
+      if up.durable_delete
+        @write_attr |= Aerospike::INFO2_DURABLE_DELETE
+      end
+
+      if up.commit_level == CommitLevel::COMMIT_MASTER
+        @info_attr |= Aerospike::INFO3_COMMIT_MASTER
+      end
+    end
+
+    def set_delete(dp)
+      @filter_exp = nil
+      @read_attr = 0
+      @write_attr = Aerospike::INFO2_WRITE | Aerospike::INFO2_RESPOND_ALL_OPS | Aerospike::INFO2_DELETE
+      @info_attr = 0
+      @expiration = 0
+      @generation = 0
+      @has_write = true
+      @send_key = dp.send_key
+    end
+
+    def set_batch_delete(dp)
+      @filter_exp = dp.filter_exp
+      @read_attr = 0
+      @write_attr = Aerospike::INFO2_WRITE | Aerospike::INFO2_RESPOND_ALL_OPS | Aerospike::INFO2_DELETE
+      @info_attr = 0
+      @expiration = 0
+      @has_write = true
+      @send_key = dp.send_key
+
+      case dp.generation_policy
+      when GenerationPolicy::NONE
+        @generation = 0
+      when GenerationPolicy::EXPECT_GEN_EQUAL
+        @generation = dp.generation
+        @write_attr |= Aerospike::INFO2_GENERATION
+      when GenerationPolicy::EXPECT_GEN_GT
+        @generation = dp.generation
+        @write_attr |= Aerospike::INFO2_GENERATION_GT
+      else
+       @generation = 0
+      end
+
+      if dp.durable_delete
+        @write_attr |= Aerospike::INFO2_DURABLE_DELETE
+      end
+
+      if dp.commit_level == CommitLevel::COMMIT_MASTER
+        @info_attr |= Aerospike::INFO3_COMMIT_MASTER
+      end
+    end
+
+    private
+
+    def create_policy(policy, policy_klass, default_policy = nil)
+      case policy
+      when nil
+        default_policy || policy_klass.new
+      when policy_klass
+        policy
+      when Hash
+        policy_klass.new(policy)
+      else
+        raise TypeError, "policy should be a #{policy_klass.name} instance or a Hash"
+      end
+    end
+  end
+end

data/lib/aerospike/batch_delete.rb

@@ -0,0 +1,48 @@
+# 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
+
+  # Batch delete operation.
+  class BatchDelete < BatchRecord
+    # Optional delete policy.
+    attr_accessor :policy
+
+    # Initialize policy and key.
+    def initialize(key, opt = {})
+      super(key, has_write: true)
+      @policy = BatchRecord.create_policy(opt, BatchDeletePolicy, DEFAULT_BATCH_DELETE_POLICY)
+    end
+
+    def ==(other) # :nodoc:
+      other && other.instance_of?(self.class) && @policy == other.policy
+    end
+
+    DEFAULT_BATCH_DELETE_POLICY = BatchDeletePolicy.new
+
+    # Return wire protocol size. For internal use only.
+    def size # :nodoc:
+      size = 6 # gen(2) + exp(4) = 6
+
+      size += @policy&.filter_exp&.size if @policy&.filter_exp
+      if @policy&.send_key
+          size += @key.user_key.estimate_size + Aerospike::FIELD_HEADER_SIZE + 1
+      end
+
+      size
+    end
+  end
+end

data/lib/aerospike/batch_read.rb

@@ -0,0 +1,97 @@
+# 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.
+
+# Batch key and read only operations with default policy.
+# Used in batch read commands where different bins are needed for each key.
+
+module Aerospike
+
+  class BatchRead < BatchRecord
+
+    # Optional read policy.
+    attr_accessor :policy
+
+    # Bins to retrieve for this key. bin_names are mutually exclusive with
+    # {BatchRead#ops}.
+    attr_accessor :bin_names
+
+    # Optional operations for this key. ops are mutually exclusive with
+    # {BatchRead#bin_names}. A bin_name can be emulated with
+    # {Operation#get(bin_name)}
+    attr_accessor :ops
+
+    # If true, ignore bin_names and read all bins.
+    # If false and bin_names are set, read specified bin_names.
+    # If false and bin_names are not set, read record header (generation, expiration) only.
+    attr_accessor :read_all_bins
+
+    # Initialize batch key and bins to retrieve.
+    def self.read_bins(key, bin_names, opt = {})
+      br = BatchRead.new(key)
+      br.policy = BatchRecord.create_policy(opt, BatchReadPolicy, DEFAULT_BATCH_READ_POLICY)
+      br.bin_names = bin_names
+      br.read_all_bins = false
+      br
+    end
+
+    # Initialize batch key and read_all_bins indicator.
+    def self.read_all_bins(key, opt = {})
+      br = BatchRead.new(key)
+      br.policy = create_policy(opt, BatchReadPolicy, DEFAULT_BATCH_READ_POLICY)
+      br.read_all_bins = true
+      br
+    end
+
+    # Initialize batch key and read operations.
+    def self.ops(key, ops, opt = {})
+      br = BatchRead.new(key)
+      br.policy = create_policy(opt, BatchReadPolicy, DEFAULT_BATCH_READ_POLICY)
+      br.ops = ops
+      br.read_all_bins = false
+      br
+    end
+
+    # Optimized reference equality check to determine batch wire protocol repeat flag.
+    # For internal use only.
+    def ==(other) # :nodoc:
+      other && other.instance_of?(self.class) &&
+        @bin_names.sort == other.bin_names.sort && @ops.sort == other.ops.sort &&
+        @policy == other.policy && @read_all_bins == other.read_all_bins
+    end
+
+    DEFAULT_BATCH_READ_POLICY = BatchReadPolicy.new
+
+    # Return wire protocol size. For internal use only.
+    def size # :nodoc:
+      size = 0
+      size += @policy&.filter_exp&.size if @policy&.filter_exp
+
+      @bin_names&.each do |bin_name|
+        size += bin_name.bytesize + Aerospike::OPERATION_HEADER_SIZE
+      end
+
+      @ops&.each do |op|
+        if op.is_write?
+          raise AerospikeException.new(ResultCode::PARAMETER_ERROR, "Write operations not allowed in batch read")
+        end
+        size += op.bin_name.bytesize + Aerospike::OPERATION_HEADER_SIZE
+        size += op.value.estimate_size
+      end
+
+      size
+    end
+  end
+end

data/lib/aerospike/batch_record.rb

@@ -0,0 +1,83 @@
+# 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
+
+  # Batch key and record result.
+  class BatchRecord
+    # Key.
+    attr_reader :key
+
+    # Record result after batch command has completed.  Will be null if record was not found
+    # or an error occurred. See {BatchRecord#result_code}.
+    attr_reader :record
+
+    # Result code for this returned record. See {ResultCode}.
+    # If not {ResultCode#OK}, the record will be null.
+    attr_accessor :result_code
+
+    # Is it possible that the write transaction may have completed even though an error
+    # occurred for this record. This may be the case when a client error occurs (like timeout)
+    # after the command was sent to the server.
+    attr_accessor :in_doubt
+
+    # Does this command contain a write operation. For internal use only.
+    attr_reader :has_write
+
+    # Constructor.
+    def initialize(key, result_code: ResultCode::NO_RESPONSE, in_doubt: false, has_write: false)
+      @key = key
+      @record = record
+      @result_code = result_code
+      @in_doubt = in_doubt
+      @has_write = has_write
+    end
+
+    def self.create_policy(policy, policy_klass, default_policy = nil) # :nodoc:
+      case policy
+      when nil
+        default_policy || policy_klass.new
+      when policy_klass
+        policy
+      when Hash
+        policy_klass.new(policy)
+      else
+        raise TypeError, "policy should be a #{policy_klass.name} instance or a Hash"
+      end
+    end
+
+    # Prepare for upcoming batch call. Reset result fields because this instance might be
+    # reused. For internal use only.
+    def prepare # :nodoc:
+      @record = nil
+      @result_code = ResultCode::NO_RESPONSE
+      @in_doubt = false
+    end
+
+    # Set record result. For internal use only.
+    def record=(record) # :nodoc:
+      @record = record
+      @result_code = ResultCode::OK
+    end
+
+    # Set error result. For internal use only.
+    def set_error(result_code, in_doubt) # :nodoc:
+      @result_code = result_code
+      @in_doubt = in_doubt
+    end
+
+  end
+end

data/lib/aerospike/batch_results.rb

@@ -0,0 +1,38 @@
+# 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.
+
+# Batch key and read only operations with default policy.
+# Used in batch read commands where different bins are needed for each key.
+
+module Aerospike
+
+  # Batch record results.
+  class BatchResults
+
+    # Record results.
+    attr_accessor :records
+
+    # Indicates if all records returned success.
+    attr_accessor :status
+
+    # Constructor.
+    def intialize(records, status)
+      @records = records
+      @status = status
+    end
+
+  end
+end