Packages

trait Aggregate extends AsJava

Linear Supertypes
AsJava, AsJavaConverters, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Aggregate
  2. AsJava
  3. AsJavaConverters
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

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

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

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

  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

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

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

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

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

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

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

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

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

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

  14. 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/

  15. 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/

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

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

  18. 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/

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

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

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

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

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def asJava[K, V](m: Map[K, V]): ConcurrentMap[K, V]
    Definition Classes
    AsJava
  6. def asJava[K, V](m: Map[K, V]): Map[K, V]
    Definition Classes
    AsJava
  7. def asJava[K, V](m: Map[K, V]): Map[K, V]
    Definition Classes
    AsJava
  8. def asJava[A](s: Set[A]): Set[A]
    Definition Classes
    AsJava
  9. def asJava[A](s: Set[A]): Set[A]
    Definition Classes
    AsJava
  10. def asJava[A](s: Seq[A]): List[A]
    Definition Classes
    AsJava
  11. def asJava[A](s: Seq[A]): List[A]
    Definition Classes
    AsJava
  12. def asJava[A](b: Buffer[A]): List[A]
    Definition Classes
    AsJava
  13. def asJava[A](i: Iterable[A]): Iterable[A]
    Definition Classes
    AsJava
  14. def asJava[A](i: Iterator[A]): Iterator[A]
    Definition Classes
    AsJava
  15. def asJavaCollection[A](i: Iterable[A]): Collection[A]
    Definition Classes
    AsJavaConverters
  16. def asJavaDictionary[A, B](m: Map[A, B]): Dictionary[A, B]
    Definition Classes
    AsJavaConverters
  17. def asJavaEnumeration[A](i: Iterator[A]): Enumeration[A]
    Definition Classes
    AsJavaConverters
  18. def asJavaIterable[A](i: Iterable[A]): Iterable[A]
    Definition Classes
    AsJavaConverters
  19. def asJavaIterator[A](i: Iterator[A]): Iterator[A]
    Definition Classes
    AsJavaConverters
  20. def bufferAsJavaList[A](b: Buffer[A]): List[A]
    Definition Classes
    AsJavaConverters
  21. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  22. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  24. def facet(facets: Facet*): Aggregate
  25. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def mapAsJavaConcurrentMap[A, B](m: Map[A, B]): ConcurrentMap[A, B]
    Definition Classes
    AsJavaConverters
  29. def mapAsJavaMap[A, B](m: Map[A, B]): Map[A, B]
    Definition Classes
    AsJavaConverters
  30. def mutableMapAsJavaMap[A, B](m: Map[A, B]): Map[A, B]
    Definition Classes
    AsJavaConverters
  31. def mutableSeqAsJavaList[A](s: Seq[A]): List[A]
    Definition Classes
    AsJavaConverters
  32. def mutableSetAsJavaSet[A](s: Set[A]): Set[A]
    Definition Classes
    AsJavaConverters
  33. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  34. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  35. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  36. def seqAsJavaList[A](s: Seq[A]): List[A]
    Definition Classes
    AsJavaConverters
  37. def setAsJavaSet[A](s: Set[A]): Set[A]
    Definition Classes
    AsJavaConverters
  38. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  39. def toString(): String
    Definition Classes
    AnyRef → Any
  40. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  41. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  42. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from AsJava

Inherited from AsJavaConverters

Inherited from AnyRef

Inherited from Any

Ungrouped