case class GeoNear(near: P.Value, spherical: Boolean = false, limit: Long = 100, minDistance: Option[Long] = None, maxDistance: Option[Long] = None, query: Option[P.Document] = None, distanceMultiplier: Option[Double] = None, uniqueDocs: Boolean = false, distanceField: Option[String] = None, includeLocs: Option[String] = None) extends PipelineOperator with Product with Serializable

Outputs documents in order of nearest to farthest from a specified point.

http://docs.mongodb.org/manual/reference/operator/aggregation/geoNear/#pipe._S_geoNear

near

the point for which to find the closest documents

spherical

if using a 2dsphere index

limit

the maximum number of documents to return

maxDistance

the maximum distance from the center point that the documents can be

query

limits the results to the matching documents

distanceMultiplier

the factor to multiply all distances returned by the query

uniqueDocs

if this value is true, the query returns a matching document once

distanceField

the output field that contains the calculated distance

includeLocs

this specifies the output field that identifies the location used to calculate the distance

Linear Supertypes
Serializable, Serializable, Product, Equals, AggregationFramework.PipelineOperator, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeoNear
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. PipelineOperator
  7. AnyRef
  8. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new GeoNear(near: P.Value, spherical: Boolean = false, limit: Long = 100, minDistance: Option[Long] = None, maxDistance: Option[Long] = None, query: Option[P.Document] = None, distanceMultiplier: Option[Double] = None, uniqueDocs: Boolean = false, distanceField: Option[String] = None, includeLocs: Option[String] = None)

    near

    the point for which to find the closest documents

    spherical

    if using a 2dsphere index

    limit

    the maximum number of documents to return

    maxDistance

    the maximum distance from the center point that the documents can be

    query

    limits the results to the matching documents

    distanceMultiplier

    the factor to multiply all distances returned by the query

    uniqueDocs

    if this value is true, the query returns a matching document once

    distanceField

    the output field that contains the calculated distance

    includeLocs

    this specifies the output field that identifies the location used to calculate the distance

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from GeoNear to any2stringadd[GeoNear] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (GeoNear, B)
    Implicit
    This member is added by an implicit conversion from GeoNear to ArrowAssoc[GeoNear] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. val distanceField: Option[String]
  9. val distanceMultiplier: Option[Double]
  10. def ensuring(cond: (GeoNear) ⇒ Boolean, msg: ⇒ Any): GeoNear
    Implicit
    This member is added by an implicit conversion from GeoNear to Ensuring[GeoNear] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: (GeoNear) ⇒ Boolean): GeoNear
    Implicit
    This member is added by an implicit conversion from GeoNear to Ensuring[GeoNear] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean, msg: ⇒ Any): GeoNear
    Implicit
    This member is added by an implicit conversion from GeoNear to Ensuring[GeoNear] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean): GeoNear
    Implicit
    This member is added by an implicit conversion from GeoNear to Ensuring[GeoNear] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from GeoNear to StringFormat[GeoNear] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  18. val includeLocs: Option[String]
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. val limit: Long
  21. def makePipe: P.Document
    Definition Classes
    GeoNear → PipelineOperator
  22. val maxDistance: Option[Long]
  23. val minDistance: Option[Long]
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. val near: P.Value
  26. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  27. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  28. val query: Option[P.Document]
  29. val spherical: Boolean
  30. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  31. val uniqueDocs: Boolean
  32. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  35. def →[B](y: B): (GeoNear, B)
    Implicit
    This member is added by an implicit conversion from GeoNear to ArrowAssoc[GeoNear] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AggregationFramework.PipelineOperator

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from GeoNear to any2stringadd[GeoNear]

Inherited by implicit conversion StringFormat from GeoNear to StringFormat[GeoNear]

Inherited by implicit conversion Ensuring from GeoNear to Ensuring[GeoNear]

Inherited by implicit conversion ArrowAssoc from GeoNear to ArrowAssoc[GeoNear]

Ungrouped