Class: Couchbase::Options::Search

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#search_query

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:

[View source]

2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
 
# File 'lib/couchbase/options.rb', line 2108

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) 

2075
2076
2077
 
# File 'lib/couchbase/options.rb', line 2075

def collections
  @collections
end

#disable_scoring ⇒ Boolean

Returns:

  • (Boolean) 

2073
2074
2075
 
# File 'lib/couchbase/options.rb', line 2073

def disable_scoring
  @disable_scoring
end

#explain ⇒ Boolean

Returns:

  • (Boolean) 

2069
2070
2071
 
# File 'lib/couchbase/options.rb', line 2069

def explain
  @explain
end

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

Returns:


2077
2078
2079
 
# File 'lib/couchbase/options.rb', line 2077

def facets
  @facets
end

#fields ⇒ Array<String>

Returns:

  • (Array<String>) 

2072
2073
2074
 
# File 'lib/couchbase/options.rb', line 2072

def fields
  @fields
end

#highlight_fields ⇒ Array<String>

Returns:

  • (Array<String>) 

2071
2072
2073
 
# File 'lib/couchbase/options.rb', line 2071

def highlight_fields
  @highlight_fields
end

#highlight_style ⇒ Symbol

Returns:

  • (Symbol) 

2070
2071
2072
 
# File 'lib/couchbase/options.rb', line 2070

def highlight_style
  @highlight_style
end

#include_locations ⇒ Boolean

Returns:

  • (Boolean) 

2074
2075
2076
 
# File 'lib/couchbase/options.rb', line 2074

def include_locations
  @include_locations
end

#limit ⇒ Integer

Returns:

  • (Integer) 

2067
2068
2069
 
# File 'lib/couchbase/options.rb', line 2067

def limit
  @limit
end

#scan_consistency=(level) ⇒ void

Note:

overrides consistency level set by #consistent_with

This method returns an undefined value.

Customizes the consistency guarantees for this query

Parameters:

  • level (:not_bounded) —

    the scan consistency to be used for this query

    :not_bounded

    The engine will return whatever state it has at the time of query


2163
2164
2165
2166
 
# File 'lib/couchbase/options.rb', line 2163

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

#skip ⇒ Integer

Returns:

  • (Integer) 

2068
2069
2070
 
# File 'lib/couchbase/options.rb', line 2068

def skip
  @skip
end

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

Returns:


2076
2077
2078
 
# File 'lib/couchbase/options.rb', line 2076

def sort
  @sort
end

#transcoder ⇒ JsonTranscoder, #decode(String)

Returns:


2078
2079
2080
 
# File 'lib/couchbase/options.rb', line 2078

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

[View source]

2150
2151
2152
2153
 
# File 'lib/couchbase/options.rb', line 2150

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