Class/Object

reactivemongo.api.commands.AggregationFramework

GeoNear

Related Docs: object GeoNear | package AggregationFramework

Permalink

final class GeoNear extends (AggregationFramework.this)#PipelineOperator

$geoNear aggregation stage, that outputs documents in order of nearest to farthest from a specified point.

Linear Supertypes
(AggregationFramework.this)#PipelineOperator, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. GeoNear
  2. PipelineOperator
  3. AnyRef
  4. 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

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from (AggregationFramework.this)#GeoNear to any2stringadd[(AggregationFramework.this)#GeoNear] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): ((AggregationFramework.this)#GeoNear, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from (AggregationFramework.this)#GeoNear to ArrowAssoc[(AggregationFramework.this)#GeoNear] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. val distanceField: Option[String]

    Permalink

    the output field that contains the calculated distance

  9. val distanceMultiplier: Option[Double]

    Permalink

    the factor to multiply all distances returned by the query

  10. def ensuring(cond: ((AggregationFramework.this)#GeoNear) ⇒ Boolean, msg: ⇒ Any): (AggregationFramework.this)#GeoNear

    Permalink
    Implicit information
    This member is added by an implicit conversion from (AggregationFramework.this)#GeoNear to Ensuring[(AggregationFramework.this)#GeoNear] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: ((AggregationFramework.this)#GeoNear) ⇒ Boolean): (AggregationFramework.this)#GeoNear

    Permalink
    Implicit information
    This member is added by an implicit conversion from (AggregationFramework.this)#GeoNear to Ensuring[(AggregationFramework.this)#GeoNear] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean, msg: ⇒ Any): (AggregationFramework.this)#GeoNear

    Permalink
    Implicit information
    This member is added by an implicit conversion from (AggregationFramework.this)#GeoNear to Ensuring[(AggregationFramework.this)#GeoNear] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean): (AggregationFramework.this)#GeoNear

    Permalink
    Implicit information
    This member is added by an implicit conversion from (AggregationFramework.this)#GeoNear to Ensuring[(AggregationFramework.this)#GeoNear] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  15. def equals(that: Any): Boolean

    Permalink
    Definition Classes
    GeoNear → AnyRef → Any

  16. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from (AggregationFramework.this)#GeoNear to StringFormat[(AggregationFramework.this)#GeoNear] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Permalink
    Definition Classes
    GeoNear → AnyRef → Any

  20. val includeLocs: Option[String]

    Permalink

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

  21. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  22. val limit: Option[Long]

    Permalink

    the maximum number of documents to return (no longer supported since MongoDB 4.2)

  23. def makePipe: P.Document

    Permalink
    Definition Classes
    GeoNear → PipelineOperator

  24. val maxDistance: Option[Long]

    Permalink

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

  25. val minDistance: Option[Long]

    Permalink

  26. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  27. val near: P.Value

    Permalink

    the point for which to find the closest documents

  28. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  29. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  30. val query: Option[P.Document]

    Permalink

    limits the results to the matching documents

  31. val spherical: Boolean

    Permalink

    if using a 2dsphere index

  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  33. def toString(): String

    Permalink
    Definition Classes
    GeoNear → AnyRef → Any

  34. val uniqueDocs: Boolean

    Permalink

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

  35. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  37. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  38. def →[B](y: B): ((AggregationFramework.this)#GeoNear, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from (AggregationFramework.this)#GeoNear to ArrowAssoc[(AggregationFramework.this)#GeoNear] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from (AggregationFramework.this)#PipelineOperator

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from (AggregationFramework.this)#GeoNear to any2stringadd[(AggregationFramework.this)#GeoNear]

Inherited by implicit conversion StringFormat from (AggregationFramework.this)#GeoNear to StringFormat[(AggregationFramework.this)#GeoNear]

Inherited by implicit conversion Ensuring from (AggregationFramework.this)#GeoNear to Ensuring[(AggregationFramework.this)#GeoNear]

Inherited by implicit conversion ArrowAssoc from (AggregationFramework.this)#GeoNear to ArrowAssoc[(AggregationFramework.this)#GeoNear]

Ungrouped