Value Members

1.  object Accumulators

   Builders for accumulators used in the group pipeline stage of an aggregation pipeline.

   Builders for accumulators used in the group pipeline stage of an aggregation pipeline.

   Since

   1.0

   See also

   Aggregation pipeline

   Accumulators

   Expressions

2.  object Aggregates

   Builders for aggregation pipeline stages.

   Builders for aggregation pipeline stages.

   Since

   1.0

   See also

   Aggregation pipeline

3.  object BsonField

   A representation of a BSON document field whose value is another BSON document.

4.  object BucketAutoOptions

   The options for a $bucketAuto aggregation pipeline stage

   The options for a $bucketAuto aggregation pipeline stage

   Since

   1.2

5.  object BucketGranularity

   Granularity values for automatic bucketing.

   Granularity values for automatic bucketing.

   Since

   1.2

   See also

   $bucketAuto

   numbers

6.  object BucketOptions

   The options for a $bucket aggregation pipeline stage

   The options for a $bucket aggregation pipeline stage

   Since

   1.2

7.  object BulkWriteOptions

   The options to apply to a bulk write.

8.  object Collation

   The options regarding collation support in MongoDB 3.4+

   The options regarding collation support in MongoDB 3.4+

   Since

   1.2

   Note

   Requires MongoDB 3.4 or greater

9.  object CollationAlternate

   Collation support allows the specific configuration of whether or not spaces and punctuation are considered base characters.

   Collation support allows the specific configuration of whether or not spaces and punctuation are considered base characters.

   Since

   1.2

   Note

   Requires MongoDB 3.4 or greater

10.  object CollationCaseFirst

    Collation support allows the specific configuration of how character cases are handled.

    Collation support allows the specific configuration of how character cases are handled.

    Since

    1.2

    Note

    Requires MongoDB 3.4 or greater

11.  object CollationMaxVariable

    Collation support allows the specific configuration of whether or not spaces and punctuation are considered base characters.

    Collation support allows the specific configuration of whether or not spaces and punctuation are considered base characters.

    CollationMaxVariable controls which characters are affected by CollationAlternate$.SHIFTED.

    Since

    1.2

    Note

    Requires MongoDB 3.4 or greater

12.  object CollationStrength

    Collation support allows the specific configuration of how character cases are handled.

    Collation support allows the specific configuration of how character cases are handled.

    Since

    1.2

    Note

    Requires MongoDB 3.4 or greater

13.  object CountOptions

    The options to apply to a count operation.

14.  object CreateCollectionOptions

    Options for creating a collection

15.  object CreateViewOptions

    Options for creating a view

    Options for creating a view

    Since

    1.2

    Note

    Requires MongoDB 3.4 or greater

16.  object DeleteManyModel

    A model describing the removal of all documents matching the query filter.

17.  object DeleteOneModel

    A model describing the removal of at most one document matching the query filter.

18.  object DeleteOptions

    The options to apply for delete operations.

19.  object EstimatedDocumentCountOptions

    The options to apply to an estimated count operation.

    The options to apply to an estimated count operation.

    Since

    2.4

20.  object Facet

    Defines a Facet for use in $facet pipeline stages.

    Defines a Facet for use in $facet pipeline stages.

    Since

    1.2

21.  object Field

    A helper to define new fields for the $addFields pipeline stage

    A helper to define new fields for the $addFields pipeline stage

    Since

    1.2

22.  object Filters

    A factory for query filters.

    A factory for query filters. A convenient way to use this class is to statically import all of its methods, which allows usage like:

    collection.find(and(eq("x", 1), lt("y", 3)))

    Since

    1.0

23.  object FindOneAndDeleteOptions

    The options to apply to an operation that atomically finds a document and deletes it.

24.  object FindOneAndReplaceOptions

    The options to apply to an operation that atomically finds a document and replaces it.

25.  object FindOneAndUpdateOptions

    The options to apply to an operation that atomically finds a document and updates it.

26.  object GraphLookupOptions

    The options for a graphLookup aggregation pipeline stage

    The options for a graphLookup aggregation pipeline stage

    Since

    1.2

27.  object IndexModel

    A model describing the creation of a single index.

28.  object IndexOptionDefaults

    Options for creating an index

29.  object IndexOptions

    The options to apply to the creation of an index.

30.  object Indexes

    A factory for defining index keys.

    A factory for defining index keys. A convenient way to use this class is to statically import all of its methods, which allows usage like:

    collection.createIndex(compoundIndex(ascending("x"), descending("y")))

    Since

    1.0

31.  object InsertManyOptions

    The options to apply to an operation that inserts multiple documents into a collection.

32.  object InsertOneModel

    A model describing an insert of a single document.

33.  object InsertOneOptions

    The options to apply to an operation that inserts a single document into a collection.

    The options to apply to an operation that inserts a single document into a collection.

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

34.  object MapReduceAction

    The map reduce to collection actions.

    The map reduce to collection actions.

    These actions are only available when passing out a collection that already exists. This option is not available on secondary members of replica sets. The Enum values dictate what to do with the output collection if it already exists when the map reduce is run.

    Since

    1.0

35.  object MergeOptions extends Serializable

    Options to control the behavior of the $merge aggregation stage

    Options to control the behavior of the $merge aggregation stage

    Since

    2.7

36.  object MongoTimeUnit

    Units for specifying time-based bounds for windows and output units for some time-based windowed computations.

    Units for specifying time-based bounds for windows and output units for some time-based windowed computations.

    Annotations

    @Beta()

    Since

    4.3

    Note

    Requires MongoDB 5.0 or greater.

37.  object Projections

    A factory for projections.

    A factory for projections. A convenient way to use this class is to statically import all of its methods, which allows usage like:

    collection.find().projection(fields(include("x", "y"), excludeId()))

    Since

    1.0

38.  object PushOptions

    The options to apply to a $push update operator.

39.  object RenameCollectionOptions

    The options to apply when renaming a collection

40.  object ReplaceOneModel

    A model describing the replacement of at most one document that matches the query filter.

41.  object ReplaceOptions

    The options to apply when replacing documents.

    The options to apply when replacing documents.

    Since

    2.3

42.  object ReturnDocument

    Indicates which document to return, the original document before change or the document after the change

    Indicates which document to return, the original document before change or the document after the change

    Since

    1.0

43.  object Sorts

    A factory for sort specifications.

    A factory for sort specifications. A convenient way to use this class is to statically import all of its methods, which allows usage like:

    collection.find().sort(orderBy(ascending("x", "y"), descending("z")))

    Since

    1.0

44.  object TextSearchOptions

    Text search options for the Filters text helper

    Text search options for the Filters text helper

    Since

    1.1

45.  object TimeSeriesOptions

    Options for creating a time-series collection

46.  object UnwindOptions

    The options for an unwind aggregation pipeline stage

    The options for an unwind aggregation pipeline stage

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

47.  object UpdateManyModel

    A model describing an update to all documents that matches the query filter.

    A model describing an update to all documents that matches the query filter. The update to apply must include only update operators.

48.  object UpdateOneModel

    A model describing an update to at most one document that matches the query filter.

    A model describing an update to at most one document that matches the query filter. The update to apply must include only update operators.

49.  object UpdateOptions

    The options to apply when updating documents.

50.  object Updates

    A factory for document updates.

    A factory for document updates. A convenient way to use this class is to statically import all of its methods, which allows usage like:

    collection.updateOne(eq("x", 1), set("x", 2))

    Since

    1.0

51.  object ValidationAction

    Determines how strictly MongoDB applies the validation rules to existing documents during an insert or update.

    Determines how strictly MongoDB applies the validation rules to existing documents during an insert or update.

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

52.  object ValidationLevel

    Determines how strictly MongoDB applies the validation rules to existing documents during an insert or update.

    Determines how strictly MongoDB applies the validation rules to existing documents during an insert or update.

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

53.  object ValidationOptions

    Validation options for documents being inserted or updated in a collection

    Validation options for documents being inserted or updated in a collection

    Since

    1.1

    Note

    Requires MongoDB 3.2 or greater

54.  object Variable

    Helps define new variable for the $lookup pipeline stage

    Helps define new variable for the $lookup pipeline stage

    Since

    2.3

55.  object WindowedComputations

    Builders for windowed computations used in the $setWindowFields pipeline stage of an aggregation pipeline.

    Builders for windowed computations used in the $setWindowFields pipeline stage of an aggregation pipeline. Each windowed computation is a triple:

    • A window function. Some functions require documents in a window to be sorted (see sortBy in Aggregates.setWindowFields).
    • An optional window, a.k.a. frame. Specifying null window is equivalent to specifying an unbounded window, i.e., a window with both ends specified as UNBOUNDED. Some window functions require to specify an explicit unbounded window instead of specifying null.
    • A path to an output field to be computed by the window function over the window.

    A windowed computation is similar to an accumulator but does not result in folding documents constituting the window into a single document.

    Annotations

    @Beta()

    Since

    4.3

    Note

    Requires MongoDB 5.0 or greater.

    See also

    Field paths

56.  object Windows

    Builders for windows used when expressing windowed computations.

    Builders for windows used when expressing windowed computations. There are two types of windows: documents and range.

    Bounded and half-bounded windows require sorting. Window bounds are inclusive and the lower bound must always be less than or equal to the upper bound. The following type-specific rules are applied to windows:

    • documents
      • bounds
        • 0 refers to the current document and is functionally equivalent to CURRENT;
        • a negative value refers to documents preceding the current one;
        • a positive value refers to documents following the current one;
    • range
      • sortBy
        • must contain exactly one field;
        • must specify the ascending sort order;
        • the sortBy field must be of either a numeric BSON type (see the $isNumber aggregation pipeline stage) or the BSON Date type if time bounds are used;
      • bounds
        • if numeric, i.e., not com.mongodb.client.model.Windows.Bound, then the bound is calculated by adding the value to the value of the sortBy field in the current document;
        • if CURRENT, then the bound is determined by the current document and not the current value of the sortBy field;
        • time bounds require specifying a time unit and are added as per the $dateAdd/$dateSubtract aggregation pipeline stage specification.

    Annotations

    @Beta()

    Since

    4.3

    Note

    Requires MongoDB 5.0 or greater.

    See also

    WindowedComputation

    $isNumber aggregation pipeline stage

    BSON Date type

    $dateAdd aggregation pipeline stage

    $dateSubtract aggregation pipeline stage