Class: Couchbase::SearchQuery::PrefixQuery

Inherits:
Couchbase::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::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(prefix) {|self| ... } ⇒ PrefixQuery

Returns a new instance of PrefixQuery.

Parameters:

  • prefix (String)

Yield Parameters:



951
952
953
954
955
 
# File 'lib/couchbase/search_options.rb', line 951

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

Instance Attribute Details

#boost ⇒ Float

Returns:

  • (Float) 


940
941
942
 
# File 'lib/couchbase/search_options.rb', line 940

def boost
  @boost
end

#field ⇒ String

Returns:

  • (String) 


946
947
948
 
# File 'lib/couchbase/search_options.rb', line 946

def field
  @field
end

#operator ⇒ nil, ...

Returns:

  • (nil, :or, :and) 


943
944
945
 
# File 'lib/couchbase/search_options.rb', line 943

def operator
  @operator
end

Instance Method Details

#to_h ⇒ Hash<Symbol, #to_json>

Returns:



958
959
960
961
962
963
 
# File 'lib/couchbase/search_options.rb', line 958

def to_h
  data = {:prefix => @prefix}
  data[:boost] = boost if boost
  data[:field] = field if field
  data
end