Aggregate

Performs aggregation operation using the aggregation pipeline. The pipeline allows users to process data from a collection with a sequence of stage-based manipulations.

pipeline: An array of aggregation pipeline stages that process and transform the document stream as part of the aggregation pipeline.
explain: Optional. Specifies to return the information on the processing of the pipeline.
allowDiskUse: Optional. Enables writing to temporary files. When set to true, aggregation stages can write data to the _tmp subdirectory in the dbPath directory.
cursor: Optional. Specify a document that contains options that control the creation of the cursor object.

Linear Supertypes

Serializable, Serializable, Product, Equals, Command, Message, Writable, AnyRef, Any

Instance Constructors

new Aggregate(databaseName: String, collectionName: String, pipeline: List[BsonDocument], explain: Option[Boolean], allowDiskUse: Option[Boolean], cursor: Option[BsonDocument])

pipeline
An array of aggregation pipeline stages that process and transform the document stream as part of the aggregation pipeline.
explain
Optional. Specifies to return the information on the processing of the pipeline.
allowDiskUse
Optional. Enables writing to temporary files. When set to true, aggregation stages can write data to the _tmp subdirectory in the dbPath directory.
cursor
Optional. Specify a document that contains options that control the creation of the cursor object.

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
val allowDiskUse: Option[Boolean]

Optional.
Optional. Enables writing to temporary files. When set to true, aggregation stages can write data to the _tmp subdirectory in the dbPath directory.
final def asInstanceOf[T0]: T0

Definition Classes
Any
implicit val byteOrder: ByteOrder

Definition Classes
Message
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val collectionName: String
val command: BsonDocument

Definition Classes
Aggregate → Command
val cursor: Option[BsonDocument]

Optional.
Optional. Specify a document that contains options that control the creation of the cursor object.
val databaseName: String

Definition Classes
Aggregate → Command
def encode: ByteString

Definition Classes
Message → Writable
def encodeBody: ByteString

Definition Classes
Command → Message
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
val explain: Option[Boolean]

Optional.
Optional. Specifies to return the information on the processing of the pipeline.
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
val opCode: Int

Definition Classes
Command → Message
val pipeline: List[BsonDocument]

An array of aggregation pipeline stages that process and transform the document stream as part of the aggregation pipeline.
def putCString(builder: ByteStringBuilder, value: String): ByteStringBuilder

Definition Classes
Writable
val requestID: Int

Definition Classes
Message
val responseTo: Int

Definition Classes
Command → Message
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( ... )

Related Doc: package command

case class Aggregate(databaseName: String, collectionName: String, pipeline: List[BsonDocument], explain: Option[Boolean], allowDiskUse: Option[Boolean], cursor: Option[BsonDocument]) extends Command with Product with Serializable

Instance Constructors

new Aggregate(databaseName: String, collectionName: String, pipeline: List[BsonDocument], explain: Option[Boolean], allowDiskUse: Option[Boolean], cursor: Option[BsonDocument])

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

val allowDiskUse: Option[Boolean]

final def asInstanceOf[T0]: T0

implicit val byteOrder: ByteOrder

def clone(): AnyRef

val collectionName: String

val command: BsonDocument

val cursor: Option[BsonDocument]

val databaseName: String

def encode: ByteString

def encodeBody: ByteString

final def eq(arg0: AnyRef): Boolean

val explain: Option[Boolean]

def finalize(): Unit

final def getClass(): Class[_]

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

val opCode: Int

val pipeline: List[BsonDocument]

def putCString(builder: ByteStringBuilder, value: String): ByteStringBuilder

val requestID: Int

val responseTo: Int

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

final def wait(): Unit

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

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Command

Inherited from Message

Inherited from Writable

Inherited from AnyRef

Inherited from Any

Ungrouped