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
- Alphabetic
- By Inheritance
- GeoNear
- Serializable
- Product
- Equals
- PipelineOperator
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Instance Constructors
- 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
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (GeoNear, B)
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- val distanceField: Option[String]
- val distanceMultiplier: Option[Double]
- def ensuring(cond: (GeoNear) => Boolean, msg: => Any): GeoNear
- def ensuring(cond: (GeoNear) => Boolean): GeoNear
- def ensuring(cond: Boolean, msg: => Any): GeoNear
- def ensuring(cond: Boolean): GeoNear
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def formatted(fmtstr: String): String
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- val includeLocs: Option[String]
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val limit: Long
- def makePipe: P.Document
- Definition Classes
- GeoNear → PipelineOperator
- val maxDistance: Option[Long]
- val minDistance: Option[Long]
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val near: P.Value
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- def productElementNames: Iterator[String]
- Definition Classes
- Product
- val query: Option[P.Document]
- val spherical: Boolean
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val uniqueDocs: Boolean
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
Deprecated Value Members
- def →[B](y: B): (GeoNear, B)
- Implicit
- This member is added by an implicit conversion from GeoNear toArrowAssoc[GeoNear] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @deprecated
- Deprecated
(Since version 2.13.0) Use
->instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.