Class: Couchbase::ScanTerm

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/key_value_scan.rb

Overview

A scan term used to specify the bounds of a range scan

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(term, exclusive: false) ⇒ ScanTerm

Creates an instance of a ScanTerm

Parameters:

  • term (String) —

    the key pattern of this term

  • exclusive (Boolean) (defaults to: false) —

    specifies if this term is excluded while scanning, the bounds are included by default



27
28
29
30
 
# File 'lib/couchbase/key_value_scan.rb', line 27

def initialize(term, exclusive: false)
  @term = term
  @exclusive = exclusive
end

Instance Attribute Details

#exclusive ⇒ Boolean

Returns:

  • (Boolean) 


21
22
23
 
# File 'lib/couchbase/key_value_scan.rb', line 21

def exclusive
  @exclusive
end

#term ⇒ ScanTerm

Returns:



20
21
22
 
# File 'lib/couchbase/key_value_scan.rb', line 20

def term
  @term
end

Instance Method Details

#to_backend ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



33
34
35
36
37
38
 
# File 'lib/couchbase/key_value_scan.rb', line 33

def to_backend
  {
    term: @term,
    exclusive: @exclusive,
  }
end