Class: Aerospike::BatchReadPolicy

Inherits:
Object
  • Object
show all
Defined in:
lib/aerospike/policy/batch_read_policy.rb

Overview

Policy attributes used in batch read commands.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opt = {}) ⇒ BatchReadPolicy

Returns a new instance of BatchReadPolicy.

[View source]

25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/aerospike/policy/batch_read_policy.rb', line 25

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]

  # Determines how record TTL (time to live) is affected on reads. When enabled, the server can
  # efficiently operate as a read-based LRU cache where the least recently used records are expired.
  # The value is expressed as a percentage of the TTL sent on the most recent write such that a read
  # within this interval of the record’s end of life will generate a touch.
  #
  # For example, if the most recent write had a TTL of 10 hours and read_touch_ttl_percent is set to
  # 80, the next read within 8 hours of the record's end of life (equivalent to 2 hours after the most
  # recent write) will result in a touch, resetting the TTL to another 10 hours.
  #
  # Values:
  #
  # 0 : Use server config default-read-touch-ttl-pct for the record's namespace/set.
  # -1 : Do not reset record TTL on reads.
  # 1 - 100 : Reset record TTL on reads when within this percentage of the most recent write TTL.
  # Default: 0
  @read_touch_ttl_percent = opt[:read_touch_ttl_percent] || 0
end

Instance Attribute Details

#filter_exp ⇒ Object

Returns the value of attribute filter_exp.


23
24
25
 
# File 'lib/aerospike/policy/batch_read_policy.rb', line 23

def filter_exp
  @filter_exp
end

#read_touch_ttl_percent ⇒ Object

Returns the value of attribute read_touch_ttl_percent.


23
24
25
 
# File 'lib/aerospike/policy/batch_read_policy.rb', line 23

def read_touch_ttl_percent
  @read_touch_ttl_percent
end