Class: Couchbase::Cluster::SearchQuery::TermQuery

Inherits:
Couchbase::Cluster::SearchQuery show all
Defined in:
lib/couchbase/search_options.rb,
/Users/sergey.auseyau/code/couchbase-ruby-client/lib/couchbase/search_options.rb more...

Overview

A query that looks for exact matches of the term in the index (no analyzer, no stemming). Useful to check what the actual content of the index is. It can also apply fuzziness on the term. Usual better alternative is ‘MatchQuery`.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Couchbase::Cluster::SearchQuery

boolean_field, booleans, conjuncts, date_range, disjuncts, doc_id, geo_bounding_box, geo_distance, geo_polygon, match, match_all, match_none, match_phrase, numeric_range, phrase, prefix, query_string, regexp, term, term_range, #to_json, wildcard

Constructor Details

#initialize(term) {|self| ... } ⇒ TermQuery

Returns a new instance of TermQuery.

Parameters:

  • term (String)

Yield Parameters:

[View source]

845
846
847
848
849
 
# File 'lib/couchbase/search_options.rb', line 845

def initialize(term)
  super()
  @term = term
  yield self if block_given?
end

Instance Attribute Details

#boost ⇒ Float

Returns:

  • (Float) 

831
832
833
 
# File 'lib/couchbase/search_options.rb', line 831

def boost
  @boost
end

#field ⇒ String

Returns:

  • (String) 

834
835
836
 
# File 'lib/couchbase/search_options.rb', line 834

def field
  @field
end

#fuzziness ⇒ Integer

Returns:

  • (Integer) 

837
838
839
 
# File 'lib/couchbase/search_options.rb', line 837

def fuzziness
  @fuzziness
end

#prefix_length ⇒ Integer

Returns:

  • (Integer) 

840
841
842
 
# File 'lib/couchbase/search_options.rb', line 840

def prefix_length
  @prefix_length
end

Instance Method Details

#to_h ⇒ Hash<Symbol, #to_json>

Returns:

[View source]

852
853
854
855
856
857
858
859
860
861
 
# File 'lib/couchbase/search_options.rb', line 852

def to_h
  data = {:term => @term}
  data[:boost] = boost if boost
  data[:field] = field if field
  if fuzziness
    data[:fuzziness] = fuzziness
    data[:prefix_length] = prefix_length if prefix_length
  end
  data
end