trait Aggregate extends AsJava
- Alphabetic
- By Inheritance
- Aggregate
- AsJava
- AsJavaConverters
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def bucketAuto[TExpression](groupBy: TExpression, buckets: Int, options: BucketAutoOptions = new BucketAutoOptions()): Aggregate
Creates a $bucketAuto pipeline stage
Creates a $bucketAuto pipeline stage
- groupBy
the criteria to group By
- buckets
the number of the buckets
- options
the optional values for the $bucketAuto stage
- returns
the $bucketAuto pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/bucketAuto/
- Since
3.4
- abstract def combinedWith(anotherAggregate: Aggregate): Aggregate
Merges 2 aggregation pipelines together.
Merges 2 aggregation pipelines together.
- anotherAggregate
the aggregate to be merged with
- returns
the aggregate pipeline
- abstract def count(field: String): Aggregate
Creates a $count pipeline stage using the named field to store the result
Creates a $count pipeline stage using the named field to store the result
- field
the field in which to store the count
- returns
the $count pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/count/
- Since
3.4
- abstract def count: Aggregate
Creates a $count pipeline stage using the field name "count" to store the result
Creates a $count pipeline stage using the field name "count" to store the result
- returns
the $count pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/count/
- Since
3.4
- abstract def facet(facets: List[Facet]): Aggregate
Creates a facet pipeline stage
Creates a facet pipeline stage
- facets
the facets to use
- returns
the $facets pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/facet/
- Since
3.4
- abstract def graphLookup[TExpression](from: String, startWith: TExpression, connectFromField: String, connectToField: String, as: String, options: GraphLookupOptions = new GraphLookupOptions()): Aggregate
Creates a graphLookup pipeline stage for the specified filter
Creates a graphLookup pipeline stage for the specified filter
- from
the collection to query
- startWith
the expression to start the graph lookup with
- connectFromField
the from field
- connectToField
the to field
- as
name of field in output document
- options
optional values for the graphLookup
- returns
the $graphLookup pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/graphLookup/
- Since
3.4
- abstract def group[TExpression](id: TExpression, fieldAccumulators: Accumulator): Aggregate
Creates a $group pipeline stage for the specified filter
Creates a $group pipeline stage for the specified filter
- id
the id expression for the group
- fieldAccumulators
zero or more field accumulator pairs
- returns
the $group pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/group/
- abstract def limit(n: Int): Aggregate
Creates a $limit pipeline stage for the specified filter
Creates a $limit pipeline stage for the specified filter
- n
the limit
- returns
the $limit pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/limi/
- abstract def lookup(from: String, pipeline: Aggregate, as: String): Aggregate
Creates a $lookup pipeline stage, joining the current collection with the one specified in from using the given pipeline
Creates a $lookup pipeline stage, joining the current collection with the one specified in from using the given pipeline
- from
the name of the collection in the same database to perform the join with.
- pipeline
the pipeline to run on the joined collection.
- as
the name of the new array field to add to the input documents.
- returns
the $lookup pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/lookup/
- Since
3.7
- abstract def lookup(from: String, localField: String, foreignField: String, as: String): Aggregate
Creates a $lookup pipeline stage, joining the current collection with the one specified in from using equality match between the local field and the foreign field
Creates a $lookup pipeline stage, joining the current collection with the one specified in from using equality match between the local field and the foreign field
- from
the name of the collection in the same database to perform the join with.
- localField
the field from the local collection to match values against.
- foreignField
the field in the from collection to match values against.
- as
the name of the new array field to add to the input documents.
- returns
the $lookup pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/lookup/
- Since
3.2
- abstract def matchBy(filter: Filter): Aggregate
Creates a $match pipeline stage for the specified filter
Creates a $match pipeline stage for the specified filter
- filter
the filter to match
- returns
the $match pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/match/
- abstract def merge(collectionName: String, options: MergeOptions = new MergeOptions()): Aggregate
Creates a $merge pipeline stage that merges into the specified collection using the specified options.
Creates a $merge pipeline stage that merges into the specified collection using the specified options.
- collectionName
the name of the collection to merge into
- options
the merge options
- returns
the $merge pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/merge/
- Since
3.11
- abstract def out(databaseName: String, collectionName: String): Aggregate
Creates a $out pipeline stage that supports outputting to a different database.
Creates a $out pipeline stage that supports outputting to a different database.
- databaseName
the database name
- collectionName
the collection name
- returns
the $out pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/out/
- Since
4.1
- abstract def out(collectionName: String): Aggregate
Creates a $out pipeline stage that writes into the specified collection
Creates a $out pipeline stage that writes into the specified collection
- collectionName
the collection name
- returns
the $out pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/out/
- abstract def project(projection: Projection): Aggregate
Creates a $project pipeline stage for the specified projection
Creates a $project pipeline stage for the specified projection
- projection
the projection
- returns
the $project pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/project/
- abstract def replaceWith[TExpression](value: TExpression): Aggregate
Creates a $replaceRoot pipeline stage
Creates a $replaceRoot pipeline stage
With $replaceWith, you can promote an embedded document to the top-level. You can also specify a new document as the replacement.
- value
the new root value
- returns
the $replaceRoot pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/replaceWith/
- Since
3.11
- abstract def sample(size: Int): Aggregate
Creates a $sample pipeline stage with the specified sample size
Creates a $sample pipeline stage with the specified sample size
- size
the sample size
- returns
the $sample pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/sample/
- Since
3.2
- abstract def skip(n: Int): Aggregate
Creates a $skip pipeline stage
Creates a $skip pipeline stage
- n
the number of documents to skip
- returns
the $skip pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/skip/
- abstract def sort(sort: Sort): Aggregate
Creates a $sort pipeline stage for the specified sort specification
Creates a $sort pipeline stage for the specified sort specification
- sort
the sort specification
- returns
the $sort pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/sort/
- abstract def sortByCount[TExpression](filter: TExpression): Aggregate
Creates a $sortByCount pipeline stage for the specified filter
Creates a $sortByCount pipeline stage for the specified filter
- filter
the filter specification
- returns
the $sortByCount pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/sortByCount/
- Since
3.4
- abstract def unionWith(collection: String, pipeline: Aggregate): Aggregate
Creates a $unionWith pipeline stage.
Creates a $unionWith pipeline stage.
- collection
the name of the collection in the same database to perform the union with.
- pipeline
the pipeline to run on the union.
- returns
the $unionWith pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/unionWith/
- Since
4.1
- abstract def unwind(fieldName: String, unwindOptions: UnwindOptions = new UnwindOptions()): Aggregate
Creates a $unwind pipeline stage for the specified field name, which must be prefixed by a '$' sign.
Creates a $unwind pipeline stage for the specified field name, which must be prefixed by a '$' sign.
- fieldName
the field name, prefixed by a '$' sign
- unwindOptions
options for the unwind pipeline stage
- returns
the $unwind pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/unwind/
- Since
3.2
Concrete Value Members
- 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
- def asJava[K, V](m: Map[K, V]): ConcurrentMap[K, V]
- Definition Classes
- AsJavaConverters
- def asJava[K, V](m: Map[K, V]): Map[K, V]
- Definition Classes
- AsJavaConverters
- def asJava[K, V](m: Map[K, V]): Map[K, V]
- Definition Classes
- AsJavaConverters
- def asJava[A](s: Set[A]): Set[A]
- Definition Classes
- AsJavaConverters
- def asJava[A](s: Set[A]): Set[A]
- Definition Classes
- AsJavaConverters
- def asJava[A](s: Seq[A]): List[A]
- Definition Classes
- AsJavaConverters
- def asJava[A](s: Seq[A]): List[A]
- Definition Classes
- AsJavaConverters
- def asJava[A](b: Buffer[A]): List[A]
- Definition Classes
- AsJavaConverters
- def asJava[A](i: Iterable[A]): Iterable[A]
- Definition Classes
- AsJavaConverters
- def asJava[A](i: Iterator[A]): Iterator[A]
- Definition Classes
- AsJavaConverters
- def asJavaCollection[A](i: Iterable[A]): Collection[A]
- Definition Classes
- AsJavaConverters
- def asJavaDictionary[K, V](m: Map[K, V]): Dictionary[K, V]
- Definition Classes
- AsJavaConverters
- def asJavaEnumeration[A](i: Iterator[A]): Enumeration[A]
- Definition Classes
- AsJavaConverters
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def facet(facets: Facet*): Aggregate
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @IntrinsicCandidate() @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
- @IntrinsicCandidate() @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @IntrinsicCandidate() @native()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
Deprecated Value Members
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable]) @Deprecated
- Deprecated
(Since version 9)