Class: Couchbase::SearchQuery::GeoDistanceQuery

Inherits:

Couchbase::SearchQuery

• Object
• Couchbase::SearchQuery
• Couchbase::SearchQuery::GeoDistanceQuery

Defined in:

lib/couchbase/search_options.rb,
/code/couchbase-ruby-client/lib/couchbase/search_options.rb

Overview

Finds ‘geopoint` indexed matches around a point with the given distance.

Instance Attribute Summary

• #boost ⇒ Float
• #field ⇒ String

Instance Method Summary

• #initialize(longitude, latitude, distance) {|self| ... } ⇒ GeoDistanceQuery constructor

  A new instance of GeoDistanceQuery.

• #to_h ⇒ Hash<Symbol, #to_json>

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(longitude, latitude, distance) {|self| ... } ⇒ GeoDistanceQuery

Returns a new instance of GeoDistanceQuery.

Parameters:

• longitude (Float)
• latitude (Float)
• distance (Float)

Yield Parameters:

• self (GeoDistanceQuery)

# File 'lib/couchbase/search_options.rb', line 598

def initialize(longitude, latitude, distance)
  super()
  @longitude = longitude
  @latitude = latitude
  @distance = distance
  yield self if block_given?
end

Instance Attribute Details

#boost ⇒ Float

Returns:

• (Float)

# File 'lib/couchbase/search_options.rb', line 589

def boost
  @boost
end

#field ⇒ String

Returns:

• (String)

# File 'lib/couchbase/search_options.rb', line 592

def field
  @field
end

Instance Method Details

#to_h ⇒ Hash<Symbol, #to_json>

Returns:

• (Hash<Symbol, #to_json>)

# File 'lib/couchbase/search_options.rb', line 607

def to_h
  data = {
    :location => [@longitude, @latitude],
    :distance => @distance,
  }
  data[:boost] = boost if boost
  data[:field] = field if field
  data
end