Packages

case class Aggregate(pipeline: Seq[AggregationFramework.PipelineOperator], explain: Boolean = false, allowDiskUse: Boolean, cursor: Option[Cursor], wireVersion: MongoWireVersion, bypassDocumentValidation: Boolean, readConcern: Option[ReadConcern]) extends CollectionCommand with CommandWithPack[pack.type] with CommandWithResult[AggregationResult] with Product with Serializable

pipeline

the sequence of MongoDB aggregation operations

explain

specifies to return the information on the processing of the pipeline

allowDiskUse

enables writing to temporary files

cursor

the cursor object for aggregation

bypassDocumentValidation

available only if you specify the $out aggregation operator

readConcern

the read concern

Annotations
@deprecated
Deprecated

(Since version 0.12.7) Use api.collections.Aggregator

Since

MongoDB 3.2

Linear Supertypes
Serializable, Product, Equals, CommandWithResult[AggregationResult], CommandWithPack[AggregationFramework.pack.type], CollectionCommand, AbstractCommand, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Aggregate
  2. Serializable
  3. Product
  4. Equals
  5. CommandWithResult
  6. CommandWithPack
  7. CollectionCommand
  8. AbstractCommand
  9. AnyRef
  10. 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 Aggregate(pipeline: Seq[AggregationFramework.PipelineOperator], explain: Boolean = false, allowDiskUse: Boolean, cursor: Option[Cursor], wireVersion: MongoWireVersion, bypassDocumentValidation: Boolean, readConcern: Option[ReadConcern])

    pipeline

    the sequence of MongoDB aggregation operations

    explain

    specifies to return the information on the processing of the pipeline

    allowDiskUse

    enables writing to temporary files

    cursor

    the cursor object for aggregation

    bypassDocumentValidation

    available only if you specify the $out aggregation operator

    readConcern

    the read concern

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 Aggregate toany2stringadd[Aggregate] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Aggregate, B)
    Implicit
    This member is added by an implicit conversion from Aggregate toArrowAssoc[Aggregate] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. val allowDiskUse: Boolean
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. val bypassDocumentValidation: Boolean
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. val cursor: Option[Cursor]
  11. def ensuring(cond: (Aggregate) => Boolean, msg: => Any): Aggregate
    Implicit
    This member is added by an implicit conversion from Aggregate toEnsuring[Aggregate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: (Aggregate) => Boolean): Aggregate
    Implicit
    This member is added by an implicit conversion from Aggregate toEnsuring[Aggregate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: Boolean, msg: => Any): Aggregate
    Implicit
    This member is added by an implicit conversion from Aggregate toEnsuring[Aggregate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean): Aggregate
    Implicit
    This member is added by an implicit conversion from Aggregate toEnsuring[Aggregate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. val explain: Boolean
  17. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from Aggregate toStringFormat[Aggregate] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  18. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. val pipeline: Seq[AggregationFramework.PipelineOperator]
  24. def productElementNames: Iterator[String]
    Definition Classes
    Product
  25. val readConcern: Option[ReadConcern]
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  30. val wireVersion: MongoWireVersion

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

Inherited from CommandWithPack[AggregationFramework.pack.type]

Inherited from CollectionCommand

Inherited from AbstractCommand

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAggregate to any2stringadd[Aggregate]

Inherited by implicit conversion StringFormat fromAggregate to StringFormat[Aggregate]

Inherited by implicit conversion Ensuring fromAggregate to Ensuring[Aggregate]

Inherited by implicit conversion ArrowAssoc fromAggregate to ArrowAssoc[Aggregate]

Ungrouped