Class: Xfers::Etcd::Transaction

Inherits:
Object
  • Object
show all
Defined in:
lib/xfers/etcd/transaction.rb

Overview

Alias class to Etcdv3::KV::Transaction class, for documentation only.

The Etcdserverpb module documentation is: https://www.rubydoc.info/gems/etcdv3/Etcdserverpb

Available comparison types: :equal, :greater, :less, :not_equal

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#compare=(value) (writeonly)

This method returns an undefined value.

Set a list of comparision operations representing a conjunction of terms for guarding the transaction

Parameters:

  • value (Array<Etcdserverpb::Compare>) 


13
14
15
 
# File 'lib/xfers/etcd/transaction.rb', line 13

def compare=(value)
  @compare = value
end

#failure=(value) (writeonly)

This method returns an undefined value.

Set a list of operations to process if any compare test evaluates to false

Parameters:

  • value (Array<Etcdserverpb::RangeRequest, Etcdserverpb::DeleteRangeRequest, Etcdserverpb::PutRequest>) 


25
26
27
 
# File 'lib/xfers/etcd/transaction.rb', line 25

def failure=(value)
  @failure = value
end

#success=(value) (writeonly)

This method returns an undefined value.

Set a list of operations to process if all compare tests evaluate to true

Parameters:

  • value (Array<Etcdserverpb::RangeRequest, Etcdserverpb::DeleteRangeRequest, Etcdserverpb::PutRequest>) 


19
20
21
 
# File 'lib/xfers/etcd/transaction.rb', line 19

def success=(value)
  @success = value
end

Instance Method Details

#create_revision(key, compare_type, value) ⇒ Etcdserverpb::Compare

Compare operation in transaction, compare the last creation revision of key

Parameters:

  • key (String) —

    the key to be compared

  • compare_type (Symbol) —

    the compare type, possible values: :equal, :greater, :less, :not_equal

  • value (Integer) —

    the revision of the last creation on the key

Returns:

  • (Etcdserverpb::Compare) 


81
 
# File 'lib/xfers/etcd/transaction.rb', line 81

def create_revision(key, compare_type, value); end

#del(key, range_end = "") ⇒ Etcdserverpb::DeleteRangeRequest

Delete operation in transaction

Parameters:

  • key (String) —

    key to set

Returns:

  • (Etcdserverpb::DeleteRangeRequest) 


49
 
# File 'lib/xfers/etcd/transaction.rb', line 49

def del(key, range_end = ""); end

#get(key, opts = {}) ⇒ Etcdserverpb::RangeRequest

Get operation in transaction

Parameters:

  • key (String) —

    the key or the first key in range

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :range_end (String) —

    the last key in range, exclusive

  • :sort_target (Symbol) —

    the sort target, possible values: :key, :version, :create, :mode, :value

  • :sort_order (Symbol) —

    the sort order, possible values: :none, :ascend, :descend

Returns:

  • (Etcdserverpb::RangeRequest) 


43
 
# File 'lib/xfers/etcd/transaction.rb', line 43

def get(key, opts = {}); end

#mod_revision(key, compare_type, value) ⇒ Etcdserverpb::Compare

Compare operation in transaction, compare the last modification revision of key

Parameters:

  • key (String) —

    the key to be compared

  • compare_type (Symbol) —

    the compare type, possible values: :equal, :greater, :less, :not_equal

  • value (Integer) —

    the revision of the last modification on the key

Returns:

  • (Etcdserverpb::Compare) 


73
 
# File 'lib/xfers/etcd/transaction.rb', line 73

def mod_revision(key, compare_type, value); end

#put(key, value, lease_id = nil) ⇒ Etcdserverpb::PutRequest

Put operation in transaction

Parameters:

  • key (String) —

    key name

  • value (String) —

    the value of key

  • lease_id (Integer) (defaults to: nil) —

    the lease id, can use Client#lease_grant method to grant a lease ID

Returns:

  • (Etcdserverpb::PutRequest) 


33
 
# File 'lib/xfers/etcd/transaction.rb', line 33

def put(key, value, lease_id = nil); end

#value(key, compare_type, value) ⇒ Etcdserverpb::Compare

Compare operation in transaction, compare the value of key

Parameters:

  • key (String) —

    the key to be compared

  • compare_type (Symbol) —

    the compare type, possible values: :equal, :greater, :less, :not_equal

  • value (String) —

    the value of key, compare by alphabetical order

Returns:

  • (Etcdserverpb::Compare) 


65
 
# File 'lib/xfers/etcd/transaction.rb', line 65

def value(key, compare_type, value); end

#version(key, compare_type, value) ⇒ Etcdserverpb::Compare

Compare operation in transaction, compare the version of key

Parameters:

  • key (String) —

    the key to compare

  • compare_type (Symbol) —

    the compare type, possible values: :equal, :greater, :less, :not_equal

  • value (Integer) —

    the key's version

Returns:

  • (Etcdserverpb::Compare) 


57
 
# File 'lib/xfers/etcd/transaction.rb', line 57

def version(key, compare_type, value); end