reactivemongo.api.commands.AggregationFramework

Aggregate

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

Annotations
@deprecated
Deprecated

(Since version 0.12.7) Use api.collections.Aggregator

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 any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

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

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Aggregate to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

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

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

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  8. val allowDiskUse: Boolean

    enables writing to temporary files

  9. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  10. val bypassDocumentValidation: Boolean

    available only if you specify the $out aggregation operator

  11. def clone(): AnyRef

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

  12. val cursor: Option[Cursor]

    the cursor object for aggregation

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

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

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

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

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

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

  16. def ensuring(cond: Boolean): Aggregate

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

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

    Definition Classes
    AnyRef

  18. val explain: Boolean

    specifies to return the information on the processing of the pipeline

  19. def finalize(): Unit

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

  20. def formatted(fmtstr: String): String

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

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

    Definition Classes
    AnyRef → Any

  22. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  24. final def notify(): Unit

    Definition Classes
    AnyRef

  25. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  26. val pipeline: Seq[AggregationFramework.PipelineOperator]

    the sequence of MongoDB aggregation operations

  27. val readConcern: Option[ReadConcern]

    the read concern (since MongoDB 3.

    the read concern (since MongoDB 3.2)

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

    Definition Classes
    AnyRef

  29. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  32. val wireVersion: MongoWireVersion

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

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

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Aggregate to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (aggregate: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Aggregate to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (aggregate: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Aggregate

    Implicit information
    This member is added by an implicit conversion from Aggregate to ArrowAssoc[Aggregate] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (aggregate: ArrowAssoc[Aggregate]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Aggregate

    Implicit information
    This member is added by an implicit conversion from Aggregate to Ensuring[Aggregate] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (aggregate: Ensuring[Aggregate]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

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 StringAdd

Inherited by implicit conversion any2stringfmt from Aggregate to StringFormat

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

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

Ungrouped