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

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

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:

[View source]

947
948
949
950
951
 
# File 'lib/couchbase/search_options.rb', line 947

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

Instance Attribute Details

#boost ⇒ Float

Returns:

  • (Float) 

936
937
938
 
# File 'lib/couchbase/search_options.rb', line 936

def boost
  @boost
end

#field ⇒ String

Returns:

  • (String) 

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

def field
  @field
end

#operator ⇒ nil, ...

Returns:

  • (nil, :or, :and) 

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

def operator
  @operator
end

Instance Method Details

#to_json(*args) ⇒ String

Returns:

  • (String)
[View source]

954
955
956
957
958
959
960
 
# File 'lib/couchbase/search_options.rb', line 954

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