Class: Couchbase::Cluster::SearchQuery

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/search_options.rb

Defined Under Namespace

Classes: BooleanFieldQuery, BooleanQuery, ConjunctionQuery, Coordinate, DateRangeQuery, DisjunctionQuery, DocIdQuery, GeoBoundingBoxQuery, GeoDistanceQuery, GeoPolygonQuery, MatchAllQuery, MatchNoneQuery, MatchPhraseQuery, MatchQuery, NumericRangeQuery, PhraseQuery, PrefixQuery, QueryStringQuery, RegexpQuery, TermQuery, TermRangeQuery, WildcardQuery

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.boolean_field(value) {|query| ... } ⇒ BooleanFieldQuery

Prepare BooleanFieldQuery body

Parameters:

  • value (Boolean)

Yield Parameters:

Returns:



262
263
264
 
# File 'lib/couchbase/search_options.rb', line 262

def self.boolean_field(value)
  BooleanFieldQuery.new(value)
end

.booleans {|query| ... } ⇒ BooleanQuery

Prepare BooleanQuery body

Yield Parameters:

Returns:



760
761
762
 
# File 'lib/couchbase/search_options.rb', line 760

def self.booleans(&block)
  BooleanQuery.new(&block)
end

.conjuncts {|query| ... } ⇒ ConjunctionQuery

Prepare ConjunctionQuery body

Yield Parameters:

Returns:



668
669
670
 
# File 'lib/couchbase/search_options.rb', line 668

def self.conjuncts(...)
  ConjunctionQuery.new(...)
end

.date_range {|query| ... } ⇒ DateRangeQuery

Prepare DateRangeQuery body

Yield Parameters:

Returns:



297
298
299
 
# File 'lib/couchbase/search_options.rb', line 297

def self.date_range(&block)
  DateRangeQuery.new(&block)
end

.disjuncts {|query| ... } ⇒ DisjunctionQuery

Prepare ConjunctionQuery body

Yield Parameters:

Returns:



710
711
712
 
# File 'lib/couchbase/search_options.rb', line 710

def self.disjuncts(...)
  DisjunctionQuery.new(...)
end

.doc_id(*doc_ids) {|query| ... } ⇒ DocIdQuery

Prepare DocIdQuery body

Parameters:

  • doc_ids (String...)

Yield Parameters:

Returns:



230
231
232
 
# File 'lib/couchbase/search_options.rb', line 230

def self.doc_id(*doc_ids)
  DocIdQuery.new(*doc_ids)
end

.geo_bounding_box(top_left_longitude, top_left_latitude, bottom_right_longitude, bottom_right_latitude) {|query| ... } ⇒ GeoBoundingBoxQuery

Prepare GeoBoundingBoxQuery body

Parameters:

  • top_left_longitude (Float)
  • top_left_latitude (Float)
  • bottom_right_longitude (Float)
  • bottom_right_latitude (Float)

Yield Parameters:

Returns:



566
567
568
 
# File 'lib/couchbase/search_options.rb', line 566

def self.geo_bounding_box(top_left_longitude, top_left_latitude, bottom_right_longitude, bottom_right_latitude, &block)
  GeoBoundingBoxQuery.new(top_left_longitude, top_left_latitude, bottom_right_longitude, bottom_right_latitude, &block)
end

.geo_distance(longitude, latitude, distance) {|query| ... } ⇒ GeoDistanceQuery

Prepare GeoDistanceQuery body

Parameters:

  • latitude (Float) —

    location latitude

  • longitude (Float) —

    location longitude

  • distance (String) —

    how big is area (number with units)

Yield Parameters:

Returns:



520
521
522
 
# File 'lib/couchbase/search_options.rb', line 520

def self.geo_distance(longitude, latitude, distance, &block)
  GeoDistanceQuery.new(longitude, latitude, distance, &block)
end

.geo_polygon(coordinates) {|query| ... } ⇒ GeoPolygonQuery

Prepare GeoPolygonQuery body

Parameters:

  • coordinates (Array<Coordinate>) —

    list of coordinates that forms polygon

Yield Parameters:

Returns:



631
632
633
 
# File 'lib/couchbase/search_options.rb', line 631

def self.geo_polygon(coordinates, &block)
  GeoPolygonQuery.new(coordinates, &block)
end

.match(match) {|query| ... } ⇒ MatchQuery

Prepare MatchQuery body

Parameters:

  • match (String)

Yield Parameters:

Returns:



24
25
26
 
# File 'lib/couchbase/search_options.rb', line 24

def self.match(match, &block)
  MatchQuery.new(match, &block)
end

.match_all {|query| ... } ⇒ MatchAllQuery

Prepare MatchAllQuery body

Yield Parameters:

Returns:



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

def self.match_all(&block)
  MatchAllQuery.new(&block)
end

.match_none {|query| ... } ⇒ MatchNoneQuery

Prepare MatchNoneQuery body

Yield Parameters:

Returns:



967
968
969
 
# File 'lib/couchbase/search_options.rb', line 967

def self.match_none(&block)
  MatchNoneQuery.new(&block)
end

.match_phrase(match_phrase) {|query| ... } ⇒ MatchPhraseQuery

Prepare MatchPhraseQuery body

Parameters:

  • match_phrase (String)

Yield Parameters:

Returns:



85
86
87
 
# File 'lib/couchbase/search_options.rb', line 85

def self.match_phrase(match_phrase, &block)
  MatchPhraseQuery.new(match_phrase, &block)
end

.numeric_range {|query| ... } ⇒ NumericRangeQuery

Prepare NumericRangeQuery body

Yield Parameters:

Returns:



380
381
382
 
# File 'lib/couchbase/search_options.rb', line 380

def self.numeric_range(&block)
  NumericRangeQuery.new(&block)
end

.phrase ⇒ PhraseQuery

Prepare PhraseQuery body

Creates a new instances PhraseQuery passing all parameters into Couchbase::Cluster::SearchQuery::PhraseQuery#initialize.

Returns:



908
909
910
 
# File 'lib/couchbase/search_options.rb', line 908

def self.phrase(...)
  PhraseQuery.new(...)
end

.prefix(prefix) {|query| ... } ⇒ PrefixQuery

Prepare PrefixQuery body

Parameters:

  • prefix (String)

Yield Parameters:

Returns:



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

def self.prefix(prefix, &block)
  PrefixQuery.new(prefix, &block)
end

.query_string(query_string) {|query| ... } ⇒ QueryStringQuery

Prepare QueryStringQuery body

Parameters:

  • query_string (String)

Yield Parameters:

Returns:



162
163
164
 
# File 'lib/couchbase/search_options.rb', line 162

def self.query_string(query_string, &block)
  QueryStringQuery.new(query_string, &block)
end

.regexp(regexp) {|query| ... } ⇒ RegexpQuery

Prepare RegexpQuery body

Parameters:

  • regexp (String)

Yield Parameters:

Returns:



126
127
128
 
# File 'lib/couchbase/search_options.rb', line 126

def self.regexp(regexp, &block)
  RegexpQuery.new(regexp, &block)
end

.term(term) {|query| ... } ⇒ TermQuery

Prepare TermQuery body

Parameters:

  • term (String)

Yield Parameters:

Returns:



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

def self.term(term, &block)
  TermQuery.new(term, &block)
end

.term_range {|query| ... } ⇒ TermRangeQuery

Prepare TermRangeQuery body

Yield Parameters:

Returns:



448
449
450
 
# File 'lib/couchbase/search_options.rb', line 448

def self.term_range(&block)
  TermRangeQuery.new(&block)
end

.wildcard(wildcard) {|query| ... } ⇒ WildcardQuery

Prepare WildcardQuery body

Parameters:

  • wildcard (String)

Yield Parameters:

Returns:



194
195
196
 
# File 'lib/couchbase/search_options.rb', line 194

def self.wildcard(wildcard, &block)
  WildcardQuery.new(wildcard, &block)
end

Instance Method Details

#to_h ⇒ Hash<Symbol, #to_json>

Returns:



29
30
31
 
# File 'lib/couchbase/search_options.rb', line 29

def to_h
  {}
end

#to_json(*args) ⇒ String

Returns:

  • (String) 


34
35
36
 
# File 'lib/couchbase/search_options.rb', line 34

def to_json(*args)
  to_h.to_json(*args)
end