Merge pull request #120 from aerospike/CLIENT-1529_Policy_cleanse

[Client-1529] Deprecate unsupported policies
aerospike · Jun 23, 2023 · 8883080 · 8883080
2 parents 68b17fa + f1d39e1
commit 8883080
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 9 deletions.
diff --git a/examples/scan_serial.rb b/examples/scan_serial.rb
@@ -44,7 +44,6 @@ def run_example(client)
   # the load on the server.
   policy = ScanPolicy.new
   policy.max_retries = 1
-  policy.priority = Priority::LOW
 
   node_list = client.nodes
   begin_time = Time.now

diff --git a/lib/aerospike/policy/policy.rb b/lib/aerospike/policy/policy.rb
@@ -51,8 +51,10 @@ def initialize(opt = {})
       #  Default: false
       @fail_on_filtered_out = opt[:fail_on_filtered_out] || false
 
-      # Priority of request relative to other transactions.
-      # Currently, only used for scans.
+      # [:nodoc:]
+      # DEPRECATED
+      # The Aerospike server does not support this policy anymore
+      # TODO: Remove for next major release
       @priority = opt[:priority] || Priority::DEFAULT
 
       # Set optional predicate expression filters in postfix notation.

diff --git a/lib/aerospike/policy/priority.rb b/lib/aerospike/policy/priority.rb
@@ -1,5 +1,5 @@
 # encoding: utf-8
-# Copyright 2014-2020 Aerospike, Inc.
+# Copyright 2014-2023 Aerospike, Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,6 +13,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+
+#[:nodoc:]
+# DEPRECATED
+# TODO: Remove this module on the next major release
 module Aerospike
 
   module Priority

diff --git a/lib/aerospike/policy/scan_policy.rb b/lib/aerospike/policy/scan_policy.rb
@@ -48,16 +48,21 @@ def initialize(opt={})
       # Default is 100.
       @scan_percent = opt[:scan_percent] || 100
 
-      # Issue scan requests in parallel or serially.
+      # [:nodoc:]
+      # DEPRECATED
+      # The Aerospike server does not support this policy anymore
+      # TODO: Remove for next major release
       @concurrent_nodes = opt.fetch(:concurrent_nodes) { true }
 
       # Indicates if bin data is retrieved. If false, only record digests (and
       # user keys if stored on the server) are retrieved.
       # Default is true.
       @include_bin_data = opt.fetch(:include_bin_data) { true }
 
-      # Terminate scan if cluster in fluctuating state.
-      # Default is true.
+      # [:nodoc:]
+      # DEPRECATED
+      # The Aerospike server does not support this policy anymore
+      # TODO: Remove for next major release
       @fail_on_cluster_change = opt.fetch(:fail_on_cluster_change) { true }
 
       # Determines network timeout for each attempt.

diff --git a/spec/aerospike/policy/policy_spec.rb b/spec/aerospike/policy/policy_spec.rb
@@ -25,7 +25,6 @@
       policy = described_class.new
 
       expect(policy.class).to eq described_class
-      expect(policy.priority).to eq Aerospike::Priority::DEFAULT
       expect(policy.timeout).to eq 0
       expect(policy.max_retries).to eq 2
       expect(policy.sleep_between_retries).to eq 0.5

diff --git a/spec/aerospike/policy/write_policy_spec.rb b/spec/aerospike/policy/write_policy_spec.rb
@@ -24,7 +24,6 @@
       policy = described_class.new
 
       expect(policy.class).to eq described_class
-      expect(policy.priority).to eq Aerospike::Priority::DEFAULT
       expect(policy.timeout).to eq 1
       expect(policy.max_retries).to eq 2
       expect(policy.sleep_between_retries).to eq 0.5