reactivemongo.api.commands

AggregationFramework

trait AggregationFramework[P <: SerializationPack] extends ImplicitCommandHelpers[P]

Implements the Aggregation Framework.

Linear Supertypes
ImplicitCommandHelpers[P], AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. AggregationFramework
  2. ImplicitCommandHelpers
  3. AnyRef
  4. 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

Type Members

  1. case class AddToSet(field: String) extends GroupFunction with Product with Serializable

  2. case class Aggregate(pipeline: Seq[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

  3. case class AggregationResult(firstBatch: List[P.Document], cursor: Option[ResultCursor] = scala.None) extends Product with Serializable

  4. case class Ascending(field: String) extends SortOrder with Product with Serializable

    Ascending sort order

  5. case class Avg(field: String) extends GroupFunction with Product with Serializable

  6. case class Cursor(batchSize: Int) extends Product with Serializable

  7. case class Descending(field: String) extends SortOrder with Product with Serializable

    Descending sort order

  8. case class First(field: String) extends GroupFunction with Product with Serializable

  9. case class GeoNear(spherical: Boolean = false, limit: Long = 100, maxDistance: Option[Long] = scala.None, selector: Option[P.Document] = scala.None, distanceMultiplier: Option[Double] = scala.None, uniqueDocs: Boolean = false, near: Option[P.Value] = scala.None, distanceField: Option[String] = scala.None, includeLocs: Option[String] = scala.None) extends PipelineOperator with Product with Serializable

    Outputs documents in order of nearest to farthest from a specified point.

  10. case class Group(identifiers: P.Value)(ops: (String, GroupFunction)*) extends PipelineOperator with Product with Serializable

    Groups documents together to calulate aggregates on document collections.

  11. case class GroupField(idField: String)(ops: (String, GroupFunction)*) extends PipelineOperator with Product with Serializable

    Groups documents together to calulate aggregates on document collections.

  12. sealed trait GroupFunction extends AnyRef

    Represents one of the group operators for the "Group" Operation.

  13. case class GroupMulti(idFields: (String, String)*)(ops: (String, GroupFunction)*) extends PipelineOperator with Product with Serializable

    Groups documents together to calulate aggregates on document collections.

  14. trait ImplicitlyDocumentProducer extends AnyRef

    Definition Classes
    ImplicitCommandHelpers
  15. case class Last(field: String) extends GroupFunction with Product with Serializable

  16. case class Limit(limit: Int) extends PipelineOperator with Product with Serializable

    Limits the number of documents that pass through the stream.

  17. case class Match(predicate: P.Document) extends PipelineOperator with Product with Serializable

    Filters out documents from the stream that do not match the predicate.

  18. case class Max(field: String) extends GroupFunction with Product with Serializable

  19. case class Min(field: String) extends GroupFunction with Product with Serializable

  20. case class Out(collection: String) extends PipelineOperator with Product with Serializable

    Takes the documents returned by the aggregation pipeline and writes them to a specified collection http://docs.

  21. sealed trait PipelineOperator extends AnyRef

    One of MongoDBs pipeline operators for aggregation.

  22. case class Project(specifications: P.Document) extends PipelineOperator with Product with Serializable

    Reshapes a document stream by renaming, adding, or removing fields.

  23. case class Push(field: String) extends GroupFunction with Product with Serializable

  24. case class PushMulti(fields: (String, String)*) extends GroupFunction with Product with Serializable

  25. case class Redact(expression: P.Document) extends PipelineOperator with Product with Serializable

    Restricts the contents of the documents based on information stored in the documents themselves.

  26. case class Sample(size: Int) extends PipelineOperator with Product with Serializable

    Randomly selects the specified number of documents from its input.

  27. case class Skip(skip: Int) extends PipelineOperator with Product with Serializable

    Skips over a number of documents before passing all further documents along the stream.

  28. case class Sort(fields: SortOrder*) extends PipelineOperator with Product with Serializable

    Sorts the stream based on the given fields.

  29. sealed trait SortOrder extends AnyRef

    Represents that a field should be sorted on, as well as whether it should be ascending or descending.

  30. case class SumField(field: String) extends GroupFunction with Product with Serializable

  31. case class SumValue(value: Int) extends GroupFunction with Product with Serializable

  32. case class Unwind(field: String) extends PipelineOperator with Product with Serializable

    Turns a document with an array into multiple documents, one document for each element in the array.

Abstract Value Members

  1. abstract def booleanValue(b: Boolean): P.Value

    Returns an boolean as a serialized value.

    Returns an boolean as a serialized value.

    Attributes
    protected
  2. abstract def doubleValue(d: Double): P.Value

    Returns an double as a serialized value.

    Returns an double as a serialized value.

    Attributes
    protected
  3. abstract def elementProducer(name: String, value: P.Value): P.ElementProducer

    Returns a producer of element for the given name and value.

    Returns a producer of element for the given name and value.

    name

    the element name

    value

    the element value

    Attributes
    protected
  4. abstract def intValue(i: Int): P.Value

    Returns an integer as a serialized value.

    Returns an integer as a serialized value.

    Attributes
    protected
  5. abstract def longValue(l: Long): P.Value

    Returns an long as a serialized value.

    Returns an long as a serialized value.

    Attributes
    protected
  6. abstract def makeDocument(elements: Seq[P.ElementProducer]): P.Document

    Returns a document from a sequence of element producers.

    Returns a document from a sequence of element producers.

    Attributes
    protected
  7. abstract val pack: P

    Definition Classes
    ImplicitCommandHelpers
  8. abstract def stringValue(s: String): P.Value

    Returns an string as a serialized value.

    Returns an string as a serialized value.

    Attributes
    protected

Concrete 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 AggregationFramework[P] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd
  5. def ->[B](y: B): (AggregationFramework[P], B)

    Implicit information
    This member is added by an implicit conversion from AggregationFramework[P] to ArrowAssoc[AggregationFramework[P]] 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. object GroupFunction

    Factory to declare custom call to a group function.

  9. object ImplicitlyDocumentProducer

    Definition Classes
    ImplicitCommandHelpers
  10. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  11. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def ensuring(cond: (AggregationFramework[P]) ⇒ Boolean, msg: ⇒ Any): AggregationFramework[P]

    Implicit information
    This member is added by an implicit conversion from AggregationFramework[P] to Ensuring[AggregationFramework[P]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. def ensuring(cond: (AggregationFramework[P]) ⇒ Boolean): AggregationFramework[P]

    Implicit information
    This member is added by an implicit conversion from AggregationFramework[P] to Ensuring[AggregationFramework[P]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  14. def ensuring(cond: Boolean, msg: ⇒ Any): AggregationFramework[P]

    Implicit information
    This member is added by an implicit conversion from AggregationFramework[P] to Ensuring[AggregationFramework[P]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  15. def ensuring(cond: Boolean): AggregationFramework[P]

    Implicit information
    This member is added by an implicit conversion from AggregationFramework[P] to Ensuring[AggregationFramework[P]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  16. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from AggregationFramework[P] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  20. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  21. def hashCode(): Int

    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. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  27. def toString(): String

    Definition Classes
    AnyRef → Any
  28. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. def [B](y: B): (AggregationFramework[P], B)

    Implicit information
    This member is added by an implicit conversion from AggregationFramework[P] to ArrowAssoc[AggregationFramework[P]] 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 AggregationFramework[P] 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:
    (aggregationFramework: StringAdd).self
    Definition Classes
    StringAdd
  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from AggregationFramework[P] 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:
    (aggregationFramework: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: AggregationFramework[P]

    Implicit information
    This member is added by an implicit conversion from AggregationFramework[P] to ArrowAssoc[AggregationFramework[P]] 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:
    (aggregationFramework: ArrowAssoc[AggregationFramework[P]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: AggregationFramework[P]

    Implicit information
    This member is added by an implicit conversion from AggregationFramework[P] to Ensuring[AggregationFramework[P]] 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:
    (aggregationFramework: Ensuring[AggregationFramework[P]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from ImplicitCommandHelpers[P]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from AggregationFramework[P] to StringAdd

Inherited by implicit conversion any2stringfmt from AggregationFramework[P] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from AggregationFramework[P] to ArrowAssoc[AggregationFramework[P]]

Inherited by implicit conversion any2Ensuring from AggregationFramework[P] to Ensuring[AggregationFramework[P]]

Ungrouped