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

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. val allowDiskUse: Boolean
  2. val bypassDocumentValidation: Boolean
  3. val cursor: Option[Cursor]
  4. val explain: Boolean
  5. val pipeline: Seq[AggregationFramework.PipelineOperator]
  6. def productElementNames: Iterator[String]
    Definition Classes
    Product
  7. val readConcern: Option[ReadConcern]
  8. val wireVersion: MongoWireVersion