Class: Couchbase::LookupInSpec

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/subdoc.rb,
/Users/sergey.auseyau/code/couchbase-ruby-client/lib/couchbase/subdoc.rb more...

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#path ⇒ Object (readonly)

Returns the value of attribute path.


59
60
61
 
# File 'lib/couchbase/subdoc.rb', line 59

def path
  @path
end

#type ⇒ Object (readonly)

Returns the value of attribute type.


58
59
60
 
# File 'lib/couchbase/subdoc.rb', line 58

def type
  @type
end

Class Method Details

.count(path) ⇒ LookupInSpec

Counts the number of values at a given path in the document

Parameters:

  • path (String) —

    the path identifying where to count the values

Returns:

[View source]

45
46
47
 
# File 'lib/couchbase/subdoc.rb', line 45

def self.count(path)
  new(:count, path)
end

.exists(path) ⇒ LookupInSpec

Checks if a value at the given path exists in the document

Parameters:

  • path (String) —

    the path to check if the field exists

Returns:

[View source]

37
38
39
 
# File 'lib/couchbase/subdoc.rb', line 37

def self.exists(path)
  new(:exists, path)
end

.get(path) ⇒ LookupInSpec

Fetches the content from a field (if present) at the given path

Parameters:

  • path (String, Symbol) —

    the path identifying where to get the value. When path is a symbol, the library will try to expand it as macro.

Returns:

[View source]

22
23
24
25
26
27
28
29
30
31
 
# File 'lib/couchbase/subdoc.rb', line 22

def self.get(path)
  case path
  when Symbol
    new(:get, expand_macro(path))
  when ""
    new(:get_doc, "")
  else
    new(:get, path)
  end
end

Instance Method Details

#xattr ⇒ Object

[View source]

49
50
51
52
 
# File 'lib/couchbase/subdoc.rb', line 49

def xattr
  @xattr = true
  self
end

#xattr? ⇒ Boolean

Returns:

  • (Boolean)
[View source]

54
55
56
 
# File 'lib/couchbase/subdoc.rb', line 54

def xattr?
  @xattr
end