Attributes
Members list
Value members
Constructors
Concrete methods
Creates a $addFields pipeline stage. With $addFields you can add new fields the document.
Creates a $addFields pipeline stage. With $addFields you can add new fields the document.
Value parameters
- name
-
the name of the new field
- value
-
the value of the new field
Attributes
- Returns
-
Aggregate with $addFields pipeline stage https://www.mongodb.com/docs/manual/reference/operator/aggregation/addFields/
Creates a $bucket pipeline stage
Creates a $bucket pipeline stage
Value parameters
- boundaries
-
the boundaries of the buckets
- groupBy
-
the criteria to group By
- options
-
the optional values for the $bucket stage
Attributes
- Returns
-
Aggregate $bucket pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/bucket/
Creates a $bucketAuto pipeline stage.
Creates a $bucketAuto pipeline stage.
Value parameters
- buckets
-
the number of the buckets
- groupBy
-
the criteria to group By
- options
-
the optional values for the $bucketAuto stage
Attributes
- Returns
-
Aggregate with $bucketAuto pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/bucketAuto/
Merges 2 aggregation pipelines together.
Merges 2 aggregation pipelines together.
Value parameters
- anotherAggregate
-
the aggregate to be merged with
Attributes
- Returns
-
the aggregate pipeline
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.
Attributes
- Returns
-
Aggregate with $count pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/count/
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.
Value parameters
- field
-
the field in which to store the count
Attributes
- Returns
-
Aggregate with $count pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/count/
Creates a $densify pipeline stage, which adds documents to a sequence of documents where certain values in the field are missing.
Creates a $densify pipeline stage, which adds documents to a sequence of documents where certain values in the field are missing.
Value parameters
- field
-
The field to densify.
- options
-
The densify options.
- range
-
The range.
Attributes
- Returns
-
Aggregate with requested pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/densify/
Compares the receiver object (this) with the argument object (that) for equivalence.
Compares the receiver object (this) with the argument object (that) for equivalence.
Any implementation of this method should be an equivalence relation:
- It is reflexive: for any instance
xof typeAny,x.equals(x)should returntrue. - It is symmetric: for any instances
xandyof typeAny,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any instances
x,y, andzof typeAnyifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).
Value parameters
- that
-
the object to compare against this object for equality.
Attributes
- Returns
-
trueif the receiver object is equivalent to the argument;falseotherwise. - Definition Classes
-
Any
Creates a facet pipeline stage.
Creates a facet pipeline stage.
Value parameters
- facets
-
the facets to use
Attributes
- Returns
-
Aggregate with $facets pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/facet/
Creates a $fill pipeline stage, which assigns values to fields when they are Null or missing.
Creates a $fill pipeline stage, which assigns values to fields when they are Null or missing.
Value parameters
- options
-
The fill options.
- outputs
-
The FillOutputField.
Attributes
- Returns
-
Aggregate with requested pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/fill/
Creates a $geoNear pipeline stage that outputs documents in order of nearest to farthest from a specified point.
Creates a $geoNear pipeline stage that outputs documents in order of nearest to farthest from a specified point.
Value parameters
- distanceField
-
The output field that contains the calculated distance. To specify a field within an embedded document, use dot notation.
- options
-
GeoNearOptions
- point
-
The point for which to find the closest documents.
Attributes
- Returns
-
Aggregate with requested pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/geoNear/
Creates a graphLookup pipeline stage for the specified filter.
Creates a graphLookup pipeline stage for the specified filter.
Value parameters
- as
-
name of field in output document
- connectFromField
-
the from field
- connectToField
-
the to field
- from
-
the collection to query
- options
-
optional values for the graphLookup
- startWith
-
the expression to start the graph lookup with
Attributes
- Returns
-
Aggregate with $graphLookup pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/graphLookup/
Creates a $group pipeline stage for the specified filter.
Creates a $group pipeline stage for the specified filter.
Value parameters
- fieldAccumulators
-
zero or more field accumulator pairs
- id
-
the id expression for the group
Attributes
- Returns
-
Aggregate with $group pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/group/
Calculates a hash code value for the object.
Calculates a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
Attributes
- Returns
-
the hash code value for this object.
- Definition Classes
-
Any
Creates a $limit pipeline stage for the specified filter
Creates a $limit pipeline stage for the specified filter
Value parameters
- n
-
the limit
Attributes
- Returns
-
Aggregate with $limit pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/limi/
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.
Value parameters
- as
-
the name of the new array field to add to the input documents.
- foreignField
-
the field in the from collection to match values against.
- 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.
Attributes
- Returns
-
Aggregate with $lookup pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/lookup/
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.
Value parameters
- as
-
the name of the new array field to add to the input documents.
- from
-
the name of the collection in the same database to perform the join with.
- pipeline
-
the pipeline to run on the joined collection.
Attributes
- Returns
-
Aggregate with $lookup pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/lookup/
Creates a $match pipeline stage for the specified filter.
Creates a $match pipeline stage for the specified filter.
Value parameters
- filter
-
the filter to match
Attributes
- Returns
-
Aggregate with $match pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/match/
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.
Value parameters
- collectionName
-
the name of the collection to merge into
- options
-
the merge options
Attributes
- Returns
-
Aggregate with $merge pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/merge/
Creates a $out pipeline stage that writes into the specified collection
Creates a $out pipeline stage that writes into the specified collection
Value parameters
- collectionName
-
the collection name
Attributes
- Returns
-
Aggregate with $out pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/out/
Creates a $out pipeline stage that supports outputting to a different database.
Creates a $out pipeline stage that supports outputting to a different database.
Value parameters
- collectionName
-
the collection name
- databaseName
-
the database name
Attributes
- Returns
-
Aggregate with $out pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/out/
Creates a $project pipeline stage for the specified projection.
Creates a $project pipeline stage for the specified projection.
Value parameters
- projection
-
the projection
Attributes
- Returns
-
Aggregate with $project pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/project/
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.
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 parameters
- value
-
the new root value
Attributes
- Returns
-
Aggregate with $replaceRoot pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/replaceWith/
Creates a $sample pipeline stage with the specified sample size.
Creates a $sample pipeline stage with the specified sample size.
Value parameters
- size
-
the sample size
Attributes
- Returns
-
Aggregate with $sample pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/sample/
Creates a $search pipeline stage supported by MongoDB Atlas. You may use $meta: "searchScore", e.g., via Projection.metaSearchScore(String), to extract the relevance score assigned to each found document.
Creates a $search pipeline stage supported by MongoDB Atlas. You may use $meta: "searchScore", e.g., via Projection.metaSearchScore(String), to extract the relevance score assigned to each found document.
Value parameters
- operator
-
A search operator.
- options
-
Optional $search pipeline stage fields.
Attributes
- Returns
-
Aggregate with requested pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/search/
Creates a $search pipeline stage supported by MongoDB Atlas. You may use $meta: "searchScore", e.g., via Projection.metaSearchScore(String), to extract the relevance score assigned to each found document.
Creates a $search pipeline stage supported by MongoDB Atlas. You may use $meta: "searchScore", e.g., via Projection.metaSearchScore(String), to extract the relevance score assigned to each found document.
Value parameters
- collector
-
A search collector.
- options
-
Optional $search pipeline stage fields.
Attributes
- Returns
-
Aggregate with $search pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/search/
Creates a $searchMeta pipeline stage supported by MongoDB Atlas. Unlike $search, it does not return found documents, instead it returns metadata, which in case of using the $search stage may be extracted by using $$SEARCH_META variable, e.g., via Projection.computedSearchMeta(String).
Creates a $searchMeta pipeline stage supported by MongoDB Atlas. Unlike $search, it does not return found documents, instead it returns metadata, which in case of using the $search stage may be extracted by using $$SEARCH_META variable, e.g., via Projection.computedSearchMeta(String).
Value parameters
- operator
-
A search operator.
- options
-
Optional $search pipeline stage fields.
Attributes
- Returns
-
Aggregate with $searchMeta pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/searchMeta/
Creates a $searchMeta pipeline stage supported by MongoDB Atlas. Unlike $search, it does not return found documents, instead it returns metadata, which in case of using the $search stage may be extracted by using $$SEARCH_META variable, e.g., via Projection.computedSearchMeta(String).
Creates a $searchMeta pipeline stage supported by MongoDB Atlas. Unlike $search, it does not return found documents, instead it returns metadata, which in case of using the $search stage may be extracted by using $$SEARCH_META variable, e.g., via Projection.computedSearchMeta(String).
Value parameters
- collector
-
A search collector.
- options
-
Optional $search pipeline stage fields.
Attributes
- Returns
-
Aggregate with $searchMeta pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/searchMeta/
Creates a $set pipeline stage for the specified projection.
Creates a $set pipeline stage for the specified projection.
Value parameters
- fields
-
the fields to add
Attributes
- Returns
-
Aggregate with $set pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/set/
Creates a $setWindowFields pipeline stage, which allows using window operators. This stage partitions the input documents similarly to the $group pipeline stage, sorts them, computes fields in the documents by computing window functions over windows specified per function, and outputs the documents. The important difference from the $group pipeline stage is that documents belonging to the same partition or window are not folded into a single document.
Creates a $setWindowFields pipeline stage, which allows using window operators. This stage partitions the input documents similarly to the $group pipeline stage, sorts them, computes fields in the documents by computing window functions over windows specified per function, and outputs the documents. The important difference from the $group pipeline stage is that documents belonging to the same partition or window are not folded into a single document.
Value parameters
- output
-
A list of windowed computations. Specifying an empty list is not an error, but the resulting stage does not do anything useful.
- partitionBy
-
Partitioning of data specified like id in $group.
- sortBy
-
Fields to sort by. Sorting is required by certain functions and may be required by some windows. Sorting is used only for the purpose of computing window functions and does not guarantee ordering of the output documents.
Attributes
- Returns
-
Aggregate with $setWindowFields pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/setWindowFields/
Creates a $setWindowFields pipeline stage, which allows using window operators. This stage sorts input documents, computes fields in the documents by computing window functions over windows specified per function, and outputs the documents. Here, documents will belong to the same partition.
Creates a $setWindowFields pipeline stage, which allows using window operators. This stage sorts input documents, computes fields in the documents by computing window functions over windows specified per function, and outputs the documents. Here, documents will belong to the same partition.
Value parameters
- output
-
A list of windowed computations. Specifying an empty list is not an error, but the resulting stage does not do anything useful.
- sortBy
-
Fields to sort by. Sorting is required by certain functions and may be required by some windows. Sorting is used only for the purpose of computing window functions and does not guarantee ordering of the output documents.
Attributes
- Returns
-
Aggregate with $setWindowFields pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/setWindowFields/
Creates a $skip pipeline stage.
Creates a $skip pipeline stage.
Value parameters
- n
-
the number of documents to skip
Attributes
- Returns
-
Aggregate with $skip pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/skip/
Creates a $sort pipeline stage for the specified sort specification.
Creates a $sort pipeline stage for the specified sort specification.
Value parameters
- sort
-
the sort specification
Attributes
- Returns
-
Aggregate with $sort pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/sort/
Creates a $sortByCount pipeline stage for the specified filter.
Creates a $sortByCount pipeline stage for the specified filter.
Value parameters
- filter
-
the filter specification
Attributes
- Returns
-
Aggregate with $sortByCount pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/sortByCount/
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
Attributes
- Returns
-
a string representation of the object.
- Definition Classes
-
Any
Creates a $unionWith pipeline stage.
Creates a $unionWith pipeline stage.
Value parameters
- collection
-
the name of the collection in the same database to perform the union with.
- pipeline
-
the pipeline to run on the union.
Attributes
- Returns
-
Aggregate with $unionWith pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/unionWith/
Creates an $unset pipeline stage. With $unset you can removes/excludes fields from documents.
Creates an $unset pipeline stage. With $unset you can removes/excludes fields from documents.
Value parameters
- fields
-
the fields to exclude. May use dot notation.
Attributes
- Returns
-
Aggregate with $unset aggregate stage https://www.mongodb.com/docs/manual/reference/operator/aggregation/unset/
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.
Value parameters
- fieldName
-
the field name, prefixed by a '$' sign
- unwindOptions
-
options for the unwind pipeline stage
Attributes
- Returns
-
Aggregate with $unwind pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/unwind/
Creates a $vectorSearch pipeline stage supported by MongoDB Atlas. You may use the $meta: "vectorSearchScore" expression, e.g., via Projection.metaVectorSearchScore(String), to extract the relevance score assigned to each found document.
Creates a $vectorSearch pipeline stage supported by MongoDB Atlas. You may use the $meta: "vectorSearchScore" expression, e.g., via Projection.metaVectorSearchScore(String), to extract the relevance score assigned to each found document.
Value parameters
- index
-
The name of the index to use.
- limit
-
The limit on the number of documents produced by the pipeline stage.
- options
-
Optional $vectorSearch pipeline stage fields.
- path
-
The field to be searched.
- queryVector
-
The query vector. The number of dimensions must match that of the index.
Attributes
- Returns
-
The Aggregate with $vectorSearch pipeline stage https://docs.mongodb.com/manual/reference/operator/aggregation/vectorSearch/
Inherited methods
Attributes
- Inherited from:
- AsJavaConverters
Attributes
- Inherited from:
- AsJavaConverters
Attributes
- Inherited from:
- AsJavaConverters
Attributes
- Inherited from:
- AsJavaConverters
Attributes
- Inherited from:
- AsJavaConverters
Attributes
- Inherited from:
- AsJavaConverters
Attributes
- Inherited from:
- AsJavaConverters
Attributes
- Inherited from:
- AsJavaConverters
Attributes
- Inherited from:
- AsJavaConverters
Attributes
- Inherited from:
- AsJavaConverters
Attributes
- Inherited from:
- AsJavaConverters
Attributes
- Inherited from:
- AsJavaConverters
Attributes
- Inherited from:
- AsJavaConverters