Class

reactivemongo.api.commands.AggregationFramework

Aggregate

Related Doc: package AggregationFramework

Permalink

case class Aggregate(pipeline: Seq[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 (since MongoDB 3.2)

Linear Supertypes
Serializable, 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. Serializable
  4. Product
  5. Equals
  6. CommandWithResult
  7. CommandWithPack
  8. CollectionCommand
  9. AbstractCommand
  10. AnyRef
  11. 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 Aggregate(pipeline: Seq[PipelineOperator], explain: Boolean = false, allowDiskUse: Boolean, cursor: Option[Cursor], wireVersion: MongoWireVersion, bypassDocumentValidation: Boolean, readConcern: Option[ReadConcern])

    Permalink

    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 (since MongoDB 3.2)

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 Aggregate to any2stringadd[Aggregate] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Aggregate, B)

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  6. val allowDiskUse: Boolean

    Permalink

    enables writing to temporary files

  7. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  8. val bypassDocumentValidation: Boolean

    Permalink

    available only if you specify the $out aggregation operator

  9. def clone(): AnyRef

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

  10. val cursor: Option[Cursor]

    Permalink

    the cursor object for aggregation

  11. def ensuring(cond: (Aggregate) ⇒ Boolean, msg: ⇒ Any): Aggregate

    Permalink
    Implicit information
    This member is added by an implicit conversion from Aggregate to Ensuring[Aggregate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: (Aggregate) ⇒ Boolean): Aggregate

    Permalink
    Implicit information
    This member is added by an implicit conversion from Aggregate to Ensuring[Aggregate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean, msg: ⇒ Any): Aggregate

    Permalink
    Implicit information
    This member is added by an implicit conversion from Aggregate to Ensuring[Aggregate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  14. def ensuring(cond: Boolean): Aggregate

    Permalink
    Implicit information
    This member is added by an implicit conversion from Aggregate to Ensuring[Aggregate] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Permalink
    Definition Classes
    AnyRef

  16. val explain: Boolean

    Permalink

    specifies to return the information on the processing of the pipeline

  17. def finalize(): Unit

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

  18. def formatted(fmtstr: String): String

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

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

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

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

    Permalink
    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  24. val pipeline: Seq[PipelineOperator]

    Permalink

    the sequence of MongoDB aggregation operations

  25. val readConcern: Option[ReadConcern]

    Permalink

    the read concern (since MongoDB 3.2)

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

    Permalink
    Definition Classes
    AnyRef

  27. final def wait(): Unit

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

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

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

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

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

  30. val wireVersion: MongoWireVersion

    Permalink

  31. def →[B](y: B): (Aggregate, B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Aggregate to ArrowAssoc[Aggregate] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from Serializable

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 from Aggregate to any2stringadd[Aggregate]

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

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

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

Ungrouped