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, geo_polygon, 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:



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

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

Instance Attribute Details

#boostFloat

Returns:

  • (Float)


822
823
824
# File 'lib/couchbase/search_options.rb', line 822

def boost
  @boost
end

#fieldString

Returns:

  • (String)


825
826
827
# File 'lib/couchbase/search_options.rb', line 825

def field
  @field
end

#fuzzinessInteger

Returns:

  • (Integer)


828
829
830
# File 'lib/couchbase/search_options.rb', line 828

def fuzziness
  @fuzziness
end

#prefix_lengthInteger

Returns:

  • (Integer)


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

def prefix_length
  @prefix_length
end

Instance Method Details

#to_json(*args) ⇒ String

Returns:

  • (String)


843
844
845
846
847
848
849
850
851
852
# File 'lib/couchbase/search_options.rb', line 843

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