aerospike 2.11.0 → 2.16.0

data/lib/aerospike/node_validator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# Copyright 2014-2018 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
@@ -19,13 +19,11 @@
 
 module Aerospike
   class NodeValidator # :nodoc:
-    VERSION_REGEXP = /(?<v1>\d+)\.(?<v2>\d+)\.(?<v3>\d+).*/.freeze
 
-    attr_reader :host, :aliases, :name, :use_new_info, :features, :cluster_name, :tls_options, :conn
+    attr_reader :host, :aliases, :name, :features, :cluster_name, :tls_options, :conn
 
     def initialize(cluster, host, timeout, cluster_name, tls_options = {})
       @cluster = cluster
-      @use_new_info = true
       @features = Set.new
       @host = host
       @cluster_name = cluster_name
@@ -46,7 +44,7 @@ module Aerospike
       begin
         conn = Cluster::CreateConnection.(@cluster, Host.new(address, host.port, host.tls_name))
 
-        commands = %w[node build features]
+        commands = %w[node features]
         commands << address_command unless is_loopback?(address)
 
         info_map = Info.request(conn, *commands)
@@ -58,16 +56,10 @@ module Aerospike
           if features = info_map['features']
             @features = features.split(';').to_set
           end
-
-          # Check new info protocol support for >= 2.6.6 build
-          if build_version = info_map['build']
-            v1, v2, v3 = parse_version_string(build_version)
-            @use_new_info = v1.to_i > 2 || (v1.to_i == 2 && (v2.to_i > 6 || (v2.to_i == 6 && v3.to_i >= 6)))
-          end
         end
 
         unless is_loopback?(address)
-          aliases = info_map[address_command].split(',').map { |address| get_alias(*address.split(':')) }
+          aliases = info_map[address_command].split(',').map { |addr| get_alias(*addr.split(':')) }
         end
       ensure
         conn.close if conn
@@ -103,12 +95,5 @@ module Aerospike
       !!((hostname =~ Resolv::IPv4::Regex) || (hostname =~ Resolv::IPv6::Regex))
     end
 
-    def parse_version_string(version)
-      if v = VERSION_REGEXP.match(version)
-        return v['v1'], v['v2'], v['v3']
-      end
-
-      raise Aerospike::Exceptions::Parse.new("Invalid build version string in Info: #{version}")
-    end
   end # class
 end # module

data/lib/aerospike/operation.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
@@ -20,7 +20,7 @@ module Aerospike
 
   class Operation
 
-    attr_reader :op_type, :bin_name, :bin_value
+    attr_reader :op_type, :bin_name, :bin_value, :ctx
 
     READ        = 1
     READ_HEADER = 1
@@ -31,11 +31,17 @@ module Aerospike
     APPEND      = 9
     PREPEND     = 10
     TOUCH       = 11
+    BIT_READ    = 12
+    BIT_MODIFY  = 13
+    DELETE      = 14
+    HLL_READ    = 15
+    HLL_MODIFY  = 16
 
-    def initialize(op_type, bin_name=nil, bin_value=NullValue.new)
+    def initialize(op_type, bin_name=nil, bin_value=NullValue.new, ctx = nil)
       @op_type = op_type
       @bin_name = bin_name
       @bin_value = Value.of(bin_value)
+      @ctx = ctx
       self
     end
 
@@ -71,6 +77,10 @@ module Aerospike
       Operation.new(TOUCH)
     end
 
+    def self.delete
+      Operation.new(DELETE)
+    end
+
   end
 
 end # module

data/lib/aerospike/policy/admin_policy.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.

data/lib/aerospike/policy/batch_policy.rb

@@ -1,4 +1,4 @@
-# Copyright 2014-2018 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.

data/lib/aerospike/policy/client_policy.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-# Copyright 2014-2018 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
@@ -27,6 +27,7 @@ module Aerospike
     attr_accessor :cluster_name
     attr_accessor :tls
     attr_accessor :policies
+    attr_accessor :rack_aware, :rack_id
 
     def initialize(opt={})
       # Initial host connection timeout in seconds. The timeout when opening a connection
@@ -56,6 +57,20 @@ module Aerospike
 
       # Default Policies
       @policies = opt.fetch(:policies) { Hash.new }
+
+      # Track server rack data.  This field is useful when directing read commands to the server node
+      # that contains the key and exists on the same rack as the client.  This serves to lower cloud
+      # provider costs when nodes are distributed across different racks/data centers.
+      #
+      # ClientPolicy#rack_id, Replica#PREFER_RACK and server rack
+      # configuration must also be set to enable this functionality.
+      @rack_aware = opt[:rack_aware] || false
+
+      # Rack where this client instance resides.
+      #
+      # ClientPolicy#rack_aware, Replica#PREFER_RACK and server rack
+      # configuration must also be set to enable this functionality.
+      @rack_id = opt[:rack_id] || 0
     end
 
     def requires_authentication

data/lib/aerospike/policy/commit_level.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/aerospike/policy/consistency_level.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/aerospike/policy/generation_policy.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/aerospike/policy/operate_policy.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2016-2017 Aerospike, Inc.
+# Copyright 2016-2020 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/aerospike/policy/policy.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -15,6 +15,7 @@
 
 require 'aerospike/policy/priority'
 require 'aerospike/policy/consistency_level'
+require 'aerospike/policy/replica'
 
 
 module Aerospike
@@ -22,7 +23,8 @@ module Aerospike
   # Container object for client policy command.
   class Policy
 
-    attr_accessor :priority, :timeout, :max_retries, :sleep_between_retries, :consistency_level
+    attr_accessor :priority, :timeout, :max_retries, :sleep_between_retries, :consistency_level,
+                  :predexp, :fail_on_filtered_out, :replica, :use_compression
 
     def initialize(opt={})
       # Container object for transaction policy attributes used in all database
@@ -32,11 +34,71 @@ module Aerospike
       # Currently, only used for scans.
       @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
+      # 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.
+      @fail_on_filtered_out = opt[:fail_on_filtered_out] || false
+
       # How replicas should be consulted in a read operation to provide the desired
       # consistency guarantee. Default to allowing one replica to be used in the
       # read operation.
       @consistency_level = opt[:consistency_level] || Aerospike::ConsistencyLevel::CONSISTENCY_ONE
 
+
+      # Send read commands to the node containing the key's partition replica type.
+      # Write commands are not affected by this setting, because all writes are directed 
+      # to the node containing the key's master partition.
+      #
+      # Default to sending read commands to the node containing the key's master partition.
+      @replica = opt[:replica] || Aerospike::Replica::MASTER
+
+      # Use zlib compression on write or batch read commands when the command buffer size is greater
+      # than 128 bytes. In addition, tell the server to compress its response on read commands.
+      # The server response compression threshold is also 128 bytes.
+      #
+      # This option will increase cpu and memory usage (for extra compressed buffers), but
+      # decrease the size of data sent over the network.
+      @use_compression = opt[:use_compression] || false
+
       # Transaction timeout.
       # This timeout is used to set the socket timeout and is also sent to the
       # server along with the transaction in the wire protocol.

data/lib/aerospike/policy/priority.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/aerospike/policy/query_policy.rb

@@ -1,4 +1,4 @@
-# Copyright 2014-2018 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
@@ -24,6 +24,7 @@ module Aerospike
 
     attr_accessor :include_bin_data
     attr_accessor :record_queue_size
+    attr_accessor :records_per_second
 
     def initialize(opt={})
       super(opt)
@@ -42,6 +43,12 @@ module Aerospike
       # Default is 5000.
       @record_queue_size = opt[:record_queue_size] || 5000
 
+      # Limit returned records per second (rps) rate for each server.
+      # Will not apply rps limit if records_per_second is zero.
+      # Currently only applicable to a query without a defined filter (scan).
+      # Default is 0
+      @records_per_second = opt[:records_per_second] || 0
+
       self
     end
 

data/lib/aerospike/policy/record_bin_multiplicity.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2016-2017 Aerospike, Inc.
+# Copyright 2016-2020 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/aerospike/policy/record_exists_action.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/aerospike/policy/replica.rb

@@ -0,0 +1,45 @@
+# encoding: utf-8
+# Copyright 2014-2020 Aerospike, Inc.
+#
+# 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 Replica
+
+    # Read from node containing key's master partition.  This is the default behavior.
+    MASTER = 0
+
+    # Distribute reads across nodes containing key's master and replicated partitions
+    # in round-robin fashion.
+    MASTER_PROLES = 1
+
+    # Always try node containing master partition first. If connection fails and
+    # Policy#retryOnTimeout is true, try nodes containing prole partition.
+    SEQUENCE = 2
+
+    # 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
+    # configuration must also be set to enable this functionality.
+    PREFER_RACK = 3
+
+    # Distribute reads across all nodes in cluster in round-robin fashion.
+    # This option is useful when the replication factor equals the number
+    # of nodes in the cluster and the overhead of requesting proles is not desired.
+    RANDOM = 4
+
+  end # module
+
+end # module

data/lib/aerospike/policy/scan_policy.rb

@@ -1,4 +1,4 @@
-# Copyright 2014-2018 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
@@ -28,6 +28,7 @@ module Aerospike
     attr_accessor :fail_on_cluster_change
     attr_accessor :socket_timeout
     attr_accessor :record_queue_size
+    attr_accessor :records_per_second
 
     def initialize(opt={})
       super(opt)
@@ -59,6 +60,12 @@ module Aerospike
       # Default is 5000.
       @record_queue_size = opt[:record_queue_size] || 5000
 
+      # Limit returned records per second (rps) rate for each server.
+      # Will not apply rps limit if records_per_second is zero.
+      # Currently only applicable to a query without a defined filter (scan).
+      # Default is 0
+      @records_per_second = opt[:records_per_second] || 0
+
       self
     end
 

data/lib/aerospike/policy/write_policy.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.

data/lib/aerospike/query/filter.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.

data/lib/aerospike/query/query_command.rb

@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014-2017 Aerospike, Inc.
+# Copyright 2014-2020 Aerospike, Inc.
 #
 # Portions may be licensed to Aerospike, Inc. under one or more contributor
 # license agreements.
@@ -82,6 +82,11 @@ module Aerospike
           fieldCount+=1
         end
       else
+        if @policy.records_per_second > 0
+          @data_offset += 4 + FIELD_HEADER_SIZE
+          fieldCount += 1
+        end
+
         # Calling query with no filters is more efficiently handled by a primary index scan.
         # Estimate scan options size.
         @data_offset += (2 + FIELD_HEADER_SIZE)
@@ -93,9 +98,11 @@ module Aerospike
       @data_offset += 8 + FIELD_HEADER_SIZE
       fieldCount+=1
 
-      if @statement.predexp
+      predexp = @policy.predexp || @statement.predexp
+
+      if predexp
         @data_offset += FIELD_HEADER_SIZE
-        predSize = Aerospike::PredExp.estimate_size(@statement.predexp)
+        predSize = Aerospike::PredExp.estimate_size(predexp)
         @data_offset += predSize
         fieldCount += 1
       end
@@ -170,6 +177,10 @@ module Aerospike
           end
         end
       else
+        if @policy.records_per_second > 0
+          write_field_int(@policy.records_per_second, Aerospike::FieldType::RECORDS_PER_SECOND)
+        end
+
         # Calling query with no filters is more efficiently handled by a primary index scan.
         write_field_header(2, Aerospike::FieldType::SCAN_OPTIONS)
         priority = @policy.priority.ord
@@ -184,10 +195,10 @@ module Aerospike
       @data_buffer.write_int64(@statement.task_id, @data_offset)
       @data_offset += 8
 
-      if @statement.predexp
+      if predexp
         write_field_header(predSize, Aerospike::FieldType::PREDEXP)
         @data_offset = Aerospike::PredExp.write(
-          @statement.predexp, @data_buffer, @data_offset
+          predexp, @data_buffer, @data_offset
         )
       end