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

Inherits:
Couchbase::Cluster::SearchQuery show all
Defined in:
lib/couchbase/search_options.rb

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, match, match_all, match_none, match_phrase, numeric_range, phrase, prefix, query_string, regexp, term, term_range, wildcard

Constructor Details

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

Returns a new instance of TermQuery.

Parameters:

  • term (String)

Yield Parameters:

[View source]

778
779
780
781
782
 
# File 'lib/couchbase/search_options.rb', line 778

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

Instance Attribute Details

#boost ⇒ Float

Returns:

  • (Float) 

764
765
766
 
# File 'lib/couchbase/search_options.rb', line 764

def boost
  @boost
end

#field ⇒ String

Returns:

  • (String) 

767
768
769
 
# File 'lib/couchbase/search_options.rb', line 767

def field
  @field
end

#fuzziness ⇒ Integer

Returns:

  • (Integer) 

770
771
772
 
# File 'lib/couchbase/search_options.rb', line 770

def fuzziness
  @fuzziness
end

#prefix_length ⇒ Integer

Returns:

  • (Integer) 

773
774
775
 
# File 'lib/couchbase/search_options.rb', line 773

def prefix_length
  @prefix_length
end

Instance Method Details

#to_json(*args) ⇒ String

Returns:

  • (String)
[View source]

785
786
787
788
789
790
791
792
793
794
 
# File 'lib/couchbase/search_options.rb', line 785

def to_json(*args)
  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.to_json(*args)
end