module Couchbase::ViewHelpers

Constants

VERSION

Public Instance Methods

asc() click to toggle source
# File lib/couchbase/view_helpers.rb, line 38
def asc
  order('asc')
end
desc() click to toggle source
# File lib/couchbase/view_helpers.rb, line 34
def desc
  order('desc')
end
fresh() click to toggle source
# File lib/couchbase/view_helpers.rb, line 62
def fresh
  stale(false)
end
group(group = true) click to toggle source

Grouping

# File lib/couchbase/view_helpers.rb, line 43
def group(group = true)
  add_param(group: group)
end
group_level(group_level) click to toggle source
# File lib/couchbase/view_helpers.rb, line 47
def group_level(group_level)
  add_param(group_level: group_level)
end
Also aliased as: level
include_docs(docs = true) click to toggle source

Docs

# File lib/couchbase/view_helpers.rb, line 71
def include_docs(docs = true)
  add_param(include_docs: docs)
end
key(key) click to toggle source

Keys

# File lib/couchbase/view_helpers.rb, line 8
def key(key)
  add_param(key: key)
end
keys(*keys) click to toggle source
# File lib/couchbase/view_helpers.rb, line 12
def keys(*keys)
  add_param(keys: Array(keys).flatten)
end
level(group_level)
Alias for: group_level
no_docs() click to toggle source
# File lib/couchbase/view_helpers.rb, line 75
def no_docs
  include_docs(false)
end
order(direction) click to toggle source

Ordering

# File lib/couchbase/view_helpers.rb, line 30
def order(direction)
  add_param(descending: (direction.to_s =~ /^asc/i) != 0)
end
page(page_num) click to toggle source
# File lib/couchbase/view_helpers.rb, line 21
def page(page_num)
  paginate(page: page_num)
end
paginate(params = {}) click to toggle source

Pagination

# File lib/couchbase/view_helpers.rb, line 17
def paginate(params = {})
  add_param(PaginateParams.new(params).to_h)
end
per(per_page) click to toggle source
# File lib/couchbase/view_helpers.rb, line 25
def per(per_page)
  paginate(per_page: per_page)
end
reduce(reduce = true) click to toggle source

Reducing

# File lib/couchbase/view_helpers.rb, line 53
def reduce(reduce = true)
  add_param(reduce: reduce)
end
stale(stale = :ok) click to toggle source

Freshness

# File lib/couchbase/view_helpers.rb, line 58
def stale(stale = :ok)
  add_param(stale: stale)
end
update_after() click to toggle source
# File lib/couchbase/view_helpers.rb, line 66
def update_after
  stale(:update_after)
end

Protected Instance Methods

add_param(param) click to toggle source
# File lib/couchbase/view_helpers.rb, line 81
def add_param(param)
  @params.merge!(param)
  self
end