t

reactivemongo.api.commands

AggregationFramework

trait AggregationFramework[P <: SerializationPack] extends ImplicitCommandHelpers[P] with GroupAggregation[P] with SliceAggregation[P] with SortAggregation[P] with AggregationPipeline[P]

Implements the Aggregation Framework.

Self Type
AggregationFramework[P]
See also

PipelineOperator

Linear Supertypes
AggregationPipeline[P], SortAggregation[P], SliceAggregation[P], GroupAggregation[P], ImplicitCommandHelpers[P], AnyRef, Any
Known Subclasses
BSONAggregationFramework
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AggregationFramework
  2. AggregationPipeline
  3. SortAggregation
  4. SliceAggregation
  5. GroupAggregation
  6. ImplicitCommandHelpers
  7. AnyRef
  8. 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

Type Members

  1. class AddFieldToSet extends GroupFunction with Product1[String] with Serializable

    The $addToSet group accumulator.

    The $addToSet group accumulator.

    Definition Classes
    GroupAggregation
  2. class AddFields extends PipelineOperator with Product1[P.Document] with Serializable

    $addFields stage.

    $addFields stage.

    Since

    MongoDB 3.4

  3. class AddToSet extends GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $addToSet group accumulator.

    The $addToSet group accumulator.

    Definition Classes
    GroupAggregation
  4. class Ascending extends SortOrder with Product1[String] with Serializable

    Ascending sort order

    Ascending sort order

    Definition Classes
    SortAggregation
  5. class Avg extends GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $avg group accumulator.

    The $avg group accumulator.

    Definition Classes
    GroupAggregation
  6. class AvgField extends GroupFunction with Product1[String] with Serializable

    The $avg group accumulator.

    The $avg group accumulator.

    Definition Classes
    GroupAggregation
  7. class Bucket extends PipelineOperator with Product4[P.Value, Seq[P.Value], String, Seq[(String, GroupFunction)]]

    $bucket aggregation stage.

  8. class BucketAuto extends PipelineOperator with Product4[P.Value, Int, Option[String], Seq[(String, GroupFunction)]] with Serializable

    $bucket aggregation stage.

    $bucket aggregation stage.

    Since

    MongoDB 3.4 Categorizes incoming documents into a specific number of groups, called buckets, based on a specified expression. Bucket boundaries are automatically determined in an attempt to evenly distribute the documents into the specified number of buckets. Document fields identifier must be prefixed with $.

  9. final class ChangeStream extends PipelineOperator

    Low level pipeline operator which allows to open a tailable cursor against subsequent change events of a given collection.

    Low level pipeline operator which allows to open a tailable cursor against subsequent change events of a given collection.

    For common use-cases, you might prefer to use the watch operator on a collection.

    Note: the target mongo instance MUST be a replica-set (even in the case of a single node deployement).

    Since

    MongoDB 3.6

  10. class CollStats extends PipelineOperator with Product3[Boolean, Option[Double], Boolean] with Serializable

    $collStats aggregation stage.

  11. class Count extends PipelineOperator with Product1[String] with Serializable

    $count of the number of documents input.

    $count of the number of documents input.

    Since

    MongoDB 3.4

  12. class CurrentOp extends PipelineOperator with Product5[Boolean, Boolean, Boolean, Boolean, Boolean]

    $currentOp.

    $currentOp.

    Since

    MongoDB 3.6

  13. class Descending extends SortOrder with Product1[String] with Serializable

    Descending sort order

    Descending sort order

    Definition Classes
    SortAggregation
  14. class Facet extends PipelineOperator with Product1[Iterable[(String, Pipeline)]] with Serializable

    Processes multiple aggregation pipelines within a single stage on the same set of input documents.

    Processes multiple aggregation pipelines within a single stage on the same set of input documents.

    Each sub-pipeline has its own field in the output document where its results are stored as an array of documents.

    See also

    https://docs.mongodb.com/manual/reference/operator/aggregation/facet/

  15. class First extends GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $field group accumulator.

    The $field group accumulator.

    Definition Classes
    GroupAggregation
  16. class FirstField extends GroupFunction with Product1[String] with Serializable

    The $field group accumulator.

    The $field group accumulator.

    Definition Classes
    GroupAggregation
  17. class GeoNear extends PipelineOperator with Product with Serializable

    $geoNear aggregation stage, that outputs documents in order of nearest to farthest from a specified point.

  18. class GraphLookup extends PipelineOperator with Product8[String, P.Value, String, String, String, Option[Int], Option[String], Option[P.Value]] with Serializable

    The $graphLookup aggregation stage.

    The $graphLookup aggregation stage.

    Since

    MongoDB 3.4

  19. class Group extends PipelineOperator with Product2[P.Value, Seq[(String, GroupFunction)]] with Serializable

    $groups documents together to calculate aggregates on document collections.

    $groups documents together to calculate aggregates on document collections. This command aggregates on arbitrary identifiers. Document fields identifier must be prefixed with $.

  20. class GroupField extends PipelineOperator with Product2[String, Seq[(String, GroupFunction)]] with Serializable

    $groups documents together to calculate aggregates on document collections.

    $groups documents together to calculate aggregates on document collections. This command aggregates on one field.

  21. sealed trait GroupFunction extends AnyRef

    Represents one of the group/accumulator operators, for the $group aggregation.

    Represents one of the group/accumulator operators, for the $group aggregation. Operation.

    Definition Classes
    GroupAggregation
    See also

    https://docs.mongodb.com/manual/reference/operator/aggregation/group/#accumulator-operator

  22. class GroupMulti extends PipelineOperator with Product2[Seq[(String, String)], Seq[(String, GroupFunction)]] with Serializable

    $groups documents together to calculate aggregates on document collections.

    $groups documents together to calculate aggregates on document collections. This command aggregates on multiple fields, and they must be named.

  23. class IndexStatAccesses extends Product2[Long, Long] with Serializable

  24. class IndexStatsResult extends Product4[String, P.Document, String, IndexStatAccesses] with Serializable

  25. class Last extends GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $field group accumulator.

    The $field group accumulator.

    Definition Classes
    GroupAggregation
  26. class LastField extends GroupFunction with Product1[String] with Serializable

    The $field group accumulator.

    The $field group accumulator.

    Definition Classes
    GroupAggregation
  27. class Limit extends PipelineOperator with Product1[Int] with Serializable

    $limits the number of documents that pass through the stream.

  28. class ListLocalSessions extends PipelineOperator

    $listLocalSessions aggregation stage.

    $listLocalSessions aggregation stage.

    Since

    MongoDB 3.6

  29. class ListSessions extends PipelineOperator

    $listSessions aggregation stage.

    $listSessions aggregation stage.

    Since

    MongoDB 3.6

  30. class Lookup extends PipelineOperator with Product4[String, String, String, String] with Serializable

    Performs a left outer join to an unsharded collection in the same database to filter in documents from the "joined" collection for processing.

    Performs a left outer join to an unsharded collection in the same database to filter in documents from the "joined" collection for processing.

    Since

    MongoDB 3.2

  31. class Match extends PipelineOperator with Product1[P.Document] with Serializable

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

  32. class Max extends GroupFunction

    The $max group accumulator.

    The $max group accumulator.

    Definition Classes
    GroupAggregation
  33. class MaxField extends GroupFunction with Product1[String] with Serializable

    The $max group accumulator.

    The $max group accumulator.

    Definition Classes
    GroupAggregation
  34. class Merge extends PipelineOperator with Product6[String, String, Seq[String], Option[String], Option[P.Document], Option[String]] with Serializable

    $merge aggregation stage.

    $merge aggregation stage.

    Since

    MongoDB 4.2

  35. class MergeObjects extends GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $mergeObjects group accumulator.

    The $mergeObjects group accumulator.

    Definition Classes
    GroupAggregation
  36. sealed trait MetadataKeyword extends AnyRef

    Keyword of metadata.

    Keyword of metadata.

    Definition Classes
    SortAggregation
  37. class MetadataSort extends SortOrder with Product2[String, MetadataKeyword] with Serializable

    Metadata sort order.

    Metadata sort order.

    Definition Classes
    SortAggregation
  38. class Min extends GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $min group accumulator.

    The $min group accumulator.

    Definition Classes
    GroupAggregation
  39. class MinField extends GroupFunction with Product1[String] with Serializable

    The $min group accumulator.

    The $min group accumulator.

    Definition Classes
    GroupAggregation
  40. class Out extends PipelineOperator with Product1[String] with Serializable

    Takes the documents returned by the aggregation pipeline and writes them to a specified collection

  41. type Pipeline = (PipelineOperator, List[PipelineOperator])

    Aggregation pipeline (with at least one stage operator)

    Aggregation pipeline (with at least one stage operator)

    Definition Classes
    AggregationPipeline
  42. trait PipelineOperator extends AnyRef

    One of MongoDBs pipeline operators for aggregation.

    One of MongoDBs pipeline operators for aggregation. Sealed as these are defined in the MongoDB specifications, and clients should not have custom operators.

    Definition Classes
    AggregationPipeline
  43. class Project extends PipelineOperator with Product1[P.Document] with Serializable

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

    Reshapes a document stream by renaming, adding, or removing fields. Also uses Project to create computed values or sub-objects.

  44. class Push extends GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $push group accumulator.

    The $push group accumulator.

    Definition Classes
    GroupAggregation
  45. class PushField extends GroupFunction with Product1[String] with Serializable

    The $push group accumulator.

    The $push group accumulator.

    Definition Classes
    GroupAggregation
  46. class Redact extends PipelineOperator with Product1[P.Document] with Serializable

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

    Restricts the contents of the documents based on information stored in the documents themselves. http://docs.mongodb.org/manual/reference/operator/aggregation/redact/#pipe._S_redact Redact

  47. class ReplaceRoot extends PipelineOperator with Product1[P.Document] with Serializable

    Promotes a specified document to the top level and replaces all other fields.

    Promotes a specified document to the top level and replaces all other fields. The operation replaces all existing fields in the input document, including the _id field. https://docs.mongodb.com/manual/reference/operator/aggregation/replaceRoot

  48. class ReplaceRootField extends PipelineOperator with Product1[String] with Serializable

    Promotes a specified document to the top level and replaces all other fields.

    Promotes a specified document to the top level and replaces all other fields. The operation replaces all existing fields in the input document, including the _id field. https://docs.mongodb.com/manual/reference/operator/aggregation/replaceRoot

  49. class ReplaceWith extends PipelineOperator with Product1[P.Document] with Serializable

    The $replaceWith aggregation stage.

    The $replaceWith aggregation stage.

    Since

    MongoDB 4.2

  50. class Sample extends PipelineOperator with Product1[Int] with Serializable

    $sample aggregation stage, that randomly selects the specified number of documents from its input.

  51. class Set extends PipelineOperator with Product1[P.Document] with Serializable

    $set aggregation stage

  52. class Skip extends PipelineOperator with Product1[Int] with Serializable

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

  53. final class Slice extends PipelineOperator

    Returns a subset of an array.

    Returns a subset of an array. https://docs.mongodb.com/manual/reference/operator/aggregation/slice/

    Definition Classes
    SliceAggregation
  54. class Sort extends PipelineOperator with Product1[Seq[SortOrder]] with Serializable

    $sorts the stream based on the given fields.

  55. class SortByCount extends PipelineOperator with Product1[P.Value] with Serializable

    The $sortByCount aggregation stage.

    The $sortByCount aggregation stage.

    Since

    MongoDB 3.4

  56. class SortByFieldCount extends PipelineOperator with Product1[String] with Serializable

    The $sortByCount aggregation stage.

    The $sortByCount aggregation stage.

    Since

    MongoDB 3.4

  57. sealed trait SortOrder extends AnyRef

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

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

    Definition Classes
    SortAggregation
  58. class StdDevPop extends GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $stdDevPop group accumulator.

    The $stdDevPop group accumulator.

    Definition Classes
    GroupAggregation
    Since

    MongoDB 3.2

  59. class StdDevPopField extends GroupFunction with Product1[String] with Serializable

    The $stdDevPop for a single field.

    The $stdDevPop for a single field.

    Definition Classes
    GroupAggregation
    Since

    MongoDB 3.2

  60. class StdDevSamp extends GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $stdDevSamp group accumulator

    The $stdDevSamp group accumulator

    Definition Classes
    GroupAggregation
    Since

    MongoDB 3.2

  61. class StdDevSampField extends GroupFunction with Product1[String] with Serializable

    The $stdDevSamp for a single field

    The $stdDevSamp for a single field

    Definition Classes
    GroupAggregation
    Since

    MongoDB 3.2

  62. class Sum extends GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $sum group accumulator.

    The $sum group accumulator.

    Definition Classes
    GroupAggregation
  63. class SumField extends GroupFunction with Product1[String] with Serializable

    The $sum group accumulator.

    The $sum group accumulator.

    Definition Classes
    GroupAggregation
  64. class Unset extends PipelineOperator with Product2[String, Seq[String]] with Serializable

    The $unset aggregation stage.

    The $unset aggregation stage.

    Since

    MongoDB 4.2

  65. class Unwind extends PipelineOperator with Product with Serializable
  66. class UnwindField extends Unwind with Serializable

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

    Turns a document with an array into multiple documents, one document for each element in the array. http://docs.mongodb.org/manual/reference/aggregation/unwind/#_S_unwind

  67. trait ImplicitlyDocumentProducer extends AnyRef
    Definition Classes
    ImplicitCommandHelpers

Deprecated Type Members

  1. 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

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

    firstBatch

    the documents of the first batch

    cursor

    the cursor from the result, if any

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.7) Use api.collections.Aggregator

    See also

    Cursor

  3. class Cursor extends Product1[Int]

    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.7) Use api.collections.Aggregator

  4. case class Filter(input: P.Value, as: String, cond: P.Document) extends PipelineOperator with Product with Serializable

    The $filter aggregation stage.

    The $filter aggregation stage.

    input

    the expression that resolves to an array

    as

    The variable name for the element in the input array. The as expression accesses each element in the input array by this variable.

    cond

    the expression that determines whether to include the element in the resulting array

    Annotations
    @deprecated
    Deprecated

    (Since version 0.19.4) Not a pipeline operator (stage)

  5. case class SumValue extends GroupFunction with Product with Serializable
    Definition Classes
    GroupAggregation
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.0) Use SumAll

Abstract Value Members

  1. abstract val pack: P
    Definition Classes
    AggregationPipeline

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String
    Implicit
    This member is added by an implicit conversion from AggregationFramework[P] toany2stringadd[AggregationFramework[P]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (AggregationFramework[P], B)
    Implicit
    This member is added by an implicit conversion from AggregationFramework[P] toArrowAssoc[AggregationFramework[P]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. final lazy val builder: Builder[pack.type]
    Attributes
    protected
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def ensuring(cond: (AggregationFramework[P]) => Boolean, msg: => Any): AggregationFramework[P]
    Implicit
    This member is added by an implicit conversion from AggregationFramework[P] toEnsuring[AggregationFramework[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: (AggregationFramework[P]) => Boolean): AggregationFramework[P]
    Implicit
    This member is added by an implicit conversion from AggregationFramework[P] toEnsuring[AggregationFramework[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean, msg: => Any): AggregationFramework[P]
    Implicit
    This member is added by an implicit conversion from AggregationFramework[P] toEnsuring[AggregationFramework[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. def ensuring(cond: Boolean): AggregationFramework[P]
    Implicit
    This member is added by an implicit conversion from AggregationFramework[P] toEnsuring[AggregationFramework[P]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def formatted(fmtstr: String): String
    Implicit
    This member is added by an implicit conversion from AggregationFramework[P] toStringFormat[AggregationFramework[P]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  20. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def pipe(name: String, arg: P.Value): P.Document
    Attributes
    protected
    Annotations
    @inline()
  23. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  26. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  27. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  28. object AddFieldToSet extends AbstractFunction1[String, AddFieldToSet] with Serializable
    Definition Classes
    GroupAggregation
  29. object AddFields extends AbstractFunction1[P.Document, AddFields] with Serializable
  30. object AddToSet extends AbstractFunction1[GroupAggregation.P.Value, AddToSet] with Serializable
    Definition Classes
    GroupAggregation
  31. object Ascending extends AbstractFunction1[String, Ascending] with Serializable
    Definition Classes
    SortAggregation
  32. object Avg extends AbstractFunction1[GroupAggregation.P.Value, Avg] with Serializable
    Definition Classes
    GroupAggregation
  33. object AvgField extends AbstractFunction1[String, AvgField] with Serializable
    Definition Classes
    GroupAggregation
  34. object Bucket
  35. object BucketAuto extends Serializable
  36. object CollStats extends AbstractFunction3[Boolean, Option[Double], Boolean, CollStats] with Serializable
  37. object Count extends AbstractFunction1[String, Count] with Serializable
  38. object CurrentOp extends AbstractFunction5[Boolean, Boolean, Boolean, Boolean, Boolean, CurrentOp]
  39. object Cursor extends AbstractFunction1[Int, Cursor]
  40. object Descending extends AbstractFunction1[String, Descending] with Serializable
    Definition Classes
    SortAggregation
  41. object Facet extends AbstractFunction1[Iterable[(String, Pipeline)], Facet] with Serializable
  42. object Filter extends Serializable

    Filter companion

  43. object First extends AbstractFunction1[GroupAggregation.P.Value, First] with Serializable
    Definition Classes
    GroupAggregation
  44. object FirstField extends AbstractFunction1[String, FirstField] with Serializable
    Definition Classes
    GroupAggregation
  45. object GeoNear extends Serializable
  46. object GraphLookup extends AbstractFunction8[String, P.Value, String, String, String, Option[Int], Option[String], Option[P.Value], GraphLookup] with Serializable
  47. object Group extends Serializable
  48. object GroupField extends Serializable
  49. object GroupFunction

    Factory to declare custom call to a group function.

    Factory to declare custom call to a group function.

    Definition Classes
    GroupAggregation
  50. object GroupMulti extends Serializable
  51. object IndexStatAccesses extends AbstractFunction2[Long, Long, IndexStatAccesses] with Serializable
  52. object IndexStats extends PipelineOperator with Product with Serializable

    $indexStats aggregation stage.

    $indexStats aggregation stage.

    Since

    MongoDB 3.2

  53. object IndexStatsResult extends AbstractFunction4[String, P.Document, String, IndexStatAccesses, IndexStatsResult] with Serializable
  54. object Last extends AbstractFunction1[GroupAggregation.P.Value, Last] with Serializable
    Definition Classes
    GroupAggregation
  55. object LastField extends AbstractFunction1[String, LastField] with Serializable
    Definition Classes
    GroupAggregation
  56. object Limit extends AbstractFunction1[Int, Limit] with Serializable
  57. object ListLocalSessions extends AbstractFunction1[P.Document, ListLocalSessions]
  58. object ListSessions extends AbstractFunction1[P.Document, ListSessions]
  59. object Lookup extends AbstractFunction4[String, String, String, String, Lookup] with Serializable
  60. object Match extends AbstractFunction1[P.Document, Match] with Serializable
  61. object Max extends AbstractFunction1[GroupAggregation.P.Value, Max]
    Definition Classes
    GroupAggregation
  62. object MaxField extends AbstractFunction1[String, MaxField] with Serializable
    Definition Classes
    GroupAggregation
  63. object Merge extends AbstractFunction6[String, String, Seq[String], Option[String], Option[P.Document], Option[String], Merge] with Serializable
  64. object MergeObjects extends AbstractFunction1[GroupAggregation.P.Value, MergeObjects] with Serializable
    Definition Classes
    GroupAggregation
  65. object MetadataSort extends AbstractFunction2[String, MetadataKeyword, MetadataSort] with Serializable
    Definition Classes
    SortAggregation
  66. object Min extends AbstractFunction1[GroupAggregation.P.Value, Min] with Serializable
    Definition Classes
    GroupAggregation
  67. object MinField extends AbstractFunction1[String, MinField] with Serializable
    Definition Classes
    GroupAggregation
  68. object Out extends AbstractFunction1[String, Out] with Serializable
  69. object PipelineOperator

    Only for advanced user: Factory for stage not already provided in the API.

    Only for advanced user: Factory for stage not already provided in the API.

    For example for { $sample: { size: 2 } }

    import scala.concurrent.ExecutionContext

import reactivemongo.api.bson.{ BSONDocument, BSONInteger, BSONString }
import reactivemongo.api.bson.collection.BSONCollection

def foo(coll: BSONCollection)(implicit ec: ExecutionContext) =
  coll.aggregateWith[BSONDocument]() { agg =>
    import agg.PipelineOperator

    val stage = PipelineOperator(BSONDocument(
      f"$$sample" -> BSONDocument("size" -> 2)))

    stage -> List.empty
  }
    Definition Classes
    AggregationPipeline
  70. object PlanCacheStats extends PipelineOperator with Product with Serializable

    $planCacheStats aggregation stage.

    $planCacheStats aggregation stage.

    Since

    MongoDB 4.2

  71. object Project extends AbstractFunction1[P.Document, Project] with Serializable
  72. object Push extends AbstractFunction1[GroupAggregation.P.Value, Push] with Serializable
    Definition Classes
    GroupAggregation
  73. object PushField extends AbstractFunction1[String, PushField] with Serializable
    Definition Classes
    GroupAggregation
  74. object Redact extends AbstractFunction1[P.Document, Redact] with Serializable
  75. object ReplaceRoot extends AbstractFunction1[P.Document, ReplaceRoot] with Serializable
  76. object ReplaceRootField extends AbstractFunction1[String, ReplaceRootField] with Serializable
  77. object ReplaceWith extends AbstractFunction1[P.Document, ReplaceWith] with Serializable
  78. object Sample extends AbstractFunction1[Int, Sample] with Serializable
  79. object Set extends AbstractFunction1[P.Document, Set] with Serializable
  80. object Skip extends AbstractFunction1[Int, Skip] with Serializable
  81. object Slice

    import scala.concurrent.ExecutionContext

import reactivemongo.api.bson.{ BSONDocument, BSONInteger, BSONString }
import reactivemongo.api.bson.collection.BSONCollection

def foo(coll: BSONCollection)(implicit ec: ExecutionContext) = {
  coll.aggregateWith[BSONDocument]() { agg =>
    import agg.{ Project, Slice }

    // Define the pipeline stages
    Project(BSONDocument(
      "name" -> 1,
      "favorites" -> Slice(
        array = BSONString(f"$$favorites"),
        n = BSONInteger(3)).makePipe)) -> List.empty
  }
}
    Definition Classes
    SliceAggregation
  82. object Sort extends Serializable
  83. object SortByCount extends AbstractFunction1[P.Value, SortByCount] with Serializable
  84. object SortByFieldCount extends AbstractFunction1[String, SortByFieldCount] with Serializable
  85. object StdDevPop extends AbstractFunction1[GroupAggregation.P.Value, StdDevPop] with Serializable
    Definition Classes
    GroupAggregation
  86. object StdDevPopField extends AbstractFunction1[String, StdDevPopField] with Serializable
    Definition Classes
    GroupAggregation
  87. object StdDevSamp extends AbstractFunction1[GroupAggregation.P.Value, StdDevSamp] with Serializable
    Definition Classes
    GroupAggregation
  88. object StdDevSampField extends AbstractFunction1[String, StdDevSampField] with Serializable
    Definition Classes
    GroupAggregation
  89. object Sum extends AbstractFunction1[GroupAggregation.P.Value, Sum] with Serializable
    Definition Classes
    GroupAggregation
  90. object SumAll extends GroupFunction with Product with Serializable

    The $sum: 1 group accumulator.

    The $sum: 1 group accumulator.

    Definition Classes
    GroupAggregation
  91. object SumField extends AbstractFunction1[String, SumField] with Serializable
    Definition Classes
    GroupAggregation
  92. object TextScore extends MetadataKeyword with Product with Serializable

    References the score associated with the corresponding $text query for each matching document.

    References the score associated with the corresponding $text query for each matching document.

    Definition Classes
    SortAggregation
  93. object Unset extends AbstractFunction2[String, Seq[String], Unset] with Serializable
  94. object Unwind extends Serializable
  95. object UnwindField extends AbstractFunction1[String, UnwindField] with Serializable
  96. object ImplicitlyDocumentProducer
    Definition Classes
    ImplicitCommandHelpers

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @deprecated
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

  2. def →[B](y: B): (AggregationFramework[P], B)
    Implicit
    This member is added by an implicit conversion from AggregationFramework[P] toArrowAssoc[AggregationFramework[P]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.13.0) Use -> instead. If you still wish to display it as one character, consider using a font with programming ligatures such as Fira Code.

Inherited from AggregationPipeline[P]

Inherited from SortAggregation[P]

Inherited from SliceAggregation[P]

Inherited from GroupAggregation[P]

Inherited from ImplicitCommandHelpers[P]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd fromAggregationFramework[P] to any2stringadd[AggregationFramework[P]]

Inherited by implicit conversion StringFormat fromAggregationFramework[P] to StringFormat[AggregationFramework[P]]

Inherited by implicit conversion Ensuring fromAggregationFramework[P] to Ensuring[AggregationFramework[P]]

Inherited by implicit conversion ArrowAssoc fromAggregationFramework[P] to ArrowAssoc[AggregationFramework[P]]

Ungrouped