Class: Couchbase::Cluster::SearchQuery

Inherits:
Object
  • Object
show all
Defined in:
lib/couchbase/search_options.rb,
/Users/sergey.auseyau/code/couchbase-ruby-client/lib/couchbase/search_options.rb more...

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

Class Method Details

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

Prepare BooleanFieldQuery body

Parameters:

  • value (Boolean)

Yield Parameters:

Returns:

[View source]

276
277
278
 
# File 'lib/couchbase/search_options.rb', line 276

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

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

Prepare BooleanQuery body

Yield Parameters:

Returns:

[View source]

810
811
812
 
# File 'lib/couchbase/search_options.rb', line 810

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

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

Prepare ConjunctionQuery body

Yield Parameters:

Returns:

[View source]

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

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

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

Prepare DateRangeQuery body

Yield Parameters:

Returns:

[View source]

315
316
317
 
# File 'lib/couchbase/search_options.rb', line 315

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

.disjuncts {|query| ... } ⇒ ConjunctionQuery

Prepare ConjunctionQuery body

Yield Parameters:

Returns:

[View source]

756
757
758
 
# File 'lib/couchbase/search_options.rb', line 756

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

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

Prepare DocIdQuery body

Parameters:

  • doc_ids (String...)

Yield Parameters:

Returns:

[View source]

236
237
238
 
# File 'lib/couchbase/search_options.rb', line 236

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:

[View source]

600
601
602
 
# File 'lib/couchbase/search_options.rb', line 600

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:

[View source]

550
551
552
 
# File 'lib/couchbase/search_options.rb', line 550

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:

[View source]

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

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

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

Prepare MatchQuery body

Parameters:

  • match (String)

Yield Parameters:

Returns:

[View source]

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:

[View source]

1008
1009
1010
 
# File 'lib/couchbase/search_options.rb', line 1008

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

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

Prepare MatchNoneQuery body

Yield Parameters:

Returns:

[View source]

1040
1041
1042
 
# File 'lib/couchbase/search_options.rb', line 1040

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:

[View source]

76
77
78
 
# File 'lib/couchbase/search_options.rb', line 76

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

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

Prepare NumericRangeQuery body

Yield Parameters:

Returns:

[View source]

402
403
404
 
# File 'lib/couchbase/search_options.rb', line 402

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:

[View source]

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

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

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

Prepare PrefixQuery body

Parameters:

  • prefix (String)

Yield Parameters:

Returns:

[View source]

929
930
931
 
# File 'lib/couchbase/search_options.rb', line 929

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:

[View source]

160
161
162
 
# File 'lib/couchbase/search_options.rb', line 160

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:

[View source]

120
121
122
 
# File 'lib/couchbase/search_options.rb', line 120

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

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

Prepare TermQuery body

Parameters:

  • term (String)

Yield Parameters:

Returns:

[View source]

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

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

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

Prepare TermRangeQuery body

Yield Parameters:

Returns:

[View source]

474
475
476
 
# File 'lib/couchbase/search_options.rb', line 474

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

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

Prepare WildcardQuery body

Parameters:

  • wildcard (String)

Yield Parameters:

Returns:

[View source]

196
197
198
 
# File 'lib/couchbase/search_options.rb', line 196

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