object Aggregates
- Alphabetic
- By Inheritance
- Aggregates
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
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
- def addFields(fields: Field[_]*): Bson
Creates an $addFields pipeline stage
Creates an $addFields pipeline stage
- fields
the fields to add
- returns
the $addFields pipeline stage
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
- See also
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def bucket[TExpression, TBoundary](groupBy: TExpression, options: BucketOptions, boundaries: TBoundary*): Bson
Creates a $bucket pipeline stage
Creates a $bucket pipeline stage
- TExpression
the groupBy expression type
- TBoundary
the boundary type
- groupBy
the criteria to group By
- options
the optional values for the $bucket stage
- boundaries
the boundaries of the buckets
- returns
the $bucket pipeline stage
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
- See also
- def bucket[TExpression, TBoundary](groupBy: TExpression, boundaries: TBoundary*): Bson
Creates a $bucket pipeline stage
Creates a $bucket pipeline stage
- TExpression
the groupBy expression type
- TBoundary
the boundary type
- groupBy
the criteria to group By
- boundaries
the boundaries of the buckets
- returns
the $bucket pipeline stage
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
- See also
- def bucketAuto[TExpression, TBoundary](groupBy: TExpression, buckets: Int, options: BucketAutoOptions): Bson
Creates a $bucketAuto pipeline stage
Creates a $bucketAuto pipeline stage
- TExpression
the groupBy expression type
- 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
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
- See also
- def bucketAuto[TExpression, TBoundary](groupBy: TExpression, buckets: Int): Bson
Creates a $bucketAuto pipeline stage
Creates a $bucketAuto pipeline stage
- TExpression
the groupBy expression type
- groupBy
the criteria to group By
- buckets
the number of the buckets
- returns
the $bucketAuto pipeline stage
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
- See also
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- def count(field: String): Bson
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
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
- See also
- def count(): Bson
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
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
- See also
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def facet(facets: Facet*): Bson
Creates a $facet pipeline stage
Creates a $facet pipeline stage
- facets
the facets to use
- returns
the new pipeline stage
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
- See also
- def filter(filter: Bson): Bson
Creates a
$matchpipeline stage for the specified filterCreates a
$matchpipeline stage for the specified filterA friendly alias for the
matchmethod.- filter
the filter to match against
- returns
the
$matchpipeline stage
- See also
Filters
- def finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def graphLookup[TExpression](from: String, startWith: TExpression, connectFromField: String, connectToField: String, as: String, options: GraphLookupOptions): Bson
Creates a graphLookup pipeline stage for the specified filter
Creates a graphLookup pipeline stage for the specified filter
- TExpression
the expression type
- 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
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
- See also
- def graphLookup[TExpression](from: String, startWith: TExpression, connectFromField: String, connectToField: String, as: String): Bson
Creates a $graphLookup pipeline stage for the specified filter
Creates a $graphLookup pipeline stage for the specified filter
- TExpression
the expression type
- 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
- returns
the $graphLookup pipeline stage
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
- See also
- def group[TExpression](id: TExpression, fieldAccumulators: BsonField*): Bson
Creates a
$grouppipeline stage for the specified filterCreates a
$grouppipeline stage for the specified filter- TExpression
the expression type
- id
the id expression for the group
- fieldAccumulators
zero or more field accumulator pairs
- returns
the
$grouppipeline stage
- See also
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def limit(limit: Int): Bson
Creates a
$limitpipeline stage for the specified filterCreates a
$limitpipeline stage for the specified filter- limit
the limit
- returns
the
$limitpipeline stage
- See also
- def lookup[T](from: String, let: Seq[Variable[T]], pipeline: Seq[_ <: Bson], as: String): Bson
Creates a
$lookuppipeline stage, joining the current collection with the one specified in from using the given pipelineCreates a
$lookuppipeline 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.
- let
the variables to use in the pipeline field stages.
- 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
$lookuppipeline stage
- Since
2.3
- Note
Requires MongoDB 3.6 or greater
- See also
- def lookup(from: String, pipeline: Seq[_ <: Bson], as: String): Bson
Creates a
$lookuppipeline stage, joining the current collection with the one specified in from using the given pipelineCreates a
$lookuppipeline 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
$lookuppipeline stage:
- Since
2.3
- Note
Requires MongoDB 3.6 or greater
- See also
- def lookup(from: String, localField: String, foreignField: String, as: String): Bson
Creates a
$lookuppipeline stage for the specified filterCreates a
$lookuppipeline stage for the specified filter- from
the name of the collection in the same database to perform the join with.
- localField
specifies the field from the local collection to match values against.
- foreignField
specifies 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
$lookuppipeline stage
- Since
1.1
- Note
Requires MongoDB 3.2 or greater
- See also
- def match(filter: Bson): Bson
Creates a
$matchpipeline stage for the specified filterCreates a
$matchpipeline stage for the specified filter- filter
the filter to match
- returns
the
$matchpipeline stage
- See also
Filters
- def merge(namespace: MongoNamespace, mergeOptions: MergeOptions): Bson
Creates a
$mergepipeline stage that merges into the specified collection using the specified options.Creates a
$mergepipeline stage that merges into the specified collection using the specified options.- namespace
the namespace to merge into
- mergeOptions
the mergeOptions
- returns
the
$mergepipeline stage
- def merge(namespace: MongoNamespace): Bson
Creates a
$mergepipeline stage that merges into the specified collection using the specified options.Creates a
$mergepipeline stage that merges into the specified collection using the specified options.- namespace
the namespace to merge into
- returns
the
$mergepipeline stage
- def merge(collectionName: String, mergeOptions: MergeOptions): Bson
Creates a
$mergepipeline stage that merges into the specified collection using the specified options.Creates a
$mergepipeline stage that merges into the specified collection using the specified options.- collectionName
the name of the collection to merge into
- mergeOptions
the mergeOptions
- returns
the
$mergepipeline stage
- def merge(collectionName: String): Bson
Creates a
$mergepipeline stage that merges into the specified collection using the specified options.Creates a
$mergepipeline stage that merges into the specified collection using the specified options.- collectionName
the name of the collection to merge into
- returns
the
$mergepipeline stage
- 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()
- def out(collectionName: String): Bson
Creates a
$outpipeline stage that writes to the collection with the specified nameCreates a
$outpipeline stage that writes to the collection with the specified name- collectionName
the collection name
- returns
the
$outpipeline stage
- See also
- def project(projection: Bson): Bson
Creates a
$projectpipeline stage for the specified projectionCreates a
$projectpipeline stage for the specified projection- projection
the projection
- returns
the
$projectpipeline stage
- See also
Projections
- def replaceRoot[TExpression](value: TExpression): Bson
Creates a $replaceRoot pipeline stage
Creates a $replaceRoot pipeline stage
- TExpression
the new root type
- value
the new root value
- returns
the $replaceRoot pipeline stage
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
- See also
- def replaceWith[TExpression](value: TExpression): Bson
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.
The $replaceWith is an alias for replaceRoot.
- TExpression
the new root type
- value
the new root value
- returns
the $replaceRoot pipeline stage
- Since
2.7
- See also
- def sample(size: Int): Bson
Creates a
$samplepipeline stage with the specified sample sizeCreates a
$samplepipeline stage with the specified sample size- size
the sample size
- returns
the
$samplepipeline stage
- Since
1.1
- See also
- def skip(skip: Int): Bson
Creates a
$skippipeline stageCreates a
$skippipeline stage- skip
the number of documents to skip
- returns
the
$skippipeline stage
- def sort(sort: Bson): Bson
Creates a
$sortpipeline stage for the specified sort specificationCreates a
$sortpipeline stage for the specified sort specification- sort
the sort specification
- returns
the
$sortpipeline stage
- See also
Sorts
- def sortByCount[TExpression](filter: TExpression): Bson
Creates a $sortByCount pipeline stage for the specified filter
Creates a $sortByCount pipeline stage for the specified filter
- TExpression
the expression type
- filter
the filter specification
- returns
the $sortByCount pipeline stage
- Since
1.2
- Note
Requires MongoDB 3.4 or greater
- See also
Sorts
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unwind(fieldName: String, unwindOptions: UnwindOptions): Bson
Creates a
$unwindpipeline stage for the specified field name, which must be prefixed by a$sign.Creates a
$unwindpipeline stage for the specified field name, which must be prefixed by a$sign.- fieldName
the field name, prefixed by a
$sign- returns
the
$unwindpipeline stage
- Since
1.1
- See also
- def unwind(fieldName: String): Bson
Creates a
$unwindpipeline stage for the specified field name, which must be prefixed by a$sign.Creates a
$unwindpipeline stage for the specified field name, which must be prefixed by a$sign.- fieldName
the field name, prefixed by a
$sign- returns
the
$unwindpipeline stage
- See also
- 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()
This is the documentation for the MongoDB Scala driver.
Driver structure
The mongodb scala driver.
To get started you need a MongoClient instance, either from a connection string or via a org.mongodb.scala.MongoClientSettings.
Notable packages include: