model

package model

The model package containing models and options that help describe MongoCollection operations

Linear Supertypes

AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

model
AnyRef
Any

Hide All
Show All

Visibility

Public
Protected

Package Members

package changestream
package densify
Since
4.7
Note
Requires MongoDB 5.1 or greater.
See also
Aggregates.densify
package fill
Since
4.7
Note
Requires MongoDB 5.3 or greater.
See also
Aggregates.fill
package geojson
package search
Query building API for MongoDB Atlas full-text search.
Query building API for MongoDB Atlas full-text search.
While all the building blocks of this API, such as SearchOptions, SearchHighlight, etc., are not necessary immutable, they are unmodifiable due to methods like SearchHighlight.maxCharsToExamine returning new instances instead of modifying the instance on which they are called. This allows storing and using such instances as templates.
Since
4.7
See also
Aggregates.search
Aggregates.vectorSearch
Atlas Search
Atlas Search aggregation pipeline stages
package vault
This package contains options classes for the key vault API
This package contains options classes for the key vault API
Since
2.7

Type Members

type ApproximateQuantileMethod = com.mongodb.client.model.ApproximateQuantileMethod
Annotations
@Sealed()
See also
QuantileMethod.approximate()
type BsonField = com.mongodb.client.model.BsonField
A representation of a BSON document field whose value is another BSON document.
type BucketAutoOptions = com.mongodb.client.model.BucketAutoOptions
The options for a $bucketAuto aggregation pipeline stage
The options for a $bucketAuto aggregation pipeline stage
Since
1.2
type BucketGranularity = com.mongodb.client.model.BucketGranularity
Granularity values for automatic bucketing.
Granularity values for automatic bucketing.
Since
1.2
See also
numbers
type BucketOptions = com.mongodb.client.model.BucketOptions
The options for a $bucket aggregation pipeline stage
The options for a $bucket aggregation pipeline stage
Since
1.2
type BulkWriteOptions = com.mongodb.client.model.BulkWriteOptions
The options to apply to a bulk write.
type ChangeStreamPreAndPostImagesOptions = com.mongodb.client.model.ChangeStreamPreAndPostImagesOptions
Options for change stream pre- and post- images
type ClusteredIndexOptions = com.mongodb.client.model.ClusteredIndexOptions
Options for creating a clustered index on a collection
type Collation = com.mongodb.client.model.Collation
The collation options.
type CollationAlternate = com.mongodb.client.model.CollationAlternate
The collation alternative options.
type CollationCaseFirst = com.mongodb.client.model.CollationCaseFirst
The collation configuration of how character cases are handled
type CollationMaxVariable = com.mongodb.client.model.CollationMaxVariable
The collation max variable options
type CollationStrength = com.mongodb.client.model.CollationStrength
The collation configuration of how differences between characters are handled.
type CountOptions = com.mongodb.client.model.CountOptions
The options to apply to a count operation.
type CreateCollectionOptions = com.mongodb.client.model.CreateCollectionOptions
Options for creating a collection
type CreateEncryptedCollectionParams = com.mongodb.client.model.CreateEncryptedCollectionParams
Auxiliary parameters for creating an encrypted collection.
Auxiliary parameters for creating an encrypted collection.
Annotations
@Beta()
Since
4.9
type CreateIndexOptions = com.mongodb.client.model.CreateIndexOptions
The options to apply to the command when creating indexes.
The options to apply to the command when creating indexes.
Since
2.2
type CreateViewOptions = com.mongodb.client.model.CreateViewOptions
Options for creating a view
Options for creating a view
Since
1.2
Note
Requires MongoDB 3.4 or greater
type DeleteManyModel[TResult] = com.mongodb.client.model.DeleteManyModel[TResult]
A model describing the removal of all documents matching the query filter.
type DeleteOneModel[TResult] = com.mongodb.client.model.DeleteOneModel[TResult]
A model describing the removal of at most one document matching the query filter.
type DeleteOptions = com.mongodb.client.model.DeleteOptions
The options to apply for delete operations
type DropCollectionOptions = com.mongodb.client.model.DropCollectionOptions
Options for creating a collection
Options for creating a collection
Since
4.6
type DropIndexOptions = com.mongodb.client.model.DropIndexOptions
The options to apply to the command when creating indexes.
The options to apply to the command when creating indexes.
Since
2.2
type EstimatedDocumentCountOptions = com.mongodb.client.model.EstimatedDocumentCountOptions
The options to apply to an estimated count operation.
The options to apply to an estimated count operation.
Since
2.4
type Facet = com.mongodb.client.model.Facet
Defines a Facet for use in $facet pipeline stages.
Defines a Facet for use in $facet pipeline stages.
Since
1.2
type Field[TExpression] = com.mongodb.client.model.Field[TExpression]
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
type FindOneAndDeleteOptions = com.mongodb.client.model.FindOneAndDeleteOptions
The options to apply to an operation that atomically finds a document and deletes it.
type FindOneAndReplaceOptions = com.mongodb.client.model.FindOneAndReplaceOptions
The options to apply to an operation that atomically finds a document and replaces it.
type FindOneAndUpdateOptions = com.mongodb.client.model.FindOneAndUpdateOptions
The options to apply to an operation that atomically finds a document and updates it.
type GeoNearOptions = com.mongodb.client.model.GeoNearOptions
type GraphLookupOptions = com.mongodb.client.model.GraphLookupOptions
The options for a graphLookup aggregation pipeline stage
The options for a graphLookup aggregation pipeline stage
Since
1.2
type IndexModel = com.mongodb.client.model.IndexModel
A model describing the creation of a single index.
type IndexOptionDefaults = com.mongodb.client.model.IndexOptionDefaults
The default options for a collection to apply on the creation of indexes.
The default options for a collection to apply on the creation of indexes.
Since
1.1
Note
Requires MongoDB 3.2 or greater
See also
Index options
type IndexOptions = com.mongodb.client.model.IndexOptions
The options to apply to the creation of an index.
type InsertManyOptions = com.mongodb.client.model.InsertManyOptions
The options to apply to an operation that inserts multiple documents into a collection.
type InsertOneModel[TResult] = com.mongodb.client.model.InsertOneModel[TResult]
A model describing an insert of a single document.
type InsertOneOptions = com.mongodb.client.model.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
type MapReduceAction = com.mongodb.client.model.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.
case class MergeOptions(wrapped: com.mongodb.client.model.MergeOptions = new JMergeOptions()) extends Product with Serializable
Options to control the behavior of the $merge aggregation stage
Options to control the behavior of the $merge aggregation stage
Since
2.7
type PushOptions = com.mongodb.client.model.PushOptions
The options to apply to a $push update operator.
type RenameCollectionOptions = com.mongodb.client.model.RenameCollectionOptions
The options to apply when renaming a collection
type ReplaceOneModel[TResult] = com.mongodb.client.model.ReplaceOneModel[TResult]
A model describing the replacement of at most one document that matches the query filter.
type ReplaceOptions = com.mongodb.client.model.ReplaceOptions
The options to apply when replacing documents.
The options to apply when replacing documents.
Since
2.3
type ReturnDocument = com.mongodb.client.model.ReturnDocument
Indicates which document to return, the original document before change or the document after the change
type SearchIndexModel = com.mongodb.client.model.SearchIndexModel
A model describing the creation of a single Atlas Search index.
type SearchIndexType = com.mongodb.client.model.SearchIndexType
Represents an Atlas Search Index type, which is utilized for creating specific types of indexes.
type TextSearchOptions = com.mongodb.client.model.TextSearchOptions
Text search options for the Filters text helper
Text search options for the Filters text helper
Since
1.1
See also
$text
type TimeSeriesGranularity = com.mongodb.client.model.TimeSeriesGranularity
Enumeration of values for time-series data granularity
type TimeSeriesOptions = com.mongodb.client.model.TimeSeriesOptions
Options for creating a time-series collection
type UnwindOptions = com.mongodb.client.model.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
type UpdateManyModel[TResult] = com.mongodb.client.model.UpdateManyModel[TResult]
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.
type UpdateOneModel[TResult] = com.mongodb.client.model.UpdateOneModel[TResult]
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.
type UpdateOptions = com.mongodb.client.model.UpdateOptions
The options to apply when updating documents.
type ValidationAction = com.mongodb.client.model.ValidationAction
Determines whether to error on invalid documents or just warn about the violations but allow invalid documents.
Determines whether to error on invalid documents or just warn about the violations but allow invalid documents.
Since
1.1
Note
Requires MongoDB 3.2 or greater
type ValidationLevel = com.mongodb.client.model.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
type ValidationOptions = com.mongodb.client.model.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
type Variable[TExpression] = com.mongodb.client.model.Variable[TExpression]
Helps define new variable for the $lookup pipeline stage
Helps define new variable for the $lookup pipeline stage
Since
2.3
type Window = com.mongodb.client.model.Window
A subset of documents within a partition in the Aggregates.setWindowFields pipeline stage of an aggregation pipeline (see partitionBy in Aggregates.setWindowFields).
A subset of documents within a partition in the Aggregates.setWindowFields pipeline stage of an aggregation pipeline (see partitionBy in Aggregates.setWindowFields).
Since
4.3
See also
Windows
type WindowOutputField = com.mongodb.client.model.WindowOutputField
The core part of the Aggregates.setWindowFields pipeline stage of an aggregation pipeline.
The core part of the Aggregates.setWindowFields pipeline stage of an aggregation pipeline. A triple of a window function, a window and a path to a field to be computed by the window function over the window.
Since
4.3
See also
WindowOutputFields
type WriteModel[TResult] = com.mongodb.client.model.WriteModel[TResult]
A base class for models that can be used in a bulk write operations.

Value Members

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
object Aggregates
Builders for aggregation pipeline stages.
Builders for aggregation pipeline stages.
Since
1.0
See also
Aggregation pipeline
object BsonField
A representation of a BSON document field whose value is another BSON document.
object BucketAutoOptions
The options for a $bucketAuto aggregation pipeline stage
The options for a $bucketAuto aggregation pipeline stage
Since
1.2
object BucketGranularity
Granularity values for automatic bucketing.
Granularity values for automatic bucketing.
Since
1.2
See also
$bucketAuto
numbers
object BucketOptions
The options for a $bucket aggregation pipeline stage
The options for a $bucket aggregation pipeline stage
Since
1.2
object BulkWriteOptions
The options to apply to a bulk write.
object ChangeStreamPreAndPostImagesOptions
Options for change stream pre- and post- images
object ClusteredIndexOptions
Options for creating a clustered index on a collection
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
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
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
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
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
object CountOptions
The options to apply to a count operation.
object CreateCollectionOptions
Options for creating a collection
object CreateEncryptedCollectionParams
Auxiliary parameters for creating an encrypted collection.
Auxiliary parameters for creating an encrypted collection.
Annotations
@Beta()
Since
4.9
object CreateViewOptions
Options for creating a view
Options for creating a view
Since
1.2
Note
Requires MongoDB 3.4 or greater
object DeleteManyModel
A model describing the removal of all documents matching the query filter.
object DeleteOneModel
A model describing the removal of at most one document matching the query filter.
object DeleteOptions
The options to apply for delete operations.
object DropCollectionOptions
Options for creating a collection
Options for creating a collection
Since
4.6
object EstimatedDocumentCountOptions
The options to apply to an estimated count operation.
The options to apply to an estimated count operation.
Since
2.4
object Facet
Defines a Facet for use in $facet pipeline stages.
Defines a Facet for use in $facet pipeline stages.
Since
1.2
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
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
object FindOneAndDeleteOptions
The options to apply to an operation that atomically finds a document and deletes it.
object FindOneAndReplaceOptions
The options to apply to an operation that atomically finds a document and replaces it.
object FindOneAndUpdateOptions
The options to apply to an operation that atomically finds a document and updates it.
object GraphLookupOptions
The options for a graphLookup aggregation pipeline stage
The options for a graphLookup aggregation pipeline stage
Since
1.2
object IndexModel
A model describing the creation of a single index.
object IndexOptionDefaults
Options for creating an index
object IndexOptions
The options to apply to the creation of an index.
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
object InsertManyOptions
The options to apply to an operation that inserts multiple documents into a collection.
object InsertOneModel
A model describing an insert of a single document.
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
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
object MongoTimeUnit
Units for specifying time-based values.
Units for specifying time-based values.
Since
4.3
Note
Requires MongoDB 5.0 or greater.
See also
Windows
WindowOutputFields
org.mongodb.scala.model.densify.DensifyRange
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
object PushOptions
The options to apply to a $push update operator.
object QuantileMethod
This interface represents a quantile method used in quantile accumulators of the $group and $setWindowFields stages.
This interface represents a quantile method used in quantile accumulators of the $group and $setWindowFields stages.
It provides methods for creating and converting quantile methods to BsonValue.
Annotations
@Sealed()
Since
4.10
Note
Requires MongoDB 7.0 or greater
See also
org.mongodb.scala.model.Accumulators.percentile
org.mongodb.scala.model.Accumulators.median
org.mongodb.scala.model.WindowOutputFields.percentile
org.mongodb.scala.model.WindowOutputFields.median
object RenameCollectionOptions
The options to apply when renaming a collection
object ReplaceOneModel
A model describing the replacement of at most one document that matches the query filter.
object ReplaceOptions
The options to apply when replacing documents.
The options to apply when replacing documents.
Since
2.3
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
object SearchIndexModel
A model describing the creation of a single Atlas Search index.
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
object TextSearchOptions
Text search options for the Filters text helper
Text search options for the Filters text helper
Since
1.1
object TimeSeriesOptions
Options for creating a time-series collection
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
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.
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.
object UpdateOptions
The options to apply when updating documents.
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
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
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
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
object Variable
Helps define new variable for the $lookup pipeline stage
Helps define new variable for the $lookup pipeline stage
Since
2.3
object WindowOutputFields
Builders for window output fields used in the Aggregates.setWindowFields pipeline stage of an aggregation pipeline.
Builders for window output fields used in the Aggregates.setWindowFields pipeline stage of an aggregation pipeline. Each windowed output field 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 None window is equivalent to specifying an unbounded window, i.e., a window with both ends specified as UNBOUNDED. Some window functions, e.g., WindowOutputFields.derivative, require an explicit unbounded window instead of None.
- 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.
Since
4.3
Note
Requires MongoDB 5.0 or greater.
See also
Field paths
object Windows
Builders for windows used when expressing window output fields.
Builders for windows used when expressing window output fields. 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 (see Aggregates.setWindowFields)
    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
WindowOutputField
$isNumber aggregation pipeline stage
BSON Date type
$dateAdd aggregation pipeline stage
$dateSubtract aggregation pipeline stage

Deprecated Value Members

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.
Annotations
@deprecated
Deprecated
(Since version 4.4.0) Superseded by aggregate
Since
1.0

Packages

Driver structure

model

package model

Package Members

Type Members

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Driver structure

model

package model

Package Members

Type Members

Value Members

Deprecated Value Members

Inherited from AnyRef

Inherited from Any

Ungrouped

model