object BSONAggregationFramework extends AggregationFramework[BSONSerializationPack.type]
- Annotations
- @deprecated
- Deprecated
(Since version 0.16.0) Internal: will be made private
- Alphabetic
- By Inheritance
- BSONAggregationFramework
- AggregationFramework
- AggregationPipeline
- SliceAggregation
- GroupAggregation
- ImplicitCommandHelpers
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
- case class Ascending(field: String) extends SortOrder with Product with Serializable
Ascending sort order
Ascending sort order
- Definition Classes
- AggregationFramework
- case class BucketAuto(groupBy: P.Value, buckets: Int, granularity: Option[String])(output: (String, AggregationFramework.GroupFunction)*) extends PipelineOperator with Product with Serializable
Since MongoDB 3.4 Categorizes incoming documents into a specific number of groups, called buckets, based on a specified expression.
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
$
. https://docs.mongodb.com/manual/reference/operator/aggregation/bucketAuto/- Definition Classes
- AggregationFramework
- final class ChangeStream extends PipelineOperator
Low level pipeline operator which allows to open a tailable cursor against subsequent ChangeEvents of a given collection (since MongoDB 3.6).
Low level pipeline operator which allows to open a tailable cursor against subsequent ChangeEvents of a given collection (since MongoDB 3.6). https://docs.mongodb.com/manual/reference/change-events/
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
- case class Count(outputName: String) extends PipelineOperator with Product with Serializable
_Since MongoDB 3.4:_ Counts of the number of documents input.
_Since MongoDB 3.4:_ Counts of the number of documents input. https://docs.mongodb.com/manual/reference/operator/aggregation/count/
- outputName
the name of the output field which has the count as its value
- Definition Classes
- AggregationFramework
- case class Descending(field: String) extends SortOrder with Product with Serializable
Descending sort order
Descending sort order
- Definition Classes
- AggregationFramework
- 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
- case class GeoNear(near: P.Value, spherical: Boolean = false, limit: Long = 100, minDistance: Option[Long] = None, maxDistance: Option[Long] = None, query: Option[P.Document] = None, distanceMultiplier: Option[Double] = None, uniqueDocs: Boolean = false, distanceField: Option[String] = None, includeLocs: Option[String] = None) extends PipelineOperator with Product with Serializable
Outputs documents in order of nearest to farthest from a specified point.
Outputs documents in order of nearest to farthest from a specified point.
http://docs.mongodb.org/manual/reference/operator/aggregation/geoNear/#pipe._S_geoNear
- near
the point for which to find the closest documents
- spherical
if using a 2dsphere index
- limit
the maximum number of documents to return
- maxDistance
the maximum distance from the center point that the documents can be
- query
limits the results to the matching documents
- distanceMultiplier
the factor to multiply all distances returned by the query
- uniqueDocs
if this value is true, the query returns a matching document once
- distanceField
the output field that contains the calculated distance
- includeLocs
this specifies the output field that identifies the location used to calculate the distance
- Definition Classes
- AggregationFramework
- case class GraphLookup(from: String, startWith: P.Value, connectFromField: String, connectToField: String, as: String, maxDepth: Option[Int] = None, depthField: Option[String] = None, restrictSearchWithMatch: Option[P.Value] = None) extends PipelineOperator with Product with Serializable
_Since MongoDB 3.4:_ The $graphLookup aggregation stage.
_Since MongoDB 3.4:_ The $graphLookup aggregation stage.
- from
the target collection for the $graphLookup operation to search
- startWith
the expression that specifies the value of the
connectFromField
with which to start the recursive search- connectFromField
the field name whose value
$graphLookup
uses to recursively match against theconnectToField
of other documents in the collection- connectToField
the field name in other documents against which to match the value of the field specified by the
connectFromField
parameter- as
the name of the array field added to each output document
- maxDepth
an optional non-negative integral number specifying the maximum recursion depth
- depthField
an optional name for a field to add to each traversed document in the search path
- restrictSearchWithMatch
an optional filter expression
- Definition Classes
- AggregationFramework
- case class Group(identifiers: P.Value)(ops: (String, AggregationFramework.GroupFunction)*) extends PipelineOperator with Product 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
$
. http://docs.mongodb.org/manual/reference/aggregation/group/#_S_group- identifiers
any BSON value acceptable by mongodb as identifier
- ops
the sequence of operators specifying aggregate calculation
- Definition Classes
- AggregationFramework
- case class GroupField(idField: String)(ops: (String, AggregationFramework.GroupFunction)*) extends PipelineOperator with Product 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. http://docs.mongodb.org/manual/reference/aggregation/group/#_S_group
- idField
the name of the field to aggregate on
- ops
the sequence of operators specifying aggregate calculation
- Definition Classes
- AggregationFramework
- case class GroupMulti(idFields: (String, String)*)(ops: (String, AggregationFramework.GroupFunction)*) extends PipelineOperator with Product 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. http://docs.mongodb.org/manual/reference/aggregation/group/#_S_group
- idFields
The fields to aggregate on, and the names they should be aggregated under.
- ops
the sequence of operators specifying aggregate calculation
- Definition Classes
- AggregationFramework
- case class IndexStatAccesses(ops: Long, since: Long) extends Product with Serializable
- ops
the number of operations that used the index
- since
the time from which MongoDB gathered the statistics
- Definition Classes
- AggregationFramework
- case class IndexStatsResult(name: String, key: P.Document, host: String, accesses: IndexStatAccesses) extends Product with Serializable
- name
the index name
- key
the key specification
- host
the hostname and port of the mongod
- accesses
the index statistics
- Definition Classes
- AggregationFramework
- case class Limit(limit: Int) extends PipelineOperator with Product with Serializable
Limits the number of documents that pass through the stream.
Limits the number of documents that pass through the stream. http://docs.mongodb.org/manual/reference/aggregation/limit/#_S_limit
- limit
the number of documents to allow through
- Definition Classes
- AggregationFramework
- case class Lookup(from: String, localField: String, foreignField: String, as: String) extends PipelineOperator with Product with Serializable
_Since MongoDB 3.2:_ 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:_ Performs a left outer join to an unsharded collection in the same database to filter in documents from the "joined" collection for processing. https://docs.mongodb.com/v3.2/reference/operator/aggregation/lookup/#pipe._S_lookup
- from
the collection to perform the join with
- localField
the field from the documents input
- foreignField
the field from the documents in the
from
collection- as
the name of the new array field to add to the input documents
- Definition Classes
- AggregationFramework
- case class Match(predicate: P.Document) extends PipelineOperator with Product 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. http://docs.mongodb.org/manual/reference/aggregation/match/#_S_match
- predicate
the query that documents must satisfy to be in the stream
- Definition Classes
- AggregationFramework
- sealed trait MetadataKeyword extends AnyRef
- Definition Classes
- AggregationFramework
- case class MetadataSort(field: String, keyword: MetadataKeyword) extends SortOrder with Product with Serializable
Metadata sort order.
- 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.mongodb.org/manual/reference/operator/aggregation/out/#pipe._S_out
Takes the documents returned by the aggregation pipeline and writes them to a specified collection http://docs.mongodb.org/manual/reference/operator/aggregation/out/#pipe._S_out
- collection
the name of the output collection
- Definition Classes
- AggregationFramework
- case class Project(specifications: P.Document) extends PipelineOperator with Product 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.
- specifications
The fields to include. The resulting objects will contain only these fields.
- Definition Classes
- AggregationFramework
- 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.
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
- expression
the redact expression
- Definition Classes
- AggregationFramework
- case class ReplaceRoot(newRoot: P.Document) extends PipelineOperator with Product 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
- newRoot
The new root object
- Definition Classes
- AggregationFramework
- case class ReplaceRootField(newRoot: String) extends PipelineOperator with Product 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
- newRoot
The field name to become the new root
- Definition Classes
- AggregationFramework
- case class Sample(size: Int) extends PipelineOperator with Product with Serializable
Randomly selects the specified number of documents from its input.
Randomly selects the specified number of documents from its input. https://docs.mongodb.org/master/reference/operator/aggregation/sample/
- size
the number of documents to return
- Definition Classes
- AggregationFramework
- 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.
Skips over a number of documents before passing all further documents along the stream. http://docs.mongodb.org/manual/reference/aggregation/skip/#_S_skip
- skip
the number of documents to skip
- Definition Classes
- AggregationFramework
- case class Sort(fields: SortOrder*) extends PipelineOperator with Product with Serializable
Sorts the stream based on the given fields.
Sorts the stream based on the given fields. http://docs.mongodb.org/manual/reference/aggregation/sort/#_S_sort
- fields
the fields to sort by
- Definition Classes
- AggregationFramework
- 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
- AggregationFramework
- class Unwind extends PipelineOperator with Product with Serializable
- Definition Classes
- AggregationFramework
- case class UnwindField(field: String) extends Unwind with Product 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
- field
the name of the array to unwind
- Definition Classes
- AggregationFramework
- trait ImplicitlyDocumentProducer extends AnyRef
- Definition Classes
- ImplicitCommandHelpers
- case class AddFieldToSet extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- case class AddFields extends AggregationFramework.PipelineOperator with Product with Serializable
Since MongoDB 3.4
Since MongoDB 3.4
- Definition Classes
- GroupAggregation
- See also
https://docs.mongodb.com/manual/reference/operator/aggregation/addFields/
- case class AddToSet extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- case class Avg extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- case class AvgField extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- case class First extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- case class FirstField extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- 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
- case class Last extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- case class LastField extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- case class Max extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- case class MaxField extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- case class Min extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- case class MinField extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- 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
- case class Push extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- case class PushField extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- 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
- case class StdDevPop extends AggregationFramework.GroupFunction with Product with Serializable
The $stdDevPop group accumulator (since MongoDB 3.2)
The $stdDevPop group accumulator (since MongoDB 3.2)
- Definition Classes
- GroupAggregation
- case class StdDevPopField extends AggregationFramework.GroupFunction with Product with Serializable
The $stdDevPop for a single field (since MongoDB 3.2)
The $stdDevPop for a single field (since MongoDB 3.2)
- Definition Classes
- GroupAggregation
- case class StdDevSamp extends AggregationFramework.GroupFunction with Product with Serializable
The $stdDevSamp group accumulator (since MongoDB 3.2)
The $stdDevSamp group accumulator (since MongoDB 3.2)
- Definition Classes
- GroupAggregation
- case class StdDevSampField extends AggregationFramework.GroupFunction with Product with Serializable
The $stdDevSamp for a single field (since MongoDB 3.2)
The $stdDevSamp for a single field (since MongoDB 3.2)
- Definition Classes
- GroupAggregation
- case class Sum extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
- case class SumField extends AggregationFramework.GroupFunction with Product with Serializable
- Definition Classes
- GroupAggregation
Deprecated Type Members
- 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 (since MongoDB 3.2)
- Definition Classes
- AggregationFramework
- Annotations
- @deprecated
- Deprecated
(Since version 0.12.7) Use
api.collections.Aggregator
- 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
- case class Cursor(batchSize: Int) extends Product with Serializable
- batchSize
the initial batch size for the cursor
- Definition Classes
- AggregationFramework
- Annotations
- @deprecated
- Deprecated
(Since version 0.12.7) Use
api.collections.Aggregator
- 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
- object Filter extends Serializable
Filter companion
Filter companion
- Definition Classes
- AggregationFramework
- object IndexStats extends PipelineOperator with Product with Serializable
Since MongoDB 3.2 https://docs.mongodb.com/manual/reference/operator/aggregation/indexStats/
Since MongoDB 3.2 https://docs.mongodb.com/manual/reference/operator/aggregation/indexStats/
- Definition Classes
- AggregationFramework
- 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
- AggregationFramework
- object Unwind extends Serializable
- Definition Classes
- AggregationFramework
- object ImplicitlyDocumentProducer
- Definition Classes
- ImplicitCommandHelpers
- 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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- lazy val builder: Builder[pack.type]
- Attributes
- protected
- Definition Classes
- AggregationFramework
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- val pack: BSONSerializationPack.type
- Definition Classes
- BSONAggregationFramework → AggregationPipeline → ImplicitCommandHelpers
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- object GroupFunction
Factory to declare custom call to a group function.
Factory to declare custom call to a group function.
- Definition Classes
- GroupAggregation
- 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 } }
PipelineOperator(BSONDocument("$sample" -> BSONDocument("size" -> 2)))
- Definition Classes
- AggregationPipeline
- object Slice
Project(BSONDocument( "name" -> 1, "favorites" -> Slice( array = BSONString(f"$$favorites"), n = BSONInteger(3)).makePipe))
- Definition Classes
- SliceAggregation
- object SumAll extends AggregationFramework.GroupFunction with Product with Serializable
Sum operation of the form
$sum: 1
Sum operation of the form
$sum: 1
- Definition Classes
- GroupAggregation