Packages

case class AggregationResult(firstBatch: List[P.Document], cursor: Option[ResultCursor] = None) extends Product with Serializable

firstBatch

the documents of the first batch

cursor

the cursor from the result, if any

Annotations
@deprecated
Deprecated

(Since version 0.12.7) Use api.collections.Aggregator

See also

Cursor

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

Instance Constructors

  1. new AggregationResult(firstBatch: List[P.Document], cursor: Option[ResultCursor] = None)

    firstBatch

    the documents of the first batch

    cursor

    the cursor from the result, if any

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 AggregationResult toany2stringadd[AggregationResult] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AggregationResult, B)
    Implicit
    This member is added by an implicit conversion from AggregationResult toArrowAssoc[AggregationResult] 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[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. val cursor: Option[ResultCursor]
  9. def ensuring(cond: (AggregationResult) => Boolean, msg: => Any): AggregationResult
    Implicit
    This member is added by an implicit conversion from AggregationResult toEnsuring[AggregationResult] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (AggregationResult) => Boolean): AggregationResult
    Implicit
    This member is added by an implicit conversion from AggregationResult toEnsuring[AggregationResult] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): AggregationResult
    Implicit
    This member is added by an implicit conversion from AggregationResult toEnsuring[AggregationResult] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): AggregationResult
    Implicit
    This member is added by an implicit conversion from AggregationResult toEnsuring[AggregationResult] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. val firstBatch: List[P.Document]
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AggregationResult toStringFormat[AggregationResult] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def head[T](implicit reader: P.Reader[T]): List[T]

    Returns the first batch as a list, using the given reader.

  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def productElementNames: Iterator[String]
    Definition Classes
    Product
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def [B](y: B): (AggregationResult, B)
    Implicit
    This member is added by an implicit conversion from AggregationResult toArrowAssoc[AggregationResult] 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.

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAggregationResult to any2stringadd[AggregationResult]

Inherited by implicit conversion StringFormat fromAggregationResult to StringFormat[AggregationResult]

Inherited by implicit conversion Ensuring fromAggregationResult to Ensuring[AggregationResult]

Inherited by implicit conversion ArrowAssoc fromAggregationResult to ArrowAssoc[AggregationResult]

Ungrouped