Class/Object

reactivemongo.core.commands

Aggregate

Related Docs: object Aggregate | package commands

Permalink

case class Aggregate(collectionName: String, pipeline: Seq[PipelineOperator]) extends Command[Stream[BSONDocument]] with Product with Serializable

Implements the "aggregation" command, otherwise known as the "Aggregation Framework." http://docs.mongodb.org/manual/applications/aggregation/

collectionName

Collection to aggregate against

pipeline

Sequence of MongoDB aggregation operations.

Annotations
@deprecated
Deprecated

(Since version 0.11.4) Use reactivemongo.api.collections.bson.BSONCollection.aggregate

Linear Supertypes
Serializable, Serializable, Product, Equals, Command[Stream[BSONDocument]], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Aggregate
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Command
  7. AnyRef
  8. Any
Implicitly
  1. by CollectionsHaveToParArray
  2. by any2stringadd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  1. Hide All
  2. Show all
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Aggregate(collectionName: String, pipeline: Seq[PipelineOperator])

    Permalink

    collectionName

    Collection to aggregate against

    pipeline

    Sequence of MongoDB aggregation operations.

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 ResultMaker: Aggregate.type

    Permalink

    Deserializer for this command's result.

    Deserializer for this command's result.

    Definition Classes
    Aggregate → Command

  7. def apply(db: String): MakableCommand

    Permalink

    Produces a reactivemongo.core.commands.MakableCommand instance of this command.

    Produces a reactivemongo.core.commands.MakableCommand instance of this command.

    db

    name of the target database.

    Definition Classes
    Command

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  9. def clone(): AnyRef

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

  10. val collectionName: String

    Permalink

    Collection to aggregate against

  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. def finalize(): Unit

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

  17. 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()

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

    Permalink
    Definition Classes
    AnyRef → Any

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. def makeDocuments: BSONDocument

    Permalink

    Makes the BSONDocument for documents that will be send as body of this command's query.

    Makes the BSONDocument for documents that will be send as body of this command's query.

    Definition Classes
    Aggregate → Command

  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

    Sequence of MongoDB aggregation operations.

  25. def slaveOk: Boolean

    Permalink

    States if this command can be run on secondaries.

    States if this command can be run on secondaries.

    Definition Classes
    Command

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

    Permalink
    Definition Classes
    AnyRef

  27. def toParArray: ParArray[T]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Aggregate to CollectionsHaveToParArray[Aggregate, T] performed by method CollectionsHaveToParArray in scala.collection.parallel. This conversion will take place only if an implicit value of type (Aggregate) ⇒ GenTraversableOnce[T] is in scope.
    Definition Classes
    CollectionsHaveToParArray

  28. final def wait(): Unit

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

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

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

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

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

  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 Command[Stream[BSONDocument]]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion CollectionsHaveToParArray from Aggregate to CollectionsHaveToParArray[Aggregate, T]

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