Class: Aerospike::BatchDeletePolicy

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

Overview

Policy attributes used in batch delete commands.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(opt = {}) ⇒ BatchDeletePolicy

Returns a new instance of BatchDeletePolicy.

[View source]

23
24
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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/aerospike/policy/batch_delete_policy.rb', line 23

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

Instance Attribute Details

#commit_level ⇒ Object

Returns the value of attribute commit_level.


21
22
23
 
# File 'lib/aerospike/policy/batch_delete_policy.rb', line 21

def commit_level
  @commit_level
end

#durable_delete ⇒ Object

Returns the value of attribute durable_delete.


21
22
23
 
# File 'lib/aerospike/policy/batch_delete_policy.rb', line 21

def durable_delete
  @durable_delete
end

#filter_exp ⇒ Object

Returns the value of attribute filter_exp.


21
22
23
 
# File 'lib/aerospike/policy/batch_delete_policy.rb', line 21

def filter_exp
  @filter_exp
end

#generation ⇒ Object

Returns the value of attribute generation.


21
22
23
 
# File 'lib/aerospike/policy/batch_delete_policy.rb', line 21

def generation
  @generation
end

#generation_policy ⇒ Object

Returns the value of attribute generation_policy.


21
22
23
 
# File 'lib/aerospike/policy/batch_delete_policy.rb', line 21

def generation_policy
  @generation_policy
end

#send_key ⇒ Object

Returns the value of attribute send_key.


21
22
23
 
# File 'lib/aerospike/policy/batch_delete_policy.rb', line 21

def send_key
  @send_key
end