Class: Couchbase::Cluster::SearchQuery::PrefixQuery

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

Overview

The prefix query finds documents containing terms that start with the provided prefix. 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(prefix) {|self| ... } ⇒ PrefixQuery

Returns a new instance of PrefixQuery.

Parameters:

  • prefix (String)

Yield Parameters:



876
877
878
879
880
 
# File 'lib/couchbase/search_options.rb', line 876

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

Instance Attribute Details

#boost ⇒ Float

Returns:

  • (Float) 


868
869
870
 
# File 'lib/couchbase/search_options.rb', line 868

def boost
  @boost
end

#field ⇒ String

Returns:

  • (String) 


871
872
873
 
# File 'lib/couchbase/search_options.rb', line 871

def field
  @field
end

Instance Method Details

#to_json(*args) ⇒ String

Returns:

  • (String) 


883
884
885
886
887
888
 
# File 'lib/couchbase/search_options.rb', line 883

def to_json(*args)
  data = {"prefix" => @prefix}
  data["boost"] = boost if boost
  data["field"] = field if field
  data.to_json(*args)
end