Class: Couchbase::Options::Search

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

Overview

Options for Cluster#search_query and Cluster#search

Constant Summary collapse

DEFAULT =

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

Search.new.freeze

Instance Attribute Summary collapse

Attributes inherited from Base

#client_context, #parent_span, #retry_strategy, #timeout

Instance Method Summary collapse

Constructor Details

#initialize(limit: nil, skip: nil, explain: false, highlight_style: nil, highlight_fields: nil, fields: nil, mutation_state: nil, disable_scoring: false, include_locations: false, collections: nil, sort: nil, facets: nil, transcoder: JsonTranscoder.new, timeout: nil, retry_strategy: nil, client_context: nil, parent_span: nil) {|self| ... } ⇒ Search

Returns a new instance of Search.

Parameters:

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

    limits the number of matches returned from the complete result set.

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

    indicates how many matches are skipped on the result set before starting to return the matches

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

    triggers inclusion of additional search result score explanations.

  • highlight_style (:html, :ansi, nil) (defaults to: nil) —

    the style of highlighting in the result excerpts (if not specified, the server default will be used)

  • highlight_fields (Array<String>) (defaults to: nil) —

    list of the fields to highlight

  • fields (Array<String>) (defaults to: nil) —

    list of field values which should be retrieved for result documents, provided they were stored while indexing

  • mutation_state (MutationState) (defaults to: nil) —

    the mutation tokens this query should be consistent with

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

    If set to true, the server will not perform any scoring on the hits

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

    UNCOMMITTED: If set to true, will include the vector of search_location in rows

  • collections (Array<String>, nil) (defaults to: nil) —

    list of collections by which to filter the results

  • sort (Array<String, Cluster::SearchSort>) (defaults to: nil) —

    Ordering rules to apply to the results. The list might contain either strings or special objects, that derive from Cluster::SearchSort. In case of String, the value represents the name of the field with optional - in front of the name, which will turn on descending mode for this field. One field is special is “_score” which will sort results by their score. When nothing specified, the Server will order results by their score descending, which is equivalent of “-_score”.

  • facets (Hash<String => Cluster::SearchFacet>) (defaults to: nil) —

    facets allow to aggregate information collected on a particular result set

  • transcoder (JsonTranscoder, #decode(String)) (defaults to: JsonTranscoder.new) —

    to use for the results

  • 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:



2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
 
# File 'lib/couchbase/options.rb', line 2262

def initialize(limit: nil,
               skip: nil,
               explain: false,
               highlight_style: nil,
               highlight_fields: nil,
               fields: nil,
               mutation_state: nil,
               disable_scoring: false,
               include_locations: false,
               collections: nil,
               sort: nil,
               facets: nil,
               transcoder: JsonTranscoder.new,
               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)
  @limit = limit
  @skip = skip
  @explain = explain
  @highlight_style = highlight_style
  @highlight_fields = highlight_fields
  @fields = fields
  @disable_scoring = disable_scoring
  @include_locations = include_locations
  @collections = collections
  @sort = sort
  @facets = facets
  @transcoder = transcoder
  @scan_consistency = :not_bounded
  @mutation_state = mutation_state
  yield self if block_given?
end

Instance Attribute Details

#collections ⇒ Array<String>?

Returns:

  • (Array<String>, nil) 


2229
2230
2231
 
# File 'lib/couchbase/options.rb', line 2229

def collections
  @collections
end

#disable_scoring ⇒ Boolean

Returns:

  • (Boolean) 


2227
2228
2229
 
# File 'lib/couchbase/options.rb', line 2227

def disable_scoring
  @disable_scoring
end

#explain ⇒ Boolean

Returns:

  • (Boolean) 


2223
2224
2225
 
# File 'lib/couchbase/options.rb', line 2223

def explain
  @explain
end

#facets ⇒ Hash<String => Cluster::SearchFacet>

Returns:



2231
2232
2233
 
# File 'lib/couchbase/options.rb', line 2231

def facets
  @facets
end

#fields ⇒ Array<String>

Returns:

  • (Array<String>) 


2226
2227
2228
 
# File 'lib/couchbase/options.rb', line 2226

def fields
  @fields
end

#highlight_fields ⇒ Array<String>

Returns:

  • (Array<String>) 


2225
2226
2227
 
# File 'lib/couchbase/options.rb', line 2225

def highlight_fields
  @highlight_fields
end

#highlight_style ⇒ Symbol

Returns:

  • (Symbol) 


2224
2225
2226
 
# File 'lib/couchbase/options.rb', line 2224

def highlight_style
  @highlight_style
end

#include_locations ⇒ Boolean

Returns:

  • (Boolean) 


2228
2229
2230
 
# File 'lib/couchbase/options.rb', line 2228

def include_locations
  @include_locations
end

#limit ⇒ Integer

Returns:

  • (Integer) 


2221
2222
2223
 
# File 'lib/couchbase/options.rb', line 2221

def limit
  @limit
end

#mutation_state ⇒ MutationState (readonly)

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.

Returns:



2324
2325
2326
 
# File 'lib/couchbase/options.rb', line 2324

def mutation_state
  @mutation_state
end

#scan_consistency ⇒ Symbol

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.

Returns:

  • (Symbol) 


2328
2329
2330
 
# File 'lib/couchbase/options.rb', line 2328

def scan_consistency
  @scan_consistency
end

#skip ⇒ Integer

Returns:

  • (Integer) 


2222
2223
2224
 
# File 'lib/couchbase/options.rb', line 2222

def skip
  @skip
end

#sort ⇒ Array<String, Cluster::SearchSort>

Returns:



2230
2231
2232
 
# File 'lib/couchbase/options.rb', line 2230

def sort
  @sort
end

#transcoder ⇒ JsonTranscoder, #decode(String)

Returns:



2232
2233
2234
 
# File 'lib/couchbase/options.rb', line 2232

def transcoder
  @transcoder
end

Instance Method Details

#consistent_with(mutation_state) ⇒ void

Note:

overrides consistency level set by #scan_consistency=

This method returns an undefined value.

Sets the mutation tokens this query should be consistent with

Parameters:

  • mutation_state (MutationState) —

    the mutation state containing the mutation tokens



2304
2305
2306
2307
 
# File 'lib/couchbase/options.rb', line 2304

def consistent_with(mutation_state)
  @scan_consistency = nil if @scan_consistency
  @mutation_state = mutation_state
end

#to_backend(show_request: nil) ⇒ 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. 



2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
 
# File 'lib/couchbase/options.rb', line 2331

def to_backend(show_request: nil)
  {
    timeout: Utils::Time.extract_duration(@timeout),
    limit: @limit,
    skip: @skip,
    explain: @explain,
    disable_scoring: @disable_scoring,
    include_locations: @include_locations,
    collections: @collections,
    highlight_style: @highlight_style,
    highlight_fields: @highlight_fields,
    fields: @fields,
    sort: @sort&.map { |v| JSON.generate(v) },
    facets: @facets&.map { |(k, v)| [k, JSON.generate(v)] },
    scan_consistency: @scan_consistency,
    mutation_state: @mutation_state&.to_a,
    show_request: show_request,
  }
end