Class: Couchbase::Options::View

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

Overview

Options for Cluster#view_query

Instance Attribute Summary collapse

Attributes inherited from Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Constructor Details

#initialize(scan_consistency: :not_bounded, namespace: :production, skip: nil, limit: nil, start_key: nil, end_key: nil, start_key_doc_id: nil, end_key_doc_id: nil, inclusive_end: nil, group: nil, group_level: nil, key: nil, keys: nil, order: nil, reduce: nil, on_error: nil, debug: false, timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|self| ... } ⇒ View

Returns a new instance of View.

Parameters:

  • scan_consistency (:not_bounded, :request_plus, :update_after) (defaults to: :not_bounded) —

    Specifies the level of consistency for the query

  • namespace (:production, :development) (defaults to: :production)
  • skip (Integer, nil) (defaults to: nil) —

    Specifies the number of results to skip from the start of the result set

  • limit (Integer, nil) (defaults to: nil) —

    Specifies the maximum number of results to return

  • start_key (#to_json, nil) (defaults to: nil) —

    Specifies the key, to which the engine has to skip before result generation

  • end_key (#to_json, nil) (defaults to: nil) —

    Specifies the key, at which the result generation has to be stopped

  • start_key_doc_id (String, nil) (defaults to: nil) —

    Specifies the document id in case #start_key gives multiple results within the index

  • end_key_doc_id (String, nil) (defaults to: nil) —

    Specifies the document id in case #end_key gives multiple results within the index

  • inclusive_end (Boolean, nil) (defaults to: nil) —

    Specifies whether the #end_key/##end_key_doc_id values should be inclusive

  • group (Boolean, nil) (defaults to: nil) —

    Specifies whether to enable grouping of the results

  • group_level (Integer, nil) (defaults to: nil) —

    Specifies the depth within the key to group the results

  • key (#to_json, nil) (defaults to: nil) —

    Specifies the key to fetch from the index

  • keys (Array<#to_json>, nil) (defaults to: nil) —

    Specifies set of the keys to fetch from the index

  • order (:ascending, :descending, nil) (defaults to: nil) —

    Specifies the order of the results that should be returned

  • reduce (Boolean, nil) (defaults to: nil) —

    Specifies whether to enable the reduction function associated with this particular view index

  • on_error (:stop, :continue, nil) (defaults to: nil) —

    Specifies the behaviour of the view engine should an error occur during the gathering of view index results which would result in only partial results being available

  • debug (Boolean, nil) (defaults to: false) —

    allows to return debug information as part of the view response

  • timeout (Integer, #in_milliseconds, nil) (defaults to: nil)
  • retry_strategy (Proc, nil) (defaults to: nil) —

    the custom retry strategy, if set

  • client_context (Hash, nil) (defaults to: nil) —

    the client context data, if set

  • parent_span (Span, nil) (defaults to: nil) —

    if set holds the parent span, that should be used for this request

Yield Parameters:

[View source]

2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
 
# File 'lib/couchbase/options.rb', line 2163

def initialize(scan_consistency: :not_bounded,
               namespace: :production,
               skip: nil,
               limit: nil,
               start_key: nil,
               end_key: nil,
               start_key_doc_id: nil,
               end_key_doc_id: nil,
               inclusive_end: nil,
               group: nil,
               group_level: nil,
               key: nil,
               keys: nil,
               order: nil,
               reduce: nil,
               on_error: nil,
               debug: false,
               timeout: nil,
               retry_strategy: nil,
               client_context: nil,
               parent_span: nil)
  super(timeout: timeout, retry_strategy: retry_strategy, client_context: client_context, parent_span: parent_span)

  @scan_consistency = scan_consistency
  @namespace = namespace
  @skip = skip
  @limit = limit
  @start_key = start_key
  @end_key = end_key
  @start_key_doc_id = start_key_doc_id
  @end_key_doc_id = end_key_doc_id
  @inclusive_end = inclusive_end
  @group = group
  @group_level = group_level
  @key = key
  @keys = keys
  @order = order
  @reduce = reduce
  @on_error = on_error
  @debug = debug
  yield self if block_given?
end

Instance Attribute Details

#debug ⇒ Boolean?

Returns:

  • (Boolean, nil) 

2135
2136
2137
 
# File 'lib/couchbase/options.rb', line 2135

def debug
  @debug
end

#end_key ⇒ #to_json?

Returns:

  • (#to_json, nil) 

2124
2125
2126
 
# File 'lib/couchbase/options.rb', line 2124

def end_key
  @end_key
end

#end_key_doc_id ⇒ String?

Returns:

  • (String, nil) 

2126
2127
2128
 
# File 'lib/couchbase/options.rb', line 2126

def end_key_doc_id
  @end_key_doc_id
end

#group ⇒ Boolean?

Returns:

  • (Boolean, nil) 

2128
2129
2130
 
# File 'lib/couchbase/options.rb', line 2128

def group
  @group
end

#group_level ⇒ Integer?

Returns:

  • (Integer, nil) 

2129
2130
2131
 
# File 'lib/couchbase/options.rb', line 2129

def group_level
  @group_level
end

#inclusive_end ⇒ Boolean?

Returns:

  • (Boolean, nil) 

2127
2128
2129
 
# File 'lib/couchbase/options.rb', line 2127

def inclusive_end
  @inclusive_end
end

#key ⇒ #to_json?

Returns:

  • (#to_json, nil) 

2130
2131
2132
 
# File 'lib/couchbase/options.rb', line 2130

def key
  @key
end

#keys ⇒ Array<#to_json>?

Returns:

  • (Array<#to_json>, nil) 

2131
2132
2133
 
# File 'lib/couchbase/options.rb', line 2131

def keys
  @keys
end

#limit ⇒ Integer

Returns:

  • (Integer) 

2122
2123
2124
 
# File 'lib/couchbase/options.rb', line 2122

def limit
  @limit
end

#namespace ⇒ Symbol

Returns:

  • (Symbol) 

2120
2121
2122
 
# File 'lib/couchbase/options.rb', line 2120

def namespace
  @namespace
end

#on_error ⇒ Symbol?

Returns:

  • (Symbol, nil) 

2134
2135
2136
 
# File 'lib/couchbase/options.rb', line 2134

def on_error
  @on_error
end

#order ⇒ Symbol?

Returns:

  • (Symbol, nil) 

2132
2133
2134
 
# File 'lib/couchbase/options.rb', line 2132

def order
  @order
end

#reduce ⇒ Boolean?

Returns:

  • (Boolean, nil) 

2133
2134
2135
 
# File 'lib/couchbase/options.rb', line 2133

def reduce
  @reduce
end

#scan_consistency ⇒ Symbol

Returns:

  • (Symbol) 

2119
2120
2121
 
# File 'lib/couchbase/options.rb', line 2119

def scan_consistency
  @scan_consistency
end

#skip ⇒ Integer

Returns:

  • (Integer) 

2121
2122
2123
 
# File 'lib/couchbase/options.rb', line 2121

def skip
  @skip
end

#start_key ⇒ #to_json?

Returns:

  • (#to_json, nil) 

2123
2124
2125
 
# File 'lib/couchbase/options.rb', line 2123

def start_key
  @start_key
end

#start_key_doc_id ⇒ String?

Returns:

  • (String, nil) 

2125
2126
2127
 
# File 'lib/couchbase/options.rb', line 2125

def start_key_doc_id
  @start_key_doc_id
end

Instance Method Details

#raw(key, value) ⇒ Object

Allows providing custom JSON key/value pairs for advanced usage

Parameters:

  • key (String) —

    the parameter name (key of the JSON property)

  • value (Object) —

    the parameter value (value of the JSON property)

[View source]

2210
2211
2212
 
# File 'lib/couchbase/options.rb', line 2210

def raw(key, value)
  @raw_parameters[key] = JSON.generate(value)
end