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
Ordering
- Alphabetic
- By Inheritance
Inherited
- Aggregate
- Serializable
- Serializable
- Product
- Equals
- CommandWithResult
- CommandWithPack
- CollectionCommand
- AbstractCommand
- AnyRef
- Any
Implicitly
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
Visibility
- Public
- All
Instance Constructors
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
- def +(other: String): String
- def ->[B](y: B): (Aggregate, B)
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val allowDiskUse: Boolean
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val bypassDocumentValidation: Boolean
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val cursor: Option[Cursor]
- def ensuring(cond: (Aggregate) ⇒ Boolean, msg: ⇒ Any): Aggregate
- def ensuring(cond: (Aggregate) ⇒ Boolean): Aggregate
- def ensuring(cond: Boolean, msg: ⇒ Any): Aggregate
- def ensuring(cond: Boolean): Aggregate
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val explain: Boolean
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
- def formatted(fmtstr: String): String
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val pipeline: Seq[AggregationFramework.PipelineOperator]
- val readConcern: Option[ReadConcern]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
- val wireVersion: MongoWireVersion
- def →[B](y: B): (Aggregate, B)