o

reactivemongo.api.commands.bson

BSONAggregationFramework

object BSONAggregationFramework extends AggregationFramework[BSONSerializationPack.type]

Annotations
@deprecated
Deprecated

(Since version 0.16.0) Internal: will be made private

Linear Supertypes
AggregationFramework[BSONSerializationPack.type], AggregationPipeline[BSONSerializationPack.type], SortAggregation[BSONSerializationPack.type], SliceAggregation[BSONSerializationPack.type], GroupAggregation[BSONSerializationPack.type], ImplicitCommandHelpers[BSONSerializationPack.type], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. BSONAggregationFramework
  2. AggregationFramework
  3. AggregationPipeline
  4. SortAggregation
  5. SliceAggregation
  6. GroupAggregation
  7. ImplicitCommandHelpers
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. class AddFields extends PipelineOperator with Product1[P.Document] with Serializable

    $addFields stage.

    $addFields stage.

    Definition Classes
    AggregationFramework
    Since

    MongoDB 3.4

  2. class Bucket extends PipelineOperator with Product4[P.Value, Seq[P.Value], String, Seq[(String, GroupFunction)]]

    $bucket aggregation stage.

    $bucket aggregation stage.

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

    $bucket aggregation stage.

    $bucket aggregation stage.

    Definition Classes
    AggregationFramework
    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 $.

  4. 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).

    Definition Classes
    AggregationFramework
    Since

    MongoDB 3.6

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

    $collStats aggregation stage.

    $collStats aggregation stage.

    Definition Classes
    AggregationFramework
  6. class Count extends PipelineOperator with Product1[String] with Serializable

    $count of the number of documents input.

    $count of the number of documents input.

    Definition Classes
    AggregationFramework
    Since

    MongoDB 3.4

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

    $currentOp.

    Definition Classes
    AggregationFramework
    Since

    MongoDB 3.6

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

    Definition Classes
    AggregationFramework
    See also

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

  9. class GeoNear extends PipelineOperator with Product with Serializable

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

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

    Definition Classes
    AggregationFramework
  10. 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.

    Definition Classes
    AggregationFramework
    Since

    MongoDB 3.4

  11. 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 $.

    Definition Classes
    AggregationFramework
  12. 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.

    Definition Classes
    AggregationFramework
  13. 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.

    Definition Classes
    AggregationFramework
  14. class IndexStatAccesses extends Product2[Long, Long] with Serializable

    Definition Classes
    AggregationFramework
  15. class IndexStatsResult extends Product4[String, P.Document, String, IndexStatAccesses] with Serializable

    Definition Classes
    AggregationFramework
  16. class Limit extends PipelineOperator with Product1[Int] with Serializable

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

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

    Definition Classes
    AggregationFramework
  17. class ListLocalSessions extends PipelineOperator

    $listLocalSessions aggregation stage.

    $listLocalSessions aggregation stage.

    Definition Classes
    AggregationFramework
    Since

    MongoDB 3.6

  18. class ListSessions extends PipelineOperator

    $listSessions aggregation stage.

    $listSessions aggregation stage.

    Definition Classes
    AggregationFramework
    Since

    MongoDB 3.6

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

    Definition Classes
    AggregationFramework
    Since

    MongoDB 3.2

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

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

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

    Definition Classes
    AggregationFramework
  21. 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.

    Definition Classes
    AggregationFramework
    Since

    MongoDB 4.2

  22. class Out extends PipelineOperator with Product1[String] with Serializable

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

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

    Definition Classes
    AggregationFramework
  23. 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.

    Definition Classes
    AggregationFramework
  24. 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

    Definition Classes
    AggregationFramework
  25. 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

    Definition Classes
    AggregationFramework
  26. 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

    Definition Classes
    AggregationFramework
  27. class ReplaceWith extends PipelineOperator with Product1[P.Document] with Serializable

    The $replaceWith aggregation stage.

    The $replaceWith aggregation stage.

    Definition Classes
    AggregationFramework
    Since

    MongoDB 4.2

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

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

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

    Definition Classes
    AggregationFramework
  29. class Set extends PipelineOperator with Product1[P.Document] with Serializable

    $set aggregation stage

    $set aggregation stage

    Definition Classes
    AggregationFramework
  30. class Skip extends PipelineOperator with Product1[Int] with Serializable

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

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

    Definition Classes
    AggregationFramework
  31. class Sort extends PipelineOperator with Product1[Seq[SortOrder]] with Serializable

    $sorts the stream based on the given fields.

    $sorts the stream based on the given fields.

    Definition Classes
    AggregationFramework
  32. class SortByCount extends PipelineOperator with Product1[P.Value] with Serializable

    The $sortByCount aggregation stage.

    The $sortByCount aggregation stage.

    Definition Classes
    AggregationFramework
    Since

    MongoDB 3.4

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

    The $sortByCount aggregation stage.

    The $sortByCount aggregation stage.

    Definition Classes
    AggregationFramework
    Since

    MongoDB 3.4

  34. class Unset extends PipelineOperator with Product2[String, Seq[String]] with Serializable

    The $unset aggregation stage.

    The $unset aggregation stage.

    Definition Classes
    AggregationFramework
    Since

    MongoDB 4.2

  35. class Unwind extends PipelineOperator with Product with Serializable
    Definition Classes
    AggregationFramework
  36. 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

    Definition Classes
    AggregationFramework
  37. trait ImplicitlyDocumentProducer extends AnyRef
    Definition Classes
    ImplicitCommandHelpers
  38. class AddFieldToSet extends AggregationFramework.GroupFunction with Product1[String] with Serializable

    The $addToSet group accumulator.

    The $addToSet group accumulator.

    Definition Classes
    GroupAggregation
  39. class AddToSet extends AggregationFramework.GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $addToSet group accumulator.

    The $addToSet group accumulator.

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

    Ascending sort order

    Ascending sort order

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

    The $avg group accumulator.

    The $avg group accumulator.

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

    The $avg group accumulator.

    The $avg group accumulator.

    Definition Classes
    GroupAggregation
  43. class Descending extends AggregationFramework.SortOrder with Product1[String] with Serializable

    Descending sort order

    Descending sort order

    Definition Classes
    SortAggregation
  44. class First extends AggregationFramework.GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $field group accumulator.

    The $field group accumulator.

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

    The $field group accumulator.

    The $field group accumulator.

    Definition Classes
    GroupAggregation
  46. 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

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

    The $field group accumulator.

    The $field group accumulator.

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

    The $field group accumulator.

    The $field group accumulator.

    Definition Classes
    GroupAggregation
  49. class Max extends AggregationFramework.GroupFunction

    The $max group accumulator.

    The $max group accumulator.

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

    The $max group accumulator.

    The $max group accumulator.

    Definition Classes
    GroupAggregation
  51. class MergeObjects extends AggregationFramework.GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $mergeObjects group accumulator.

    The $mergeObjects group accumulator.

    Definition Classes
    GroupAggregation
  52. sealed trait MetadataKeyword extends AnyRef

    Keyword of metadata.

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

    Metadata sort order.

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

    The $min group accumulator.

    The $min group accumulator.

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

    The $min group accumulator.

    The $min group accumulator.

    Definition Classes
    GroupAggregation
  56. type Pipeline = (PipelineOperator, List[PipelineOperator])

    Aggregation pipeline (with at least one stage operator)

    Aggregation pipeline (with at least one stage operator)

    Definition Classes
    AggregationPipeline
  57. 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
  58. class Push extends AggregationFramework.GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $push group accumulator.

    The $push group accumulator.

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

    The $push group accumulator.

    The $push group accumulator.

    Definition Classes
    GroupAggregation
  60. final class Slice extends AggregationFramework.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
  61. 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
  62. class StdDevPop extends AggregationFramework.GroupFunction with Product1[GroupAggregation.P.Value] with Serializable

    The $stdDevPop group accumulator.

    The $stdDevPop group accumulator.

    Definition Classes
    GroupAggregation
    Since

    MongoDB 3.2

  63. class StdDevPopField extends AggregationFramework.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

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

    The $stdDevSamp group accumulator

    The $stdDevSamp group accumulator

    Definition Classes
    GroupAggregation
    Since

    MongoDB 3.2

  65. class StdDevSampField extends AggregationFramework.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

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

    The $sum group accumulator.

    The $sum group accumulator.

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

    The $sum group accumulator.

    The $sum group accumulator.

    Definition Classes
    GroupAggregation

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

    Definition Classes
    AggregationFramework
    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

    Definition Classes
    AggregationFramework
    Annotations
    @deprecated
    Deprecated

    (Since version 0.12.7) Use api.collections.Aggregator

    See also

    Cursor

  3. class Cursor extends Product1[Int]

    Definition Classes
    AggregationFramework
    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

    Definition Classes
    AggregationFramework
    Annotations
    @deprecated
    Deprecated

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

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

    (Since version 0.12.0) Use SumAll

Value Members

  1. object AddFields extends AbstractFunction1[P.Document, AddFields] with Serializable
    Definition Classes
    AggregationFramework
  2. object Bucket
    Definition Classes
    AggregationFramework
  3. object BucketAuto extends Serializable
    Definition Classes
    AggregationFramework
  4. object CollStats extends AbstractFunction3[Boolean, Option[Double], Boolean, CollStats] with Serializable
    Definition Classes
    AggregationFramework
  5. object Count extends AbstractFunction1[String, Count] with Serializable
    Definition Classes
    AggregationFramework
  6. object CurrentOp extends AbstractFunction5[Boolean, Boolean, Boolean, Boolean, Boolean, CurrentOp]
    Definition Classes
    AggregationFramework
  7. object Cursor extends AbstractFunction1[Int, Cursor]
    Definition Classes
    AggregationFramework
  8. object Facet extends AbstractFunction1[Iterable[(String, Pipeline)], Facet] with Serializable
    Definition Classes
    AggregationFramework
  9. object Filter extends Serializable

    Filter companion

    Filter companion

    Definition Classes
    AggregationFramework
  10. object GeoNear extends Serializable
    Definition Classes
    AggregationFramework
  11. object GraphLookup extends AbstractFunction8[String, P.Value, String, String, String, Option[Int], Option[String], Option[P.Value], GraphLookup] with Serializable
    Definition Classes
    AggregationFramework
  12. object Group extends Serializable
    Definition Classes
    AggregationFramework
  13. object GroupField extends Serializable
    Definition Classes
    AggregationFramework
  14. object GroupMulti extends Serializable
    Definition Classes
    AggregationFramework
  15. object IndexStatAccesses extends AbstractFunction2[Long, Long, IndexStatAccesses] with Serializable
    Definition Classes
    AggregationFramework
  16. object IndexStats extends PipelineOperator with Product with Serializable

    $indexStats aggregation stage.

    $indexStats aggregation stage.

    Definition Classes
    AggregationFramework
    Since

    MongoDB 3.2

  17. object IndexStatsResult extends AbstractFunction4[String, P.Document, String, IndexStatAccesses, IndexStatsResult] with Serializable
    Definition Classes
    AggregationFramework
  18. object Limit extends AbstractFunction1[Int, Limit] with Serializable
    Definition Classes
    AggregationFramework
  19. object ListLocalSessions extends AbstractFunction1[P.Document, ListLocalSessions]
    Definition Classes
    AggregationFramework
  20. object ListSessions extends AbstractFunction1[P.Document, ListSessions]
    Definition Classes
    AggregationFramework
  21. object Lookup extends AbstractFunction4[String, String, String, String, Lookup] with Serializable
    Definition Classes
    AggregationFramework
  22. object Match extends AbstractFunction1[P.Document, Match] with Serializable
    Definition Classes
    AggregationFramework
  23. object Merge extends AbstractFunction6[String, String, Seq[String], Option[String], Option[P.Document], Option[String], Merge] with Serializable
    Definition Classes
    AggregationFramework
  24. object Out extends AbstractFunction1[String, Out] with Serializable
    Definition Classes
    AggregationFramework
  25. object PlanCacheStats extends PipelineOperator with Product with Serializable

    $planCacheStats aggregation stage.

    $planCacheStats aggregation stage.

    Definition Classes
    AggregationFramework
    Since

    MongoDB 4.2

  26. object Project extends AbstractFunction1[P.Document, Project] with Serializable
    Definition Classes
    AggregationFramework
  27. object Redact extends AbstractFunction1[P.Document, Redact] with Serializable
    Definition Classes
    AggregationFramework
  28. object ReplaceRoot extends AbstractFunction1[P.Document, ReplaceRoot] with Serializable
    Definition Classes
    AggregationFramework
  29. object ReplaceRootField extends AbstractFunction1[String, ReplaceRootField] with Serializable
    Definition Classes
    AggregationFramework
  30. object ReplaceWith extends AbstractFunction1[P.Document, ReplaceWith] with Serializable
    Definition Classes
    AggregationFramework
  31. object Sample extends AbstractFunction1[Int, Sample] with Serializable
    Definition Classes
    AggregationFramework
  32. object Set extends AbstractFunction1[P.Document, Set] with Serializable
    Definition Classes
    AggregationFramework
  33. object Skip extends AbstractFunction1[Int, Skip] with Serializable
    Definition Classes
    AggregationFramework
  34. object Sort extends Serializable
    Definition Classes
    AggregationFramework
  35. object SortByCount extends AbstractFunction1[P.Value, SortByCount] with Serializable
    Definition Classes
    AggregationFramework
  36. object SortByFieldCount extends AbstractFunction1[String, SortByFieldCount] with Serializable
    Definition Classes
    AggregationFramework
  37. object Unset extends AbstractFunction2[String, Seq[String], Unset] with Serializable
    Definition Classes
    AggregationFramework
  38. object Unwind extends Serializable
    Definition Classes
    AggregationFramework
  39. object UnwindField extends AbstractFunction1[String, UnwindField] with Serializable
    Definition Classes
    AggregationFramework
  40. object ImplicitlyDocumentProducer
    Definition Classes
    ImplicitCommandHelpers
  41. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  42. final def ##(): Int
    Definition Classes
    AnyRef → Any
  43. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  44. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  45. final lazy val builder: Builder[pack.type]
    Attributes
    protected
    Definition Classes
    AggregationFramework
  46. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  47. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  48. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  49. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  50. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  51. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  52. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  53. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  54. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  55. val pack: BSONSerializationPack.type
    Definition Classes
    BSONAggregationFramework → AggregationPipeline → ImplicitCommandHelpers
  56. final def pipe(name: String, arg: Value): Document
    Attributes
    protected
    Definition Classes
    AggregationFramework
    Annotations
    @inline()
  57. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  58. def toString(): String
    Definition Classes
    AnyRef → Any
  59. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  61. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  62. object AddFieldToSet extends AbstractFunction1[String, AggregationFramework.AddFieldToSet] with Serializable
    Definition Classes
    GroupAggregation
  63. object AddToSet extends AbstractFunction1[GroupAggregation.P.Value, AggregationFramework.AddToSet] with Serializable
    Definition Classes
    GroupAggregation
  64. object Ascending extends AbstractFunction1[String, AggregationFramework.Ascending] with Serializable
    Definition Classes
    SortAggregation
  65. object Avg extends AbstractFunction1[GroupAggregation.P.Value, AggregationFramework.Avg] with Serializable
    Definition Classes
    GroupAggregation
  66. object AvgField extends AbstractFunction1[String, AggregationFramework.AvgField] with Serializable
    Definition Classes
    GroupAggregation
  67. object Descending extends AbstractFunction1[String, AggregationFramework.Descending] with Serializable
    Definition Classes
    SortAggregation
  68. object First extends AbstractFunction1[GroupAggregation.P.Value, AggregationFramework.First] with Serializable
    Definition Classes
    GroupAggregation
  69. object FirstField extends AbstractFunction1[String, AggregationFramework.FirstField] with Serializable
    Definition Classes
    GroupAggregation
  70. object GroupFunction

    Factory to declare custom call to a group function.

    Factory to declare custom call to a group function.

    Definition Classes
    GroupAggregation
  71. object Last extends AbstractFunction1[GroupAggregation.P.Value, AggregationFramework.Last] with Serializable
    Definition Classes
    GroupAggregation
  72. object LastField extends AbstractFunction1[String, AggregationFramework.LastField] with Serializable
    Definition Classes
    GroupAggregation
  73. object Max extends AbstractFunction1[GroupAggregation.P.Value, AggregationFramework.Max]
    Definition Classes
    GroupAggregation
  74. object MaxField extends AbstractFunction1[String, AggregationFramework.MaxField] with Serializable
    Definition Classes
    GroupAggregation
  75. object MergeObjects extends AbstractFunction1[GroupAggregation.P.Value, AggregationFramework.MergeObjects] with Serializable
    Definition Classes
    GroupAggregation
  76. object MetadataSort extends AbstractFunction2[String, AggregationFramework.MetadataKeyword, AggregationFramework.MetadataSort] with Serializable
    Definition Classes
    SortAggregation
  77. object Min extends AbstractFunction1[GroupAggregation.P.Value, AggregationFramework.Min] with Serializable
    Definition Classes
    GroupAggregation
  78. object MinField extends AbstractFunction1[String, AggregationFramework.MinField] with Serializable
    Definition Classes
    GroupAggregation
  79. 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
  80. object Push extends AbstractFunction1[GroupAggregation.P.Value, AggregationFramework.Push] with Serializable
    Definition Classes
    GroupAggregation
  81. object PushField extends AbstractFunction1[String, AggregationFramework.PushField] with Serializable
    Definition Classes
    GroupAggregation
  82. 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
  83. object StdDevPop extends AbstractFunction1[GroupAggregation.P.Value, AggregationFramework.StdDevPop] with Serializable
    Definition Classes
    GroupAggregation
  84. object StdDevPopField extends AbstractFunction1[String, AggregationFramework.StdDevPopField] with Serializable
    Definition Classes
    GroupAggregation
  85. object StdDevSamp extends AbstractFunction1[GroupAggregation.P.Value, AggregationFramework.StdDevSamp] with Serializable
    Definition Classes
    GroupAggregation
  86. object StdDevSampField extends AbstractFunction1[String, AggregationFramework.StdDevSampField] with Serializable
    Definition Classes
    GroupAggregation
  87. object Sum extends AbstractFunction1[GroupAggregation.P.Value, AggregationFramework.Sum] with Serializable
    Definition Classes
    GroupAggregation
  88. object SumAll extends AggregationFramework.GroupFunction with Product with Serializable

    The $sum: 1 group accumulator.

    The $sum: 1 group accumulator.

    Definition Classes
    GroupAggregation
  89. object SumField extends AbstractFunction1[String, AggregationFramework.SumField] with Serializable
    Definition Classes
    GroupAggregation
  90. object TextScore extends AggregationFramework.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

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.

Inherited from AggregationPipeline[BSONSerializationPack.type]

Inherited from SortAggregation[BSONSerializationPack.type]

Inherited from SliceAggregation[BSONSerializationPack.type]

Inherited from GroupAggregation[BSONSerializationPack.type]

Inherited from AnyRef

Inherited from Any

Ungrouped