Index

A B C D E F G H I J K L M N O P Q R S T U V W Y 
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

abs() - Method in interface com.mongodb.client.model.mql.MqlInteger
The absolute value of this value.
abs() - Method in interface com.mongodb.client.model.mql.MqlNumber
The absolute value of this value.
accumulator(String, String, String, String) - Static method in class com.mongodb.client.model.Accumulators
Creates an $accumulator pipeline stage
accumulator(String, String, String, String, String) - Static method in class com.mongodb.client.model.Accumulators
Creates an $accumulator pipeline stage
accumulator(String, String, String, String, String, String) - Static method in class com.mongodb.client.model.Accumulators
Creates an $accumulator pipeline stage
accumulator(String, String, List<String>, String, List<String>, String, String) - Static method in class com.mongodb.client.model.Accumulators
Creates an $accumulator pipeline stage
accumulator(String, String, List<String>, String, List<String>, String, String, String) - Static method in class com.mongodb.client.model.Accumulators
Creates an $accumulator pipeline stage
Accumulators - Class in com.mongodb.client.model
Builders for accumulators used in the group pipeline stage of an aggregation pipeline.
acknowledged(int, boolean, BsonValue) - Static method in class com.mongodb.WriteConcernResult
Create an acknowledged WriteConcernResult
acknowledged(int, int, int, Integer, List<BulkWriteUpsert>, List<BulkWriteInsert>) - Static method in class com.mongodb.bulk.BulkWriteResult
Create an acknowledged BulkWriteResult
acknowledged(long) - Static method in class com.mongodb.client.result.DeleteResult
Create an acknowledged DeleteResult
acknowledged(long, Long, BsonValue) - Static method in class com.mongodb.client.result.UpdateResult
Create an acknowledged UpdateResult
acknowledged(WriteRequest.Type, int, Integer, List<BulkWriteUpsert>, List<BulkWriteInsert>) - Static method in class com.mongodb.bulk.BulkWriteResult
Create an acknowledged BulkWriteResult
acknowledged(Map<Integer, BsonValue>) - Static method in class com.mongodb.client.result.InsertManyResult
Create an acknowledged InsertManyResult
acknowledged(BsonValue) - Static method in class com.mongodb.client.result.InsertOneResult
Create an acknowledged InsertOneResult
ACKNOWLEDGED - Static variable in class com.mongodb.WriteConcern
Write operations that use this write concern will wait for acknowledgement, using the default write concern configured on the server.
add(int) - Method in interface com.mongodb.client.model.mql.MqlInteger
The sum of adding this and the other value.
add(MqlInteger) - Method in interface com.mongodb.client.model.mql.MqlInteger
The sum of adding this and the other value.
add(MqlNumber) - Method in interface com.mongodb.client.model.mql.MqlNumber
The sum of adding this and the other value.
add(Number) - Method in interface com.mongodb.client.model.mql.MqlNumber
The sum of adding this and the other value.
add(String, Object) - Method in class com.mongodb.BasicDBObjectBuilder
Same as append
addClusterListener(ClusterListener) - Method in class com.mongodb.connection.ClusterSettings.Builder
Adds a cluster listener.
addCommandListener(CommandListener) - Method in class com.mongodb.MongoClientSettings.Builder
Adds the given command listener.
addConnectionPoolListener(ConnectionPoolListener) - Method in class com.mongodb.connection.ConnectionPoolSettings.Builder
Adds the given connection pool listener.
addEachToSet(String, List<TItem>) - Static method in class com.mongodb.client.model.Updates
Creates an update that adds each of the given values to the array value of the field with the given name, unless the value is already present, in which case it does nothing
addExpression(Iterable<? extends SearchScoreExpression>) - Static method in interface com.mongodb.client.model.search.SearchScoreExpression
Returns a SearchScoreExpression that evaluates into the sum of the values of the specified expressions.
addFields(Field<?>...) - Static method in class com.mongodb.client.model.Aggregates
Creates an $addFields pipeline stage
addFields(List<Field<?>>) - Static method in class com.mongodb.client.model.Aggregates
Creates an $addFields pipeline stage
addLabel(String) - Method in exception com.mongodb.MongoException
Adds the given error label to the exception.
addLabels(Collection<String>) - Method in exception com.mongodb.MongoException
Add labels.
addLabels(BsonArray) - Method in exception com.mongodb.MongoException
Add labels.
address(ServerAddress) - Method in class com.mongodb.connection.ServerDescription.Builder
Sets the address of the server.
AddSearchScoreExpression - Interface in com.mongodb.client.model.search
 
addServerListener(ServerListener) - Method in class com.mongodb.connection.ServerSettings.Builder
Add a server listener.
addServerMonitorListener(ServerMonitorListener) - Method in class com.mongodb.connection.ServerSettings.Builder
Adds a server monitor listener.
addToSet(String, TExpression) - Static method in class com.mongodb.client.model.Accumulators
Gets a field name for a $group operation representing all unique values that results from applying the given expression to each document in a group of documents that share the same group by key.
addToSet(String, TExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field that adds the evaluation results of the expression over the window to a BSON Array and excludes duplicates.
addToSet(String, TItem) - Static method in class com.mongodb.client.model.Updates
Creates an update that adds the given value to the array value of the field with the given name, unless the value is already present, in which case it does nothing
advanceClusterTime(BsonDocument) - Method in interface com.mongodb.session.ClientSession
 
advanceOperationTime(BsonTimestamp) - Method in interface com.mongodb.session.ClientSession
Set the operation time of the last operation executed in this session.
advanceTransactionNumber() - Method in interface com.mongodb.session.ServerSession
Return the next available transaction number.
AFTER - Enum constant in enum class com.mongodb.client.model.ReturnDocument
Indicates to return the document after the update, replacement, or insert occurred.
Aggregates - Class in com.mongodb.client.model
Builders for aggregation pipeline stages.
all(String, Iterable<TItem>) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of a field is an array that contains all the specified values.
all(String, TItem...) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of a field is an array that contains all the specified values.
all(Function<? super T, MqlBoolean>) - Method in interface com.mongodb.client.model.mql.MqlArray
Whether all values in this array satisfy the predicate.
ALL_PLANS_EXECUTIONS - Enum constant in enum class com.mongodb.ExplainVerbosity
Runs the query optimizer and chooses the winning plan, but then runs all generated plans to completion.
allocator(ByteBufAllocator) - Method in class com.mongodb.connection.NettyTransportSettings.Builder
Sets the allocator.
ALLOWED_HOSTS_KEY - Static variable in class com.mongodb.MongoCredential
Mechanism property key for a list of allowed hostnames or ip-addresses for MongoDB connections.
Alpha - Annotation Interface in com.mongodb.annotations
Signifies that a public API element is in the early stages of development, subject to incompatible changes, or even removal, in a future release and may lack some intended features.
and(MqlBoolean) - Method in interface com.mongodb.client.model.mql.MqlBoolean
The logical disjunction of this and the other value.
and(Iterable<Bson>) - Static method in class com.mongodb.client.model.Filters
Creates a filter that performs a logical AND of the provided list of filters.
and(Bson...) - Static method in class com.mongodb.client.model.Filters
Creates a filter that performs a logical AND of the provided list of filters.
any(Function<? super T, MqlBoolean>) - Method in interface com.mongodb.client.model.mql.MqlArray
Whether any value in this array satisfies the predicate.
anyTokenOrder() - Method in interface com.mongodb.client.model.search.AutocompleteSearchOperator
Creates a new AutocompleteSearchOperator that does not require tokens to appear in the same order as they are specified.
append(MqlString) - Method in interface com.mongodb.client.model.mql.MqlString
The result of appending the other string to the end of this string (strict concatenation).
append(String, Object) - Method in class com.mongodb.BasicDBObject
Add a key/value pair to this object
append(String, Object) - Method in class com.mongodb.BasicDBObjectBuilder
Appends the key/value to the active object
applicationName(String) - Method in class com.mongodb.MongoClientSettings.Builder
Sets the logical name of the application using this MongoClient.
apply(T) - Method in interface com.mongodb.Block
Apply some logic to the value.
apply(T) - Method in interface com.mongodb.Function
Yield an appropriate result object for the input object.
applyConnectionString(ConnectionString) - Method in class com.mongodb.connection.ClusterSettings.Builder
Takes the settings from the given ConnectionString and applies them to the builder
applyConnectionString(ConnectionString) - Method in class com.mongodb.connection.ConnectionPoolSettings.Builder
Takes the settings from the given ConnectionString and applies them to the builder
applyConnectionString(ConnectionString) - Method in class com.mongodb.connection.ProxySettings.Builder
Takes the proxy settings from the given ConnectionString and applies them to the ProxySettings.Builder.
applyConnectionString(ConnectionString) - Method in class com.mongodb.connection.ServerSettings.Builder
Takes the settings from the given ConnectionString and applies them to the builder
applyConnectionString(ConnectionString) - Method in class com.mongodb.connection.SocketSettings.Builder
Takes the settings from the given ConnectionString and applies them to the builder
applyConnectionString(ConnectionString) - Method in class com.mongodb.connection.SslSettings.Builder
Takes the settings from the given ConnectionString and applies them to the builder
applyConnectionString(ConnectionString) - Method in class com.mongodb.MongoClientSettings.Builder
Takes the settings from the given ConnectionString and applies them to the builder
applySettings(ClusterSettings) - Method in class com.mongodb.connection.ClusterSettings.Builder
Applies the clusterSettings to the builder
applySettings(ConnectionPoolSettings) - Method in class com.mongodb.connection.ConnectionPoolSettings.Builder
Applies the connectionPoolSettings to the builder
applySettings(ProxySettings) - Method in class com.mongodb.connection.ProxySettings.Builder
Applies the provided ProxySettings to this builder instance.
applySettings(ServerSettings) - Method in class com.mongodb.connection.ServerSettings.Builder
Applies the serverSettings to the builder
applySettings(SocketSettings) - Method in class com.mongodb.connection.SocketSettings.Builder
Applies the socketSettings to the builder
applySettings(SslSettings) - Method in class com.mongodb.connection.SslSettings.Builder
Applies the sslSettings to the builder
applySettings(LoggerSettings) - Method in class com.mongodb.LoggerSettings.Builder
Applies the loggerSettings to the builder
applyToClusterSettings(Block<ClusterSettings.Builder>) - Method in class com.mongodb.MongoClientSettings.Builder
Applies the ClusterSettings.Builder block and then sets the clusterSettings.
applyToConnectionPoolSettings(Block<ConnectionPoolSettings.Builder>) - Method in class com.mongodb.MongoClientSettings.Builder
Applies the ConnectionPoolSettings.Builder block and then sets the connectionPoolSettings.
applyToLoggerSettings(Block<LoggerSettings.Builder>) - Method in class com.mongodb.MongoClientSettings.Builder
Applies the LoggerSettings.Builder block and then sets the loggerSettings.
applyToProxySettings(Block<ProxySettings.Builder>) - Method in class com.mongodb.connection.SocketSettings.Builder
Applies the ProxySettings.Builder block and then sets the SocketSettings.proxySettings.
applyToServerSettings(Block<ServerSettings.Builder>) - Method in class com.mongodb.MongoClientSettings.Builder
Applies the ServerSettings.Builder block and then sets the serverSettings.
applyToSocketSettings(Block<SocketSettings.Builder>) - Method in class com.mongodb.MongoClientSettings.Builder
Applies the SocketSettings.Builder block and then sets the socketSettings.
applyToSslSettings(Block<SslSettings.Builder>) - Method in class com.mongodb.MongoClientSettings.Builder
Applies the SslSettings.Builder block and then sets the sslSettings.
approximate() - Static method in interface com.mongodb.client.model.QuantileMethod
Returns a QuantileMethod instance representing the "approximate" quantile method.
ApproximateQuantileMethod - Interface in com.mongodb.client.model
 
approximateVectorSearchOptions(long) - Static method in interface com.mongodb.client.model.search.VectorSearchOptions
Returns ApproximateVectorSearchOptions that represents server defaults.
ApproximateVectorSearchOptions - Interface in com.mongodb.client.model.search
Represents optional fields of the $vectorSearch pipeline stage of an aggregation pipeline.
arbiters(Set<String>) - Method in class com.mongodb.connection.ServerDescription.Builder
Sets the arbiters in the replica set
arrayFilters(List<? extends Bson>) - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Sets the array filters option
arrayFilters(List<? extends Bson>) - Method in class com.mongodb.client.model.UpdateOptions
Sets the array filters option
asCallback() - Method in interface com.mongodb.connection.AsyncCompletionHandler
 
ascending(String...) - Static method in class com.mongodb.client.model.Indexes
Create an index key for an ascending index on the given fields.
ascending(String...) - Static method in class com.mongodb.client.model.Sorts
Create a sort specification for an ascending sort on the given fields.
ascending(List<String>) - Static method in class com.mongodb.client.model.Indexes
Create an index key for an ascending index on the given fields.
ascending(List<String>) - Static method in class com.mongodb.client.model.Sorts
Create a sort specification for an ascending sort on the given fields.
asDocument() - Method in class com.mongodb.client.model.Collation
Gets this collation options as a document.
asDocument() - Method in interface com.mongodb.client.model.mql.MqlMap
this map as a document.
asDocument() - Method in class com.mongodb.connection.TopologyVersion
Get the document representation of the topology version
asDocument() - Method in class com.mongodb.ReadConcern
Gets this read concern as a document.
asDocument() - Method in class com.mongodb.WriteConcern
Gets this write concern as a document.
asMap() - Method in interface com.mongodb.client.model.mql.MqlDocument
this document as a map.
asMap(Function<? super T, ? extends MqlEntry<? extends R>>) - Method in interface com.mongodb.client.model.mql.MqlArray
The map value corresponding to the entry values of this array, via the provided mapper.
asString() - Method in interface com.mongodb.client.model.mql.MqlValue
The string representation of this value.
asString(MqlString, MqlString) - Method in interface com.mongodb.client.model.mql.MqlDate
The string representation of this date as determined by the provided timezone, and formatted according to the format.
AsyncCompletionHandler<T> - Interface in com.mongodb.connection
Completion handler for asynchronous I/O.
AuthenticationMechanism - Enum Class in com.mongodb
An enumeration of the MongodDB-supported authentication mechanisms.
AUTO - Enum constant in enum class com.mongodb.connection.ServerMonitoringMode
Behave the same as ServerMonitoringMode.POLL if running in a FaaS environment, otherwise behave as ServerMonitoringMode.STREAM.
autocomplete(FieldSearchPath, Iterable<String>) - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a SearchOperator that may be used to implement search-as-you-type functionality.
autocomplete(FieldSearchPath, String, String...) - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a SearchOperator that may be used to implement search-as-you-type functionality.
AutocompleteSearchOperator - Interface in com.mongodb.client.model.search
 
autoEncryptionSettings(AutoEncryptionSettings) - Method in class com.mongodb.MongoClientSettings.Builder
Sets the auto-encryption settings
AutoEncryptionSettings - Class in com.mongodb
The client-side automatic encryption settings.
AutoEncryptionSettings.Builder - Class in com.mongodb
A builder for AutoEncryptionSettings so that AutoEncryptionSettings can be immutable, and to support easier construction through chaining.
AVAILABLE - Enum constant in enum class com.mongodb.ReadConcernLevel
The available read concern level.
AVAILABLE - Static variable in class com.mongodb.ReadConcern
The available read concern.
avg(String, TExpression) - Static method in class com.mongodb.client.model.Accumulators
Gets a field name for a $group operation representing the average of the values of the given expression when applied to all members of the group.
avg(String, TExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the average of the evaluation results of the expression over the window.
AWS_CREDENTIAL_PROVIDER_KEY - Static variable in class com.mongodb.MongoCredential
Mechanism property key for specifying a provider for an AWS credential, useful for refreshing a credential that could expire during the lifetime of the MongoClient with which it is associated.
AWS_SESSION_TOKEN_KEY - Static variable in class com.mongodb.MongoCredential
Mechanism property key for specifying the AWS session token.
AwsCredential - Class in com.mongodb
A representation of Amazon Web Services credentials for API authentication.
AwsCredential(String, String, String) - Constructor for class com.mongodb.AwsCredential
Construct a new instance.

B

background(boolean) - Method in class com.mongodb.client.model.IndexOptions
Should the index should be created in the background
backwards(Boolean) - Method in class com.mongodb.client.model.Collation.Builder
Sets the backwards value
BasicDBList - Class in com.mongodb
An implementation of List that reflects the way BSON lists work.
BasicDBList() - Constructor for class com.mongodb.BasicDBList
 
BasicDBObject - Class in com.mongodb
A basic implementation of BSON object that is MongoDB specific.
BasicDBObject() - Constructor for class com.mongodb.BasicDBObject
Creates an empty object.
BasicDBObject(int) - Constructor for class com.mongodb.BasicDBObject
Creates an empty object
BasicDBObject(String, Object) - Constructor for class com.mongodb.BasicDBObject
Creates an object with the given key/value
BasicDBObject(Map) - Constructor for class com.mongodb.BasicDBObject
Creates an object from a map.
BasicDBObjectBuilder - Class in com.mongodb
Utility for building complex objects.
BasicDBObjectBuilder() - Constructor for class com.mongodb.BasicDBObjectBuilder
Creates a builder intialized with an empty document.
BEFORE - Enum constant in enum class com.mongodb.client.model.ReturnDocument
Indicates to return the document before the update, replacement, or insert occurred.
Beta - Annotation Interface in com.mongodb.annotations
Signifies that a public API (public class, method or field) is subject to incompatible changes, or even removal, in a future release.
bits(Integer) - Method in class com.mongodb.client.model.IndexOptions
Sets the number of precision of the stored geohash value of the location data in 2d indexes.
bitsAllClear(String, long) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where all of the bit positions are clear in the field.
bitsAllSet(String, long) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where all of the bit positions are set in the field.
bitsAnyClear(String, long) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where any of the bit positions are clear in the field.
bitsAnySet(String, long) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where any of the bit positions are set in the field.
bitwiseAnd(String, int) - Static method in class com.mongodb.client.model.Updates
Creates an update that performs a bitwise and between the given integer value and the integral value of the field with the given name.
bitwiseAnd(String, long) - Static method in class com.mongodb.client.model.Updates
Creates an update that performs a bitwise and between the given long value and the integral value of the field with the given name.
bitwiseOr(String, int) - Static method in class com.mongodb.client.model.Updates
Creates an update that performs a bitwise or between the given integer value and the integral value of the field with the given name.
bitwiseOr(String, long) - Static method in class com.mongodb.client.model.Updates
Creates an update that performs a bitwise or between the given long value and the integral value of the field with the given name.
bitwiseXor(String, int) - Static method in class com.mongodb.client.model.Updates
Creates an update that performs a bitwise xor between the given integer value and the integral value of the field with the given name.
bitwiseXor(String, long) - Static method in class com.mongodb.client.model.Updates
Creates an update that performs a bitwise xor between the given long value and the integral value of the field with the given name.
Block<T> - Interface in com.mongodb
An interface for applying some logic against the given parameter.
boost(float) - Static method in interface com.mongodb.client.model.search.SearchScore
Returns a SearchScore that instructs to multiply the score by the specified value.
boost(FieldSearchPath) - Static method in interface com.mongodb.client.model.search.SearchScore
Returns a SearchScore that instructs to multiply the score by the value of the specified field.
bottom(String, Bson, OutExpression) - Static method in class com.mongodb.client.model.Accumulators
Returns a combination of a computed field and an accumulator that produces a value of the given outExpression computed for the bottom element within a group sorted according to the provided sortBy specification.
bottom(String, Bson, OutExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the evaluation result of the outExpression against the bottom document in the window sorted according to the provided sortBy specification.
bottomN(String, Bson, OutExpression, NExpression) - Static method in class com.mongodb.client.model.Accumulators
Returns a combination of a computed field and an accumulator that produces a BSON Array of values of the given outExpression computed for the bottom N elements within a group sorted according to the provided sortBy specification, where N is the positive integral value of the nExpression.
bottomN(String, Bson, OutExpression, NExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of a BSON Array of evaluation results of the outExpression against the bottom N documents in the window sorted according to the provided sortBy specification, where N is the positive integral value of the nExpression.
Branches<T extends MqlValue> - Class in com.mongodb.client.model.mql
BranchesIntermediary<T extends MqlValue,R extends MqlValue> - Class in com.mongodb.client.model.mql
BranchesTerminal<T extends MqlValue,R extends MqlValue> - Class in com.mongodb.client.model.mql
BsonField - Class in com.mongodb.client.model
A representation of a BSON document field whose value is another BSON document.
BsonField(String, Bson) - Constructor for class com.mongodb.client.model.BsonField
Construct an instance
BSONTimestampCodec - Class in com.mongodb
Knows how to encode and decode BSON timestamps.
BSONTimestampCodec() - Constructor for class com.mongodb.BSONTimestampCodec
 
bucket(TExpression, List<Boundary>) - Static method in class com.mongodb.client.model.Aggregates
Creates a $bucket pipeline stage
bucket(TExpression, List<TBoundary>, BucketOptions) - Static method in class com.mongodb.client.model.Aggregates
Creates a $bucket pipeline stage
bucketAuto(TExpression, int) - Static method in class com.mongodb.client.model.Aggregates
Creates a $bucketAuto pipeline stage
bucketAuto(TExpression, int, BucketAutoOptions) - Static method in class com.mongodb.client.model.Aggregates
Creates a $bucketAuto pipeline stage
BucketAutoOptions - Class in com.mongodb.client.model
The options for a $bucketAuto aggregation pipeline stage
BucketAutoOptions() - Constructor for class com.mongodb.client.model.BucketAutoOptions
 
BucketGranularity - Enum Class in com.mongodb.client.model
Granularity values for automatic bucketing.
bucketMaxSpan(Long, TimeUnit) - Method in class com.mongodb.client.model.TimeSeriesOptions
Sets the maximum time span between measurements in a bucket.
BucketOptions - Class in com.mongodb.client.model
The options for a $bucket aggregation pipeline stage
BucketOptions() - Constructor for class com.mongodb.client.model.BucketOptions
 
bucketRounding(Long, TimeUnit) - Method in class com.mongodb.client.model.TimeSeriesOptions
Specifies the time interval that determines the starting timestamp for a new bucket.
build() - Method in class com.mongodb.AutoEncryptionSettings.Builder
Build an instance of AutoEncryptionSettings.
build() - Method in class com.mongodb.client.model.Collation.Builder
Creates a new Collation object with the settings initialised on this builder.
build() - Method in class com.mongodb.ClientEncryptionSettings.Builder
Build an instance of ClientEncryptionSettings.
build() - Method in class com.mongodb.ClientSessionOptions.Builder
Build the session options instance.
build() - Method in class com.mongodb.connection.ClusterSettings.Builder
Build the settings from the builder.
build() - Method in class com.mongodb.connection.ConnectionPoolSettings.Builder
Creates a new ConnectionPoolSettings object with the settings initialised on this builder.
build() - Method in class com.mongodb.connection.NettyTransportSettings.Builder
Build an instance of NettyTransportSettings.
build() - Method in class com.mongodb.connection.ProxySettings.Builder
Build an instance of ProxySettings.
build() - Method in class com.mongodb.connection.ServerDescription.Builder
Create a new ServerDescription from the settings in this builder.
build() - Method in class com.mongodb.connection.ServerSettings.Builder
Create a new ServerSettings from the settings applied to this builder.
build() - Method in class com.mongodb.connection.SocketSettings.Builder
Build an instance of SocketSettings.
build() - Method in class com.mongodb.connection.SslSettings.Builder
Create a new SSLSettings from the settings in this builder.
build() - Method in class com.mongodb.LoggerSettings.Builder
Build an instance of LoggerSettings.
build() - Method in class com.mongodb.MongoClientSettings.Builder
Build an instance of MongoClientSettings.
build() - Method in class com.mongodb.MongoDriverInformation.Builder
 
build() - Method in class com.mongodb.ReadPreferenceHedgeOptions.Builder
Build the transaction options instance.
build() - Method in class com.mongodb.ServerApi.Builder
Build an instance of ServerApi.
build() - Method in class com.mongodb.TransactionOptions.Builder
Build the transaction options instance.
builder() - Static method in class com.mongodb.AutoEncryptionSettings
Convenience method to create a Builder.
builder() - Static method in class com.mongodb.client.model.Collation
Convenience method to create a Builder.
builder() - Static method in class com.mongodb.ClientEncryptionSettings
Convenience method to create a Builder.
builder() - Static method in class com.mongodb.ClientSessionOptions
Gets an instance of a builder
builder() - Static method in class com.mongodb.connection.ClusterSettings
Get a builder for this class.
builder() - Static method in class com.mongodb.connection.ConnectionPoolSettings
Gets a Builder for creating a new ConnectionPoolSettings instance.
builder() - Static method in class com.mongodb.connection.ProxySettings
Creates a ProxySettings.Builder for creating a new ProxySettings instance.
builder() - Static method in class com.mongodb.connection.ServerDescription
Gets a Builder for creating a new ServerDescription instance.
builder() - Static method in class com.mongodb.connection.ServerSettings
Creates a builder for ServerSettings.
builder() - Static method in class com.mongodb.connection.SocketSettings
Gets a builder for an instance of SocketSettings.
builder() - Static method in class com.mongodb.connection.SslSettings
Gets a Builder for creating a new SSLSettings instance.
builder() - Static method in class com.mongodb.LoggerSettings
Gets a builder for an instance of LoggerSettings.
builder() - Static method in class com.mongodb.MongoClientSettings
Convenience method to create a Builder.
builder() - Static method in class com.mongodb.MongoDriverInformation
Convenience method to create a Builder.
builder() - Static method in class com.mongodb.ReadPreferenceHedgeOptions
Gets an instance of a builder
builder() - Static method in class com.mongodb.ServerApi
Gets a Builder for instances of this class.
builder() - Static method in class com.mongodb.TransactionOptions
Gets an instance of a builder
builder(Collation) - Static method in class com.mongodb.client.model.Collation
Convenience method to create a from an existing Collation.
builder(ClientSessionOptions) - Static method in class com.mongodb.ClientSessionOptions
Gets an instance of a builder initialized with the given options
builder(ClusterSettings) - Static method in class com.mongodb.connection.ClusterSettings
Creates a builder instance.
builder(ConnectionPoolSettings) - Static method in class com.mongodb.connection.ConnectionPoolSettings
Gets a Builder for creating a new ConnectionPoolSettings instance.
builder(ProxySettings) - Static method in class com.mongodb.connection.ProxySettings
Creates a ProxySettings.Builder for creating a new ProxySettings instance.
builder(ServerDescription) - Static method in class com.mongodb.connection.ServerDescription
Creates a Builder for a ServerDescription instance based on a previous serverDescription.
builder(ServerSettings) - Static method in class com.mongodb.connection.ServerSettings
Creates a builder instance.
builder(SocketSettings) - Static method in class com.mongodb.connection.SocketSettings
Creates a builder instance.
builder(SslSettings) - Static method in class com.mongodb.connection.SslSettings
Creates a builder instance.
builder(LoggerSettings) - Static method in class com.mongodb.LoggerSettings
Creates a builder instance.
builder(MongoClientSettings) - Static method in class com.mongodb.MongoClientSettings
Convenience method to create a from an existing MongoClientSettings.
builder(MongoDriverInformation) - Static method in class com.mongodb.MongoDriverInformation
Convenience method to create a Builder.
BulkWriteError - Class in com.mongodb.bulk
Represents an error for an item included in a bulk write operation, e.g.
BulkWriteError(int, String, BsonDocument, int) - Constructor for class com.mongodb.bulk.BulkWriteError
Constructs a new instance.
BulkWriteInsert - Class in com.mongodb.bulk
Represents an item in the bulk write that was inserted.
BulkWriteInsert(int, BsonValue) - Constructor for class com.mongodb.bulk.BulkWriteInsert
Construct an instance.
BulkWriteOptions - Class in com.mongodb.client.model
The options to apply to a bulk write.
BulkWriteOptions() - Constructor for class com.mongodb.client.model.BulkWriteOptions
 
BulkWriteResult - Class in com.mongodb.bulk
The result of a successful bulk write operation.
BulkWriteResult() - Constructor for class com.mongodb.bulk.BulkWriteResult
 
BulkWriteUpsert - Class in com.mongodb.bulk
Represents an item in the bulk write that was upserted.
BulkWriteUpsert(int, BsonValue) - Constructor for class com.mongodb.bulk.BulkWriteUpsert
Construct an instance.
bypassAutoEncryption(boolean) - Method in class com.mongodb.AutoEncryptionSettings.Builder
Sets whether auto-encryption should be bypassed.
bypassDocumentValidation(Boolean) - Method in class com.mongodb.client.model.BulkWriteOptions
Sets the bypass document level validation flag.
bypassDocumentValidation(Boolean) - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Sets the bypass document level validation flag.
bypassDocumentValidation(Boolean) - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Sets the bypass document level validation flag.
bypassDocumentValidation(Boolean) - Method in class com.mongodb.client.model.InsertManyOptions
Sets the bypass document level validation flag.
bypassDocumentValidation(Boolean) - Method in class com.mongodb.client.model.InsertOneOptions
Sets the bypass document level validation flag.
bypassDocumentValidation(Boolean) - Method in class com.mongodb.client.model.ReplaceOptions
Sets the bypass document level validation flag.
bypassDocumentValidation(Boolean) - Method in class com.mongodb.client.model.UpdateOptions
Sets the bypass document level validation flag.
bypassQueryAnalysis(boolean) - Method in class com.mongodb.AutoEncryptionSettings.Builder
Enable or disable automatic analysis of outgoing commands.

C

canonicalAddress(String) - Method in class com.mongodb.connection.ServerDescription.Builder
Sets the canonical host name and port of this server.
CANONICALIZE_HOST_NAME_KEY - Static variable in class com.mongodb.MongoCredential
Mechanism property key for specifying whether to canonicalize the host name for GSSAPI authentication.
capped(boolean) - Method in class com.mongodb.client.model.CreateCollectionOptions
sets whether the collection is capped.
caseLevel(Boolean) - Method in class com.mongodb.client.model.Collation.Builder
Sets the case level value
caseSensitive(Boolean) - Method in class com.mongodb.client.model.TextSearchOptions
Set the case-sensitive flag for the text search
causallyConsistent(boolean) - Method in class com.mongodb.ClientSessionOptions.Builder
Sets whether operations using the session should causally consistent with each other.
ChangeStreamDocument<TDocument> - Class in com.mongodb.client.model.changestream
Represents the $changeStream aggregation output document.
ChangeStreamDocument(String, BsonDocument, BsonDocument, BsonDocument, TDocument, TDocument, BsonDocument, BsonTimestamp, UpdateDescription, BsonInt64, BsonDocument, BsonDateTime, SplitEvent, BsonDocument) - Constructor for class com.mongodb.client.model.changestream.ChangeStreamDocument
Creates a new instance
changeStreamPreAndPostImagesOptions(ChangeStreamPreAndPostImagesOptions) - Method in class com.mongodb.client.model.CreateCollectionOptions
Sets the change stream pre- and post- images options.
ChangeStreamPreAndPostImagesOptions - Class in com.mongodb.client.model
Options for change stream pre- and post- images.
ChangeStreamPreAndPostImagesOptions(boolean) - Constructor for class com.mongodb.client.model.ChangeStreamPreAndPostImagesOptions
Construct an instance
checkCollectionNameValidity(String) - Static method in class com.mongodb.MongoNamespace
Check the validity of the given collection name.
checkDatabaseNameValidity(String) - Static method in class com.mongodb.MongoNamespace
Check the validity of the given database name.
choose(ClusterDescription) - Method in class com.mongodb.ReadPreference
Chooses the servers from the given cluster than match this read preference.
chooseForNonReplicaSet(ClusterDescription) - Method in class com.mongodb.ReadPreference
Choose for non-replica sets.
chooseForNonReplicaSet(ClusterDescription) - Method in class com.mongodb.TaggableReadPreference
 
chooseForReplicaSet(ClusterDescription) - Method in class com.mongodb.ReadPreference
Choose for replica sets.
chunkSizeBytes(Integer) - Method in class com.mongodb.client.gridfs.model.GridFSUploadOptions
Sets the chunk size in bytes.
clearTransactionContext() - Method in interface com.mongodb.session.ClientSession
Clears the transaction context.
CLIENT - Enum constant in enum class com.mongodb.annotations.Reason
Indicates that the status of the driver API is the reason for the annotation.
ClientEncryptionSettings - Class in com.mongodb
The client-side settings for data key creation and explicit encryption.
ClientEncryptionSettings.Builder - Class in com.mongodb
A builder for ClientEncryptionSettings so that ClientEncryptionSettings can be immutable, and to support easier construction through chaining.
ClientSession - Interface in com.mongodb.session
A client session.
ClientSessionOptions - Class in com.mongodb
The options to apply to a ClientSession.
ClientSessionOptions.Builder - Class in com.mongodb
A builder for instances of ClientSession
close() - Method in interface com.mongodb.session.ClientSession
 
clusterClosed(ClusterClosedEvent) - Method in interface com.mongodb.event.ClusterListener
Invoked when a cluster is closed.
ClusterClosedEvent - Class in com.mongodb.event
A cluster closed event.
ClusterClosedEvent(ClusterId) - Constructor for class com.mongodb.event.ClusterClosedEvent
Constructs a new instance of the event.
ClusterConnectionMode - Enum Class in com.mongodb.connection
The cluster connection mode.
ClusterDescription - Class in com.mongodb.connection
Immutable snapshot state of a cluster.
ClusterDescription(ClusterConnectionMode, ClusterType, MongoException, List<ServerDescription>, ClusterSettings, ServerSettings) - Constructor for class com.mongodb.connection.ClusterDescription
Creates a new ClusterDescription.
ClusterDescription(ClusterConnectionMode, ClusterType, List<ServerDescription>) - Constructor for class com.mongodb.connection.ClusterDescription
Creates a new ClusterDescription.
ClusterDescription(ClusterConnectionMode, ClusterType, List<ServerDescription>, ClusterSettings, ServerSettings) - Constructor for class com.mongodb.connection.ClusterDescription
Creates a new ClusterDescription.
clusterDescriptionChanged(ClusterDescriptionChangedEvent) - Method in interface com.mongodb.event.ClusterListener
Invoked when a cluster description changes.
ClusterDescriptionChangedEvent - Class in com.mongodb.event
An event signifying that the cluster description has changed.
ClusterDescriptionChangedEvent(ClusterId, ClusterDescription, ClusterDescription) - Constructor for class com.mongodb.event.ClusterDescriptionChangedEvent
Constructs a new instance of the event.
clusteredIndexOptions(ClusteredIndexOptions) - Method in class com.mongodb.client.model.CreateCollectionOptions
Sets the clustered index collection options.
ClusteredIndexOptions - Class in com.mongodb.client.model
Options for cluster index on a collection.
ClusteredIndexOptions(Bson, boolean) - Constructor for class com.mongodb.client.model.ClusteredIndexOptions
Construct an instance with the required options.
ClusterId - Class in com.mongodb.connection
A client-generated identifier that uniquely identifies a connection to a MongoDB cluster, which could be sharded, replica set, or standalone.
ClusterId() - Constructor for class com.mongodb.connection.ClusterId
Construct an instance.
ClusterId(String) - Constructor for class com.mongodb.connection.ClusterId
Construct an instance.
ClusterListener - Interface in com.mongodb.event
A listener for cluster-related events.
clusterListenerList(List<ClusterListener>) - Method in class com.mongodb.connection.ClusterSettings.Builder
Sets the cluster listeners.
clusterOpening(ClusterOpeningEvent) - Method in interface com.mongodb.event.ClusterListener
Invoked when a cluster is opened.
ClusterOpeningEvent - Class in com.mongodb.event
A cluster opening event.
ClusterOpeningEvent(ClusterId) - Constructor for class com.mongodb.event.ClusterOpeningEvent
Constructs a new instance of the event.
ClusterSettings - Class in com.mongodb.connection
Settings for the cluster.
ClusterSettings.Builder - Class in com.mongodb.connection
A builder for the cluster settings.
ClusterType - Enum Class in com.mongodb.connection
An enumeration of all possible cluster types.
codecRegistry(CodecRegistry) - Method in class com.mongodb.MongoClientSettings.Builder
Sets the codec registry
collation(Collation) - Method in class com.mongodb.client.model.CountOptions
Sets the collation options
collation(Collation) - Method in class com.mongodb.client.model.CreateCollectionOptions
Sets the collation options
collation(Collation) - Method in class com.mongodb.client.model.CreateViewOptions
Sets the collation options
collation(Collation) - Method in class com.mongodb.client.model.DeleteOptions
Sets the collation options
collation(Collation) - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Sets the collation options
collation(Collation) - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Sets the collation options
collation(Collation) - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Sets the collation options
collation(Collation) - Method in class com.mongodb.client.model.IndexOptions
Sets the collation options
collation(Collation) - Method in class com.mongodb.client.model.ReplaceOptions
Sets the collation options
collation(Collation) - Method in class com.mongodb.client.model.UpdateOptions
Sets the collation options
Collation - Class in com.mongodb.client.model
The options regarding collation support in MongoDB 3.4+
Collation.Builder - Class in com.mongodb.client.model
A Collation builder.
collationAlternate(CollationAlternate) - Method in class com.mongodb.client.model.Collation.Builder
Sets the alternate
CollationAlternate - Enum Class in com.mongodb.client.model
Collation support allows the specific configuration of whether or not spaces and punctuation are considered base characters.
collationCaseFirst(CollationCaseFirst) - Method in class com.mongodb.client.model.Collation.Builder
Sets the collation case first value
CollationCaseFirst - Enum Class in com.mongodb.client.model
Collation support allows the specific configuration of how character cases are handled.
collationMaxVariable(CollationMaxVariable) - Method in class com.mongodb.client.model.Collation.Builder
Sets the maxVariable
CollationMaxVariable - Enum Class in com.mongodb.client.model
Collation support allows the specific configuration of whether or not spaces and punctuation are considered base characters.
collationStrength(CollationStrength) - Method in class com.mongodb.client.model.Collation.Builder
Sets the collation strength
CollationStrength - Enum Class in com.mongodb.client.model
Collation support allows the specific configuration of how differences between characters are handled.
com.mongodb - package com.mongodb
The core mongodb package
com.mongodb.annotations - package com.mongodb.annotations
Contains annotations that can apply to any part of the driver code.
com.mongodb.bulk - package com.mongodb.bulk
Contains classes for representing the result of a bulk write operation.
com.mongodb.client.cursor - package com.mongodb.client.cursor
This package contains models and options that help describe MongoCollection operations
com.mongodb.client.gridfs.codecs - package com.mongodb.client.gridfs.codecs
This package contains codecs for use with GridFS
com.mongodb.client.gridfs.model - package com.mongodb.client.gridfs.model
This package contains models for use with GridFS
com.mongodb.client.model - package com.mongodb.client.model
This package contains models and options that help describe MongoCollection operations
com.mongodb.client.model.changestream - package com.mongodb.client.model.changestream
This package contains classes for the change stream api
com.mongodb.client.model.densify - package com.mongodb.client.model.densify
 
com.mongodb.client.model.fill - package com.mongodb.client.model.fill
 
com.mongodb.client.model.geojson - package com.mongodb.client.model.geojson
This package contains classes that represent GeoJSON objects.
com.mongodb.client.model.geojson.codecs - package com.mongodb.client.model.geojson.codecs
This package contains classes that encode and decode GeoJSON objects.
com.mongodb.client.model.mql - package com.mongodb.client.model.mql
 
com.mongodb.client.model.search - package com.mongodb.client.model.search
Query building API for MongoDB Atlas full-text search.
com.mongodb.client.model.vault - package com.mongodb.client.model.vault
This package contains options classes for the key vault API
com.mongodb.client.result - package com.mongodb.client.result
This package contains classes representing operation results
com.mongodb.connection - package com.mongodb.connection
Contains classes that manage connecting to MongoDB servers.
com.mongodb.event - package com.mongodb.event
This package contains cluster and connection event related classes
com.mongodb.lang - package com.mongodb.lang
This package contains JSR 305-compatible annotations related to nullability.
com.mongodb.management - package com.mongodb.management
Contains classes for monitoring the server/driver via Java Management Extensions (JMX).
com.mongodb.selector - package com.mongodb.selector
Contains classes that determine how to select the server to connect to in order to send commands or queries.
com.mongodb.session - package com.mongodb.session
Contains classes related to sessions
com.mongodb.spi.dns - package com.mongodb.spi.dns
This package defines the Service Provider Interface (SPI) for a DNS provider.
combine(List<? extends Bson>) - Static method in class com.mongodb.client.model.Updates
Combine a list of updates into a single update.
combine(Bson...) - Static method in class com.mongodb.client.model.Updates
Combine a list of updates into a single update.
combineToBson(Iterable<? extends SearchFacet>) - Static method in interface com.mongodb.client.model.search.SearchFacet
Combines SearchFacets into a Bson.
COMMAND_COLLECTION_NAME - Static variable in class com.mongodb.MongoNamespace
The collection name in which to execute a command.
CommandEvent - Class in com.mongodb.event
An event representing a MongoDB database command.
CommandEvent(RequestContext, long, int, ConnectionDescription, String, String) - Constructor for class com.mongodb.event.CommandEvent
Construct an instance.
commandFailed(CommandFailedEvent) - Method in interface com.mongodb.event.CommandListener
Listener for command failure events
CommandFailedEvent - Class in com.mongodb.event
An event representing the failure of a MongoDB database command.
CommandFailedEvent(RequestContext, long, int, ConnectionDescription, String, String, long, Throwable) - Constructor for class com.mongodb.event.CommandFailedEvent
Construct an instance.
CommandListener - Interface in com.mongodb.event
A listener for command events
commandListenerList(List<CommandListener>) - Method in class com.mongodb.MongoClientSettings.Builder
Sets the command listeners
commandStarted(CommandStartedEvent) - Method in interface com.mongodb.event.CommandListener
Listener for command started events.
CommandStartedEvent - Class in com.mongodb.event
An event representing the start of a command execution.
CommandStartedEvent(RequestContext, long, int, ConnectionDescription, String, String, BsonDocument) - Constructor for class com.mongodb.event.CommandStartedEvent
Construct an instance.
commandSucceeded(CommandSucceededEvent) - Method in interface com.mongodb.event.CommandListener
Listener for command completed events
CommandSucceededEvent - Class in com.mongodb.event
An event representing the completion of a MongoDB database command.
CommandSucceededEvent(RequestContext, long, int, ConnectionDescription, String, String, BsonDocument, long) - Constructor for class com.mongodb.event.CommandSucceededEvent
Construct an instance.
comment(String) - Method in class com.mongodb.client.model.BulkWriteOptions
Sets the comment for this operation.
comment(String) - Method in class com.mongodb.client.model.CountOptions
Sets the comment for this operation.
comment(String) - Method in class com.mongodb.client.model.DeleteOptions
Sets the comment for this operation.
comment(String) - Method in class com.mongodb.client.model.EstimatedDocumentCountOptions
Sets the comment for this operation.
comment(String) - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Sets the comment for this operation.
comment(String) - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Sets the comment for this operation.
comment(String) - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Sets the comment for this operation.
comment(String) - Method in class com.mongodb.client.model.InsertManyOptions
Sets the comment for this operation.
comment(String) - Method in class com.mongodb.client.model.InsertOneOptions
Sets the comment for this operation.
comment(String) - Method in class com.mongodb.client.model.ReplaceOptions
Sets the comment for this operation.
comment(String) - Method in class com.mongodb.client.model.UpdateOptions
Sets the comment for this operation.
comment(BsonValue) - Method in class com.mongodb.client.model.BulkWriteOptions
Sets the comment for this operation.
comment(BsonValue) - Method in class com.mongodb.client.model.CountOptions
Sets the comment for this operation.
comment(BsonValue) - Method in class com.mongodb.client.model.DeleteOptions
Sets the comment for this operation.
comment(BsonValue) - Method in class com.mongodb.client.model.EstimatedDocumentCountOptions
Sets the comment for this operation.
comment(BsonValue) - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Sets the comment for this operation.
comment(BsonValue) - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Sets the comment for this operation.
comment(BsonValue) - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Sets the comment for this operation.
comment(BsonValue) - Method in class com.mongodb.client.model.InsertManyOptions
Sets the comment for this operation.
comment(BsonValue) - Method in class com.mongodb.client.model.InsertOneOptions
Sets the comment for this operation.
comment(BsonValue) - Method in class com.mongodb.client.model.ReplaceOptions
Sets the comment for this operation.
comment(BsonValue) - Method in class com.mongodb.client.model.UpdateOptions
Sets the comment for this operation.
commitQuorum(CreateIndexCommitQuorum) - Method in class com.mongodb.client.model.CreateIndexOptions
Sets the create index commit quorum for this operation.
compareTo(ServerVersion) - Method in class com.mongodb.connection.ServerVersion
 
completed(T) - Method in interface com.mongodb.connection.AsyncCompletionHandler
Invoked when an operation has completed.
CompositeServerSelector - Class in com.mongodb.selector
A server selector that composes a list of server selectors, and selects the servers by iterating through the list from start to finish, passing the result of the previous into the next, and finally returning the result of the last one.
CompositeServerSelector(List<? extends ServerSelector>) - Constructor for class com.mongodb.selector.CompositeServerSelector
Constructs a new instance.
compound() - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a base for a SearchOperator that may combine multiple SearchOperators.
compoundIndex(List<? extends Bson>) - Static method in class com.mongodb.client.model.Indexes
compound multiple index specifications.
compoundIndex(Bson...) - Static method in class com.mongodb.client.model.Indexes
create a compound index specifications.
CompoundSearchOperator - Interface in com.mongodb.client.model.search
 
CompoundSearchOperatorBase - Interface in com.mongodb.client.model.search
A base for a CompoundSearchOperator which allows creating instances of this operator.
compressorList(List<MongoCompressor>) - Method in class com.mongodb.MongoClientSettings.Builder
Sets the compressors to use for compressing messages to the server.
computed(String, TExpression) - Static method in class com.mongodb.client.model.Projections
Creates a projection of a field whose value is computed from the given expression.
computedSearchMeta(String) - Static method in class com.mongodb.client.model.Projections
Creates a projection of a field whose value is equal to the $$SEARCH_META variable, for use with Aggregates.search(SearchOperator, SearchOptions) / Aggregates.search(SearchCollector, SearchOptions).
concat(MqlArray<? extends T>) - Method in interface com.mongodb.client.model.mql.MqlArray
The result of concatenating this array first with the other array ensuing.
concatArrays(Function<? super T, ? extends MqlArray<? extends R>>) - Method in interface com.mongodb.client.model.mql.MqlArray
The array-concatenation of all the array values of this array, via the provided mapper.
cond(T, T) - Method in interface com.mongodb.client.model.mql.MqlBoolean
The ifTrue value when this is true, and the ifFalse value otherwise.
CONNECTED - Enum constant in enum class com.mongodb.connection.ServerConnectionState
The application is connected to the remote server.
CONNECTING - Enum constant in enum class com.mongodb.connection.ServerConnectionState
The application is actively attempting to connect to the remote server.
CONNECTION_ERROR - Enum constant in enum class com.mongodb.event.ConnectionCheckOutFailedEvent.Reason
The connection check out attempt experienced an error while setting up a new connection
connectionCheckedIn(ConnectionCheckedInEvent) - Method in interface com.mongodb.event.ConnectionPoolListener
Invoked when a connection is checked in to a pool.
connectionCheckedIn(ConnectionCheckedInEvent) - Method in class com.mongodb.management.JMXConnectionPoolListener
 
ConnectionCheckedInEvent - Class in com.mongodb.event
An event for checking in a connection to the pool.
ConnectionCheckedInEvent(ConnectionId, long) - Constructor for class com.mongodb.event.ConnectionCheckedInEvent
Construct an instance
connectionCheckedOut(ConnectionCheckedOutEvent) - Method in interface com.mongodb.event.ConnectionPoolListener
Invoked when a connection is checked out of a pool.
connectionCheckedOut(ConnectionCheckedOutEvent) - Method in class com.mongodb.management.JMXConnectionPoolListener
 
ConnectionCheckedOutEvent - Class in com.mongodb.event
An event for checking out a connection from the pool.
ConnectionCheckedOutEvent(ConnectionId, long, long) - Constructor for class com.mongodb.event.ConnectionCheckedOutEvent
Constructs an instance.
connectionCheckOutFailed(ConnectionCheckOutFailedEvent) - Method in interface com.mongodb.event.ConnectionPoolListener
Invoked when an attempt to check out a connection from a pool fails.
ConnectionCheckOutFailedEvent - Class in com.mongodb.event
An event for when checking out a connection fails.
ConnectionCheckOutFailedEvent(ServerId, long, ConnectionCheckOutFailedEvent.Reason, long) - Constructor for class com.mongodb.event.ConnectionCheckOutFailedEvent
Constructs an instance.
ConnectionCheckOutFailedEvent.Reason - Enum Class in com.mongodb.event
An enumeration of the reasons checking out a connection failed
connectionCheckOutStarted(ConnectionCheckOutStartedEvent) - Method in interface com.mongodb.event.ConnectionPoolListener
Invoked when attempting to check out a connection from a pool.
ConnectionCheckOutStartedEvent - Class in com.mongodb.event
An event for when the driver starts to check out a connection.
ConnectionCheckOutStartedEvent(ServerId, long) - Constructor for class com.mongodb.event.ConnectionCheckOutStartedEvent
Construct an instance
connectionClosed(ConnectionClosedEvent) - Method in interface com.mongodb.event.ConnectionPoolListener
Invoked when a connection is removed from a pool.
connectionClosed(ConnectionClosedEvent) - Method in class com.mongodb.management.JMXConnectionPoolListener
 
ConnectionClosedEvent - Class in com.mongodb.event
An event for when a connection pool closes a connection.
ConnectionClosedEvent(ConnectionId, ConnectionClosedEvent.Reason) - Constructor for class com.mongodb.event.ConnectionClosedEvent
Construct an instance
ConnectionClosedEvent.Reason - Enum Class in com.mongodb.event
An enumeration of the reasons a connection could be closed
connectionCreated(ConnectionCreatedEvent) - Method in interface com.mongodb.event.ConnectionPoolListener
Invoked when a connection is created.
connectionCreated(ConnectionCreatedEvent) - Method in class com.mongodb.management.JMXConnectionPoolListener
 
ConnectionCreatedEvent - Class in com.mongodb.event
An event for creating a connection in the pool.
ConnectionCreatedEvent(ConnectionId) - Constructor for class com.mongodb.event.ConnectionCreatedEvent
Construct an instance
ConnectionDescription - Class in com.mongodb.connection
A description of a connection to a MongoDB server.
ConnectionDescription(ConnectionId, int, ServerType, int, int, int, List<String>) - Constructor for class com.mongodb.connection.ConnectionDescription
Construct an instance.
ConnectionDescription(ConnectionId, int, ServerType, int, int, int, List<String>, BsonArray) - Constructor for class com.mongodb.connection.ConnectionDescription
Construct an instance.
ConnectionDescription(ConnectionId, int, ServerType, int, int, int, List<String>, BsonArray, Integer) - Constructor for class com.mongodb.connection.ConnectionDescription
Construct an instance.
ConnectionDescription(ServerId) - Constructor for class com.mongodb.connection.ConnectionDescription
Construct a defaulted connection description instance.
ConnectionDescription(ObjectId, ConnectionId, int, ServerType, int, int, int, List<String>, BsonArray) - Constructor for class com.mongodb.connection.ConnectionDescription
Construct an instance.
ConnectionId - Class in com.mongodb.connection
An immutable connection identifier of a connection to a MongoDB server.
ConnectionId(ServerId) - Constructor for class com.mongodb.connection.ConnectionId
Construct an instance with the given server id.
ConnectionId(ServerId, long, Long) - Constructor for class com.mongodb.connection.ConnectionId
Construct an instance with the given serverId, localValue, and serverValue.
connectionPoolCleared(ConnectionPoolClearedEvent) - Method in interface com.mongodb.event.ConnectionPoolListener
Invoked when a connection pool is cleared and paused.
ConnectionPoolClearedEvent - Class in com.mongodb.event
An event signifying when a connection pool is cleared and paused.
ConnectionPoolClearedEvent(ServerId) - Constructor for class com.mongodb.event.ConnectionPoolClearedEvent
Constructs a new instance of the event.
ConnectionPoolClearedEvent(ServerId, ObjectId) - Constructor for class com.mongodb.event.ConnectionPoolClearedEvent
Constructs a new instance of the event.
connectionPoolClosed(ConnectionPoolClosedEvent) - Method in interface com.mongodb.event.ConnectionPoolListener
Invoked when a connection pool is closed.
connectionPoolClosed(ConnectionPoolClosedEvent) - Method in class com.mongodb.management.JMXConnectionPoolListener
 
ConnectionPoolClosedEvent - Class in com.mongodb.event
An event signifying the closing of a connection pool.
ConnectionPoolClosedEvent(ServerId) - Constructor for class com.mongodb.event.ConnectionPoolClosedEvent
Constructs a new instance of the event.
connectionPoolCreated(ConnectionPoolCreatedEvent) - Method in interface com.mongodb.event.ConnectionPoolListener
Invoked when a connection pool is created.
connectionPoolCreated(ConnectionPoolCreatedEvent) - Method in class com.mongodb.management.JMXConnectionPoolListener
 
ConnectionPoolCreatedEvent - Class in com.mongodb.event
An event signifying that a connection pool was created.
ConnectionPoolCreatedEvent(ServerId, ConnectionPoolSettings) - Constructor for class com.mongodb.event.ConnectionPoolCreatedEvent
Constructs a new instance of the event.
ConnectionPoolListener - Interface in com.mongodb.event
A listener for connection pool-related events.
connectionPoolListenerList(List<ConnectionPoolListener>) - Method in class com.mongodb.connection.ConnectionPoolSettings.Builder
Sets the connection pool listeners.
connectionPoolReady(ConnectionPoolReadyEvent) - Method in interface com.mongodb.event.ConnectionPoolListener
Invoked when a connection pool is ready.
ConnectionPoolReadyEvent - Class in com.mongodb.event
An event signifying when a connection pool is ready.
ConnectionPoolReadyEvent(ServerId) - Constructor for class com.mongodb.event.ConnectionPoolReadyEvent
Constructs a new instance of the event.
ConnectionPoolSettings - Class in com.mongodb.connection
All settings that relate to the pool of connections to a MongoDB server.
ConnectionPoolSettings.Builder - Class in com.mongodb.connection
A builder for creating ConnectionPoolSettings.
ConnectionPoolStatisticsMBean - Interface in com.mongodb.management
A standard MXBean interface for a Mongo connection pool.
connectionReady(ConnectionReadyEvent) - Method in interface com.mongodb.event.ConnectionPoolListener
Invoked when a connection is ready for use.
ConnectionReadyEvent - Class in com.mongodb.event
An event for when a connection in the pool has finished being established.
ConnectionReadyEvent(ConnectionId, long) - Constructor for class com.mongodb.event.ConnectionReadyEvent
Constructs an instance.
ConnectionString - Class in com.mongodb
Represents a Connection String.
ConnectionString(String) - Constructor for class com.mongodb.ConnectionString
Creates a ConnectionString from the given string.
ConnectionString(String, DnsClient) - Constructor for class com.mongodb.ConnectionString
Creates a ConnectionString from the given string with the given DnsClient.
connectTimeout(long, TimeUnit) - Method in class com.mongodb.connection.SocketSettings.Builder
Sets the socket connect timeout.
constant(float) - Static method in interface com.mongodb.client.model.search.SearchScore
Returns a SearchScore that instructs to replace the score with the specified value.
constantExpression(float) - Static method in interface com.mongodb.client.model.search.SearchScoreExpression
Returns a SearchScoreExpression that evaluates into the specified value.
ConstantSearchScore - Interface in com.mongodb.client.model.search
 
ConstantSearchScoreExpression - Interface in com.mongodb.client.model.search
 
contains(T) - Method in interface com.mongodb.client.model.mql.MqlArray
Whether this array contains a value that is equal to the provided value.
containsAll(TagSet) - Method in class com.mongodb.TagSet
Returns true if this tag set contains all of the elements of the specified tag set.
contentionFactor(Long) - Method in class com.mongodb.client.model.vault.EncryptOptions
The contention factor.
context(SSLContext) - Method in class com.mongodb.connection.SslSettings.Builder
Sets the SSLContext for use when SSL is enabled.
contextProvider(ContextProvider) - Method in class com.mongodb.MongoClientSettings.Builder
Sets the context provider
ContextProvider - Interface in com.mongodb
A marker interface for providers of RequestContext.
CoordinateReferenceSystem - Class in com.mongodb.client.model.geojson
A GeoJSON Coordinate Reference System (CRS).
CoordinateReferenceSystem() - Constructor for class com.mongodb.client.model.geojson.CoordinateReferenceSystem
 
CoordinateReferenceSystemType - Enum Class in com.mongodb.client.model.geojson
An enumeration of the GeoJSON coordinate reference system types.
copy() - Method in class com.mongodb.BasicDBList
Copies this instance into a new Object.
copy() - Method in class com.mongodb.BasicDBObject
Creates a new instance which is a copy of this BasicDBObject.
count() - Static method in class com.mongodb.client.model.Aggregates
Creates a $count pipeline stage using the field name "count" to store the result
count(SearchCount) - Method in interface com.mongodb.client.model.search.SearchOptions
Creates a new SearchOptions with the counting options specified.
count(String) - Static method in class com.mongodb.client.model.Aggregates
Creates a $count pipeline stage using the named field to store the result
count(String, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the number of documents in the window.
CountOptions - Class in com.mongodb.client.model
The options for a count operation.
CountOptions() - Constructor for class com.mongodb.client.model.CountOptions
 
covariancePop(String, TExpression, TExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the population covariance between the evaluation results of the two expressions over the window.
covarianceSamp(String, TExpression, TExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the sample covariance between the evaluation results of the two expressions over the window.
create() - Method in interface com.mongodb.spi.dns.DnsClientProvider
Construct a new instance of a DnsClient.
create() - Method in interface com.mongodb.spi.dns.InetAddressResolverProvider
Construct a new instance of a InetAddressResolver.
create(int) - Static method in class com.mongodb.CreateIndexCommitQuorum
Create a create index commit quorum with a w value.
create(String) - Static method in class com.mongodb.CreateIndexCommitQuorum
Create a create index commit quorum with a mode value.
createAwsCredential(String, char[]) - Static method in class com.mongodb.MongoCredential
Creates a MongoCredential instance for the MONGODB-AWS mechanism.
createCodec(Class<TFullDocument>, CodecRegistry) - Static method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Creates the codec for the specific ChangeStreamOutput type
CreateCollectionOptions - Class in com.mongodb.client.model
Options for creating a collection
CreateCollectionOptions() - Constructor for class com.mongodb.client.model.CreateCollectionOptions
Construct a new instance
CreateCollectionOptions(CreateCollectionOptions) - Constructor for class com.mongodb.client.model.CreateCollectionOptions
A shallow copy constructor.
createCredential(String, String, char[]) - Static method in class com.mongodb.MongoCredential
Creates a MongoCredential instance with an unspecified mechanism.
CreateEncryptedCollectionParams - Class in com.mongodb.client.model
Auxiliary parameters for creating an encrypted collection.
CreateEncryptedCollectionParams(String) - Constructor for class com.mongodb.client.model.CreateEncryptedCollectionParams
 
createGSSAPICredential(String) - Static method in class com.mongodb.MongoCredential
Creates a MongoCredential instance for the GSSAPI SASL mechanism.
CreateIndexCommitQuorum - Class in com.mongodb
A commit quorum specifies how many data-bearing members of a replica set, including the primary, must complete the index builds successfully before the primary marks the indexes as ready.
CreateIndexOptions - Class in com.mongodb.client.model
The options to apply to the command when creating indexes.
CreateIndexOptions() - Constructor for class com.mongodb.client.model.CreateIndexOptions
 
createMongoX509Credential() - Static method in class com.mongodb.MongoCredential
Creates a MongoCredential instance for the MongoDB X.509 protocol where the distinguished subject name of the client certificate acts as the userName.
createMongoX509Credential(String) - Static method in class com.mongodb.MongoCredential
Creates a MongoCredential instance for the MongoDB X.509 protocol.
createOidcCredential(String) - Static method in class com.mongodb.MongoCredential
Creates a MongoCredential instance for the MONGODB-OIDC mechanism.
createPlainCredential(String, String, char[]) - Static method in class com.mongodb.MongoCredential
Creates a MongoCredential instance for the PLAIN SASL mechanism.
createScramSha1Credential(String, String, char[]) - Static method in class com.mongodb.MongoCredential
Creates a MongoCredential instance for the SCRAM-SHA-1 SASL mechanism.
createScramSha256Credential(String, String, char[]) - Static method in class com.mongodb.MongoCredential
Creates a MongoCredential instance for the SCRAM-SHA-256 SASL mechanism.
createSnappyCompressor() - Static method in class com.mongodb.MongoCompressor
Create an instance for snappy compression.
CreateViewOptions - Class in com.mongodb.client.model
Options for creating a view
CreateViewOptions() - Constructor for class com.mongodb.client.model.CreateViewOptions
 
createZlibCompressor() - Static method in class com.mongodb.MongoCompressor
Create an instance for zlib compression.
createZstdCompressor() - Static method in class com.mongodb.MongoCompressor
Create an instance for zstd compression.
credential(MongoCredential) - Method in class com.mongodb.MongoClientSettings.Builder
Sets the credential.
CRS_84 - Static variable in class com.mongodb.client.model.geojson.NamedCoordinateReferenceSystem
The urn:ogc:def:crs:OGC:1.3:CRS84 Coordinate Reference System
cryptd(boolean) - Method in class com.mongodb.connection.ServerDescription.Builder
Sets whether this server is a mongocryptd.
current() - Static method in class com.mongodb.client.model.mql.MqlValues
Returns a reference to the "current" document value.
CURRENT - Enum constant in enum class com.mongodb.client.model.Windows.Bound
The window bound is determined by the current document and is inclusive.
currentAsMap() - Static method in class com.mongodb.client.model.mql.MqlValues
Returns a reference to the "current" value as a map value.
currentDate(String) - Static method in class com.mongodb.client.model.Updates
Creates an update that sets the value of the field to the current date as a BSON date.
currentTimestamp(String) - Static method in class com.mongodb.client.model.Updates
Creates an update that sets the value of the field to the current date as a BSON timestamp.
CURSOR_LIFETIME - Enum constant in enum class com.mongodb.client.cursor.TimeoutMode
The timeout lasts for the lifetime of the cursor
CursorType - Enum Class in com.mongodb
An enumeration of cursor types.

D

DataKeyOptions - Class in com.mongodb.client.model.vault
The options for creating a data key.
DataKeyOptions() - Constructor for class com.mongodb.client.model.vault.DataKeyOptions
 
DateDensifyRange - Interface in com.mongodb.client.model.densify
 
dateFacet(String, FieldSearchPath, Iterable<Instant>) - Static method in interface com.mongodb.client.model.search.SearchFacet
Returns a SearchFacet that allows determining the frequency of BSON Date values in the search results by breaking the results into separate ranges.
DateNearSearchOperator - Interface in com.mongodb.client.model.search
 
dateRange(FieldSearchPath, FieldSearchPath...) - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a base for a SearchOperator that tests if the BSON Date values of the specified fields are within an interval.
dateRange(Iterable<? extends FieldSearchPath>) - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a base for a SearchOperator that tests if the BSON Date values of the specified fields are within an interval.
DateRangeSearchOperator - Interface in com.mongodb.client.model.search
 
DateRangeSearchOperatorBase - Interface in com.mongodb.client.model.search
A base for a DateRangeSearchOperator which allows creating instances of this operator.
DateSearchFacet - Interface in com.mongodb.client.model.search
 
DAY - Enum constant in enum class com.mongodb.client.model.MongoTimeUnit
dayOfMonth(MqlString) - Method in interface com.mongodb.client.model.mql.MqlDate
The day of the month of this date as determined by the provided timezone, as an integer between 1 and 31.
dayOfWeek(MqlString) - Method in interface com.mongodb.client.model.mql.MqlDate
The day of the week of this date as determined by the provided timezone, as an integer between 1 (Sunday) and 7 (Saturday).
dayOfYear(MqlString) - Method in interface com.mongodb.client.model.mql.MqlDate
The day of the year of this date as determined by the provided timezone, as an integer between 1 and 366.
DBObject - Interface in com.mongodb
This interface adds some specific behaviour to BSONObject for MongoDB documents.
DBObjectCodec - Class in com.mongodb
A collectible codec for a DBObject.
DBObjectCodec() - Constructor for class com.mongodb.DBObjectCodec
Construct an instance with the default codec registry
DBObjectCodec(CodecRegistry) - Constructor for class com.mongodb.DBObjectCodec
Construct an instance with the given codec registry.
DBObjectCodec(CodecRegistry, BsonTypeClassMap) - Constructor for class com.mongodb.DBObjectCodec
Construct an instance.
DBObjectCodec(CodecRegistry, BsonTypeClassMap, DBObjectFactory) - Constructor for class com.mongodb.DBObjectCodec
Construct an instance.
DBObjectCodecProvider - Class in com.mongodb
A provider for a DBObjectCodec.
DBObjectCodecProvider() - Constructor for class com.mongodb.DBObjectCodecProvider
Construct an instance using the default BsonTypeClassMap.
DBObjectCodecProvider(BsonTypeClassMap) - Constructor for class com.mongodb.DBObjectCodecProvider
Construct an instance with the given BsonTypeClassMap.
DBRef - Class in com.mongodb
A representation of a database reference.
DBRef(String, Object) - Constructor for class com.mongodb.DBRef
Construct an instance.
DBRef(String, String, Object) - Constructor for class com.mongodb.DBRef
Construct an instance.
DBRefCodec - Class in com.mongodb
A Codec for DBRef instances.
DBRefCodec(CodecRegistry) - Constructor for class com.mongodb.DBRefCodec
Construct an instance with the given registry, which is used to encode the id of the referenced document.
DBRefCodecProvider - Class in com.mongodb
A codec provider for DBRef.
DBRefCodecProvider() - Constructor for class com.mongodb.DBRefCodecProvider
 
decay(double) - Method in interface com.mongodb.client.model.search.GaussSearchScoreExpression
Creates a new GaussSearchScoreExpression with the factor by which the output of the Gaussian function must decay at distance scale.
decode(BsonReader, DecoderContext) - Method in class com.mongodb.BSONTimestampCodec
 
decode(BsonReader, DecoderContext) - Method in class com.mongodb.client.gridfs.codecs.GridFSFileCodec
 
decode(BsonReader, DecoderContext) - Method in class com.mongodb.client.model.geojson.codecs.PolygonCodec
 
decode(BsonReader, DecoderContext) - Method in class com.mongodb.client.model.geojson.codecs.NamedCoordinateReferenceSystemCodec
 
decode(BsonReader, DecoderContext) - Method in class com.mongodb.DBObjectCodec
 
decode(BsonReader, DecoderContext) - Method in class com.mongodb.DBRefCodec
 
DEFAULT - Enum constant in enum class com.mongodb.client.model.changestream.FullDocument
Default
DEFAULT - Enum constant in enum class com.mongodb.client.model.changestream.FullDocumentBeforeChange
The default value
DEFAULT - Static variable in class com.mongodb.ReadConcern
Use the servers default read concern.
DEFAULT_ALLOWED_HOSTS - Static variable in class com.mongodb.MongoCredential
The list of allowed hosts that will be used if no MongoCredential.ALLOWED_HOSTS_KEY value is supplied.
defaultBucket(Object) - Method in class com.mongodb.client.model.BucketOptions
The name of the default bucket for values outside the defined buckets
defaultBucket(String) - Method in interface com.mongodb.client.model.search.DateSearchFacet
Creates a new DateSearchFacet with the default bucket specified.
defaultBucket(String) - Method in interface com.mongodb.client.model.search.NumberSearchFacet
Creates a new NumberSearchFacet with the default bucket specified.
defaultHost() - Static method in class com.mongodb.ServerAddress
Returns the default database host: "127.0.0.1"
defaultLanguage(String) - Method in class com.mongodb.client.model.IndexOptions
Sets the language for the text index.
defaultPort() - Static method in class com.mongodb.ServerAddress
Returns the default database port: 27017
defaults(Function<? super T, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
If no other check succeeds, produces a value specified by the mapping.
defaultTimeout(long, TimeUnit) - Method in class com.mongodb.ClientSessionOptions.Builder
Sets the default time limit for the following operations executed on the session: commitTransaction abortTransaction withTransaction close
defaultTransactionOptions(TransactionOptions) - Method in class com.mongodb.ClientSessionOptions.Builder
Sets whether operations using the session should causally consistent with each other.
delete(Object) - Method in interface com.mongodb.RequestContext
Delete the given key and its associated value from the RequestContext.
DELETE - Enum constant in enum class com.mongodb.client.model.changestream.OperationType
The delete operation type
DeleteManyModel<T> - Class in com.mongodb.client.model
A model describing the removal of all documents matching the query filter.
DeleteManyModel(Bson) - Constructor for class com.mongodb.client.model.DeleteManyModel
Construct a new instance.
DeleteManyModel(Bson, DeleteOptions) - Constructor for class com.mongodb.client.model.DeleteManyModel
Construct a new instance.
DeleteOneModel<T> - Class in com.mongodb.client.model
A model describing the removal of at most one document matching the query filter.
DeleteOneModel(Bson) - Constructor for class com.mongodb.client.model.DeleteOneModel
Construct a new instance.
DeleteOneModel(Bson, DeleteOptions) - Constructor for class com.mongodb.client.model.DeleteOneModel
Construct a new instance.
DeleteOptions - Class in com.mongodb.client.model
The options to apply when deleting documents.
DeleteOptions() - Constructor for class com.mongodb.client.model.DeleteOptions
 
DeleteResult - Class in com.mongodb.client.result
The result of a delete operation.
DeleteResult() - Constructor for class com.mongodb.client.result.DeleteResult
 
denseRank(String) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the dense rank of each document in its partition.
densify(String, DensifyRange) - Static method in class com.mongodb.client.model.Aggregates
Creates a $densify pipeline stage, which adds documents to a sequence of documents where certain values in the field are missing.
densify(String, DensifyRange, DensifyOptions) - Static method in class com.mongodb.client.model.Aggregates
Creates a $densify pipeline stage, which adds documents to a sequence of documents where certain values in the field are missing.
densifyOptions() - Static method in interface com.mongodb.client.model.densify.DensifyOptions
Returns DensifyOptions that represents server defaults.
DensifyOptions - Interface in com.mongodb.client.model.densify
Represents optional fields of the $densify pipeline stage of an aggregation pipeline.
DensifyRange - Interface in com.mongodb.client.model.densify
A specification of how to compute the missing field values for which new documents must be added.
deprecationErrors(boolean) - Method in class com.mongodb.ServerApi.Builder
Sets whether the application requires use of deprecated server APIs to be reported as errors.
depthField(String) - Method in class com.mongodb.client.model.GraphLookupOptions
The name of the field in which to store the depth value
derivative(String, TExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the time derivative by subtracting the evaluation result of the expression against the last document and the first document in the window and dividing it by the difference in the values of the sortBy field of the respective documents.
descending(String...) - Static method in class com.mongodb.client.model.Indexes
Create an index key for an descending index on the given fields.
descending(String...) - Static method in class com.mongodb.client.model.Sorts
Create a sort specification for a descending sort on the given fields.
descending(List<String>) - Static method in class com.mongodb.client.model.Indexes
Create an index key for an descending index on the given fields.
descending(List<String>) - Static method in class com.mongodb.client.model.Sorts
Create a sort specification for a descending sort on the given fields.
diacriticSensitive(Boolean) - Method in class com.mongodb.client.model.TextSearchOptions
Set the diacritic-sensitive flag for the text search
DISCARD - Enum constant in enum class com.mongodb.client.model.MergeOptions.WhenNotMatched
Discard the document; i.e.
distanceMultiplier(Number) - Method in interface com.mongodb.client.model.GeoNearOptions
 
distinct() - Method in interface com.mongodb.client.model.mql.MqlArray
An array containing only the distinct values of this array.
divide(MqlNumber) - Method in interface com.mongodb.client.model.mql.MqlNumber
The quotient of dividing this value by the other value.
divide(Number) - Method in interface com.mongodb.client.model.mql.MqlNumber
The quotient of dividing this value by the other value.
dnsClient(DnsClient) - Method in class com.mongodb.MongoClientSettings.Builder
Sets the DnsClient to use for resolving DNS queries.
DnsClient - Interface in com.mongodb.spi.dns
An interface describing a DNS client.
DnsClientProvider - Interface in com.mongodb.spi.dns
Service-provider class for DnsClient.
DnsException - Exception in com.mongodb.spi.dns
An exception indicating a DNS error;
DnsException(String, Throwable) - Constructor for exception com.mongodb.spi.dns.DnsException
Construct an instance
DnsWithResponseCodeException - Exception in com.mongodb.spi.dns
An exception indicating a DNS error that includes a response code.
DnsWithResponseCodeException(String, int, Throwable) - Constructor for exception com.mongodb.spi.dns.DnsWithResponseCodeException
Construct an instance
documentHasId(DBObject) - Method in class com.mongodb.DBObjectCodec
 
documentNumber(String) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the order number of each document in its partition.
documents(int, int) - Static method in class com.mongodb.client.model.Windows
Creates a documents window whose bounds are determined by a number of documents before and after the current document.
documents(int, Windows.Bound) - Static method in class com.mongodb.client.model.Windows
Creates a documents window whose bounds are determined by a number of documents before and after the current document.
documents(Windows.Bound, int) - Static method in class com.mongodb.client.model.Windows
Creates a documents window whose bounds are determined by a number of documents before and after the current document.
documents(Windows.Bound, Windows.Bound) - Static method in class com.mongodb.client.model.Windows
Creates a documents window whose bounds are determined by a number of documents before and after the current document.
documents(List<? extends Bson>) - Static method in class com.mongodb.client.model.Aggregates
Creates a $documents pipeline stage.
DocumentToDBRefTransformer - Class in com.mongodb
A Document to DBRef Transformer.
DocumentToDBRefTransformer() - Constructor for class com.mongodb.DocumentToDBRefTransformer
 
driverName(String) - Method in class com.mongodb.MongoDriverInformation.Builder
Sets the name
driverPlatform(String) - Method in class com.mongodb.MongoDriverInformation.Builder
Sets the platform
driverVersion(String) - Method in class com.mongodb.MongoDriverInformation.Builder
Sets the version
DROP - Enum constant in enum class com.mongodb.client.model.changestream.OperationType
The drop operation type
DROP_DATABASE - Enum constant in enum class com.mongodb.client.model.changestream.OperationType
The dropDatabase operation type
DropCollectionOptions - Class in com.mongodb.client.model
Options for dropping a collection
DropCollectionOptions() - Constructor for class com.mongodb.client.model.DropCollectionOptions
 
DropIndexOptions - Class in com.mongodb.client.model
The options to apply to the command when dropping indexes.
DropIndexOptions() - Constructor for class com.mongodb.client.model.DropIndexOptions
 
dropTarget(boolean) - Method in class com.mongodb.client.model.RenameCollectionOptions
Sets if mongod should drop the target of renameCollection prior to renaming the collection.
DUPLICATE_KEY - Enum constant in enum class com.mongodb.ErrorCategory
A duplicate key error
DuplicateKeyException - Exception in com.mongodb
The legacy WriteConcernException, thrown when trying to insert or update a document containing a duplicate key.
DuplicateKeyException(BsonDocument, ServerAddress, WriteConcernResult) - Constructor for exception com.mongodb.DuplicateKeyException
Construct an instance.

E

E12 - Enum constant in enum class com.mongodb.client.model.BucketGranularity
E12
E192 - Enum constant in enum class com.mongodb.client.model.BucketGranularity
E192
E24 - Enum constant in enum class com.mongodb.client.model.BucketGranularity
E24
E48 - Enum constant in enum class com.mongodb.client.model.BucketGranularity
E48
E6 - Enum constant in enum class com.mongodb.client.model.BucketGranularity
E6
E96 - Enum constant in enum class com.mongodb.client.model.BucketGranularity
E96
electionId(ObjectId) - Method in class com.mongodb.connection.ServerDescription.Builder
Sets the electionId reported by this server.
elementAt(int) - Method in interface com.mongodb.client.model.mql.MqlArray
Returns the element at the provided index i for this array.
elementAt(MqlInteger) - Method in interface com.mongodb.client.model.mql.MqlArray
Returns the element at the provided index i for this array.
elemMatch(String) - Static method in class com.mongodb.client.model.Projections
Creates a projection that includes for the given field only the first element of an array that matches the query filter.
elemMatch(String, Bson) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field that is an array where at least one member of the array matches the given filter.
elemMatch(String, Bson) - Static method in class com.mongodb.client.model.Projections
Creates a projection that includes for the given field only the first element of the array value of that field that matches the given query filter.
empty() - Static method in class com.mongodb.client.model.Filters
Creates an empty filter that will match all documents.
enabled(boolean) - Method in class com.mongodb.connection.SslSettings.Builder
Define whether SSL should be enabled.
enabled(boolean) - Method in class com.mongodb.ReadPreferenceHedgeOptions.Builder
Sets whether hedged reads are enabled in the server.
encode(BsonWriter, GridFSFile, EncoderContext) - Method in class com.mongodb.client.gridfs.codecs.GridFSFileCodec
 
encode(BsonWriter, NamedCoordinateReferenceSystem, EncoderContext) - Method in class com.mongodb.client.model.geojson.codecs.NamedCoordinateReferenceSystemCodec
 
encode(BsonWriter, DBObject, EncoderContext) - Method in class com.mongodb.DBObjectCodec
 
encode(BsonWriter, DBRef, EncoderContext) - Method in class com.mongodb.DBRefCodec
 
encode(BsonWriter, BSONTimestamp, EncoderContext) - Method in class com.mongodb.BSONTimestampCodec
 
encode(BsonWriter, Polygon, EncoderContext) - Method in class com.mongodb.client.model.geojson.codecs.PolygonCodec
 
encryptedFields(Bson) - Method in class com.mongodb.client.model.CreateCollectionOptions
Sets the encrypted fields
encryptedFields(Bson) - Method in class com.mongodb.client.model.DropCollectionOptions
Sets the encrypted fields document
encryptedFieldsMap(Map<String, BsonDocument>) - Method in class com.mongodb.AutoEncryptionSettings.Builder
Maps a collection namespace to an encryptedFields.
EncryptOptions - Class in com.mongodb.client.model.vault
The options for explicit encryption.
EncryptOptions(String) - Constructor for class com.mongodb.client.model.vault.EncryptOptions
Construct an instance with the given algorithm.
entries() - Method in interface com.mongodb.client.model.mql.MqlMap
The entries of this map as an array.
ENVIRONMENT_KEY - Static variable in class com.mongodb.MongoCredential
Mechanism property key for specifying the environment for OIDC, which is the name of a built-in OIDC application environment integration to use to obtain credentials.
EPSG_4326 - Static variable in class com.mongodb.client.model.geojson.NamedCoordinateReferenceSystem
The EPSG:4326 Coordinate Reference System.
EPSG_4326_STRICT_WINDING - Static variable in class com.mongodb.client.model.geojson.NamedCoordinateReferenceSystem
A custom MongoDB EPSG:4326 Coordinate Reference System that uses a strict counter-clockwise winding order.
eq(MqlValue) - Method in interface com.mongodb.client.model.mql.MqlValue
Whether this value is equal to the other value.
eq(String, TItem) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of the field name equals the specified value.
eq(TItem) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of _id field equals the specified value.
eq(T, Function<? super T, ? extends R>) - Method in class com.mongodb.client.model.mql.Branches
A successful check for equality produces a value specified by the mapping.
eq(T, Function<? super T, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
A successful check for equality produces a value specified by the mapping.
equals(Object) - Method in class com.mongodb.BasicDBObject
 
equals(Object) - Method in class com.mongodb.bulk.BulkWriteError
 
equals(Object) - Method in class com.mongodb.bulk.BulkWriteInsert
 
equals(Object) - Method in class com.mongodb.bulk.BulkWriteUpsert
 
equals(Object) - Method in class com.mongodb.bulk.WriteConcernError
 
equals(Object) - Method in class com.mongodb.client.gridfs.model.GridFSFile
 
equals(Object) - Method in class com.mongodb.client.model.BsonField
 
equals(Object) - Method in class com.mongodb.client.model.BucketAutoOptions
 
equals(Object) - Method in class com.mongodb.client.model.BucketOptions
 
equals(Object) - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
 
equals(Object) - Method in class com.mongodb.client.model.changestream.SplitEvent
 
equals(Object) - Method in class com.mongodb.client.model.changestream.TruncatedArray
 
equals(Object) - Method in class com.mongodb.client.model.changestream.UpdateDescription
 
equals(Object) - Method in class com.mongodb.client.model.Collation
 
equals(Object) - Method in class com.mongodb.client.model.Facet
 
equals(Object) - Method in class com.mongodb.client.model.Field
 
equals(Object) - Method in class com.mongodb.client.model.geojson.Geometry
 
equals(Object) - Method in class com.mongodb.client.model.geojson.GeometryCollection
 
equals(Object) - Method in class com.mongodb.client.model.geojson.LineString
 
equals(Object) - Method in class com.mongodb.client.model.geojson.MultiLineString
 
equals(Object) - Method in class com.mongodb.client.model.geojson.MultiPoint
 
equals(Object) - Method in class com.mongodb.client.model.geojson.MultiPolygon
 
equals(Object) - Method in class com.mongodb.client.model.geojson.NamedCoordinateReferenceSystem
 
equals(Object) - Method in class com.mongodb.client.model.geojson.Point
 
equals(Object) - Method in class com.mongodb.client.model.geojson.Polygon
 
equals(Object) - Method in class com.mongodb.client.model.geojson.PolygonCoordinates
 
equals(Object) - Method in class com.mongodb.client.model.geojson.Position
 
equals(Object) - Method in class com.mongodb.client.model.GraphLookupOptions
 
equals(Object) - Method in class com.mongodb.client.model.MergeOptions
 
equals(Object) - Method in interface com.mongodb.client.model.mql.MqlValue
The method MqlValue.eq(com.mongodb.client.model.mql.MqlValue) should be used to compare values for equality.
equals(Object) - Method in class com.mongodb.client.model.PushOptions
 
equals(Object) - Method in class com.mongodb.client.model.TextSearchOptions
 
equals(Object) - Method in class com.mongodb.client.model.Variable
 
equals(Object) - Method in class com.mongodb.ClientSessionOptions
 
equals(Object) - Method in class com.mongodb.connection.ClusterDescription
 
equals(Object) - Method in class com.mongodb.connection.ClusterId
 
equals(Object) - Method in class com.mongodb.connection.ClusterSettings
 
equals(Object) - Method in class com.mongodb.connection.ConnectionDescription
 
equals(Object) - Method in class com.mongodb.connection.ConnectionId
 
equals(Object) - Method in class com.mongodb.connection.ConnectionPoolSettings
 
equals(Object) - Method in class com.mongodb.connection.ProxySettings
 
equals(Object) - Method in class com.mongodb.connection.ServerDescription
 
equals(Object) - Method in class com.mongodb.connection.ServerId
 
equals(Object) - Method in class com.mongodb.connection.ServerSettings
 
equals(Object) - Method in class com.mongodb.connection.ServerVersion
 
equals(Object) - Method in class com.mongodb.connection.SocketSettings
 
equals(Object) - Method in class com.mongodb.connection.SslSettings
 
equals(Object) - Method in class com.mongodb.connection.TopologyVersion
 
equals(Object) - Method in class com.mongodb.ConnectionString
 
equals(Object) - Method in class com.mongodb.DBObjectCodecProvider
 
equals(Object) - Method in class com.mongodb.DBRef
 
equals(Object) - Method in class com.mongodb.DBRefCodecProvider
 
equals(Object) - Method in class com.mongodb.DocumentToDBRefTransformer
 
equals(Object) - Method in class com.mongodb.LoggerSettings
 
equals(Object) - Method in exception com.mongodb.MongoBulkWriteException
 
equals(Object) - Method in class com.mongodb.MongoClientSettings
 
equals(Object) - Method in class com.mongodb.MongoCompressor
 
equals(Object) - Method in class com.mongodb.MongoCredential
 
equals(Object) - Method in class com.mongodb.MongoNamespace
 
equals(Object) - Method in class com.mongodb.ReadConcern
 
equals(Object) - Method in class com.mongodb.ReadPreferenceHedgeOptions
 
equals(Object) - Method in class com.mongodb.selector.CompositeServerSelector
 
equals(Object) - Method in class com.mongodb.ServerAddress
 
equals(Object) - Method in class com.mongodb.ServerApi
 
equals(Object) - Method in class com.mongodb.ServerCursor
 
equals(Object) - Method in class com.mongodb.Tag
 
equals(Object) - Method in class com.mongodb.TaggableReadPreference
 
equals(Object) - Method in class com.mongodb.TagSet
 
equals(Object) - Method in class com.mongodb.TransactionOptions
 
equals(Object) - Method in class com.mongodb.WriteConcern
 
equals(Object) - Method in class com.mongodb.WriteError
 
ERROR - Enum constant in enum class com.mongodb.client.model.ValidationAction
Documents must pass validation before the write occurs.
ERROR - Enum constant in enum class com.mongodb.event.ConnectionClosedEvent.Reason
The connection experienced an error, making it no longer valid
ErrorCategory - Enum Class in com.mongodb
A categorization of errors returned by a MongoDB server command.
EstimatedDocumentCountOptions - Class in com.mongodb.client.model
The options an estimated count operation.
EstimatedDocumentCountOptions() - Constructor for class com.mongodb.client.model.EstimatedDocumentCountOptions
 
eventLoopGroup(EventLoopGroup) - Method in class com.mongodb.connection.NettyTransportSettings.Builder
Sets the event loop group.
Evolving - Annotation Interface in com.mongodb.annotations
Signifies that the annotated program element is subject to incompatible changes by means of adding abstract methods.
exactVectorSearchOptions() - Static method in interface com.mongodb.client.model.search.VectorSearchOptions
Returns ExactVectorSearchOptions that represents server defaults with the exact option set to true.
ExactVectorSearchOptions - Interface in com.mongodb.client.model.search
Represents optional fields of the $vectorSearch pipeline stage of an aggregation pipeline.
exception(Throwable) - Method in class com.mongodb.connection.ServerDescription.Builder
Sets the exception thrown while attempting to determine the server description.
exclude(String...) - Static method in class com.mongodb.client.model.Projections
Creates a projection that excludes all of the given fields.
exclude(List<String>) - Static method in class com.mongodb.client.model.Projections
Creates a projection that excludes all of the given fields.
excludeId() - Static method in class com.mongodb.client.model.Projections
Creates a projection that excludes the _id field.
EXECUTION_STATS - Enum constant in enum class com.mongodb.ExplainVerbosity
Runs the query optimizer, and then runs the winning plan to completion.
EXECUTION_TIMEOUT - Enum constant in enum class com.mongodb.ErrorCategory
An execution timeout error
exists(FieldSearchPath) - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a SearchOperator that tests if the path exists in a document.
exists(String) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents that contain the given field.
exists(String, boolean) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents that either contain or do not contain the given field, depending on the value of the exists parameter.
ExistsSearchOperator - Interface in com.mongodb.client.model.search
 
expireAfter(long, TimeUnit) - Method in class com.mongodb.client.model.CreateCollectionOptions
Sets the expire-after option.
expireAfter(Long, TimeUnit) - Method in class com.mongodb.client.model.IndexOptions
Sets the time to live for documents in the collection
ExplainVerbosity - Enum Class in com.mongodb
An enumeration of the verbosity levels available for explaining query execution.
expMovingAvg(String, TExpression, double) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the exponential moving average of the evaluation results of the expression over the half-bounded window [Windows.Bound.UNBOUNDED, Windows.Bound.CURRENT], with alpha representing the degree of weighting decrease.
expMovingAvg(String, TExpression, int) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the exponential moving average of the evaluation results of the expression over a window that includes n - 1 documents preceding the current document and the current document, with more weight on documents closer to the current one.
expr(TExpression) - Static method in class com.mongodb.client.model.Filters
Allows the use of aggregation expressions within the query language.
ExpressionCodecProvider - Class in com.mongodb.client.model.mql
Provides Codec instances for the MQL API.
ExpressionCodecProvider() - Constructor for class com.mongodb.client.model.mql.ExpressionCodecProvider
 
extractErrorCode(BsonDocument) - Static method in exception com.mongodb.WriteConcernException
For internal use only: extract the error code from the response to a write command.
extractErrorMessage(BsonDocument) - Static method in exception com.mongodb.WriteConcernException
For internal use only: extract the error message from the response to a write command.
extraOptions(Map<String, Object>) - Method in class com.mongodb.AutoEncryptionSettings.Builder
Sets the extra options.

F

facet(Facet...) - Static method in class com.mongodb.client.model.Aggregates
Creates a facet pipeline stage
facet(SearchOperator, Iterable<? extends SearchFacet>) - Static method in interface com.mongodb.client.model.search.SearchCollector
Returns a SearchCollector that groups results by values or ranges in the specified faceted fields and returns the count for each of those groups.
facet(List<Facet>) - Static method in class com.mongodb.client.model.Aggregates
Creates a facet pipeline stage
Facet - Class in com.mongodb.client.model
Defines a Facet for use in $facet pipeline stages.
Facet(String, List<? extends Bson>) - Constructor for class com.mongodb.client.model.Facet
 
Facet(String, Bson...) - Constructor for class com.mongodb.client.model.Facet
 
FacetSearchCollector - Interface in com.mongodb.client.model.search
 
FAIL - Enum constant in enum class com.mongodb.client.model.MergeOptions.WhenMatched
Stop and fail the aggregation operation.
FAIL - Enum constant in enum class com.mongodb.client.model.MergeOptions.WhenNotMatched
Stop and fail the aggregation operation.
failed(Throwable) - Method in interface com.mongodb.connection.AsyncCompletionHandler
Invoked when an operation fails.
Field<TExpression> - Class in com.mongodb.client.model
Helps define new fields for the $addFields pipeline stage
Field(String, TExpression) - Constructor for class com.mongodb.client.model.Field
Creates a new field definition for use in $addFields pipeline stages
fieldPath(String) - Static method in interface com.mongodb.client.model.search.SearchPath
Returns a SearchPath for the given path.
fields(List<? extends Bson>) - Static method in class com.mongodb.client.model.Projections
Creates a projection that combines the list of projections into a single one.
fields(Bson...) - Static method in class com.mongodb.client.model.Projections
Creates a projection that combines the list of projections into a single one.
FieldSearchPath - Interface in com.mongodb.client.model.search
 
fill(FillOptions, FillOutputField, FillOutputField...) - Static method in class com.mongodb.client.model.Aggregates
Creates a $fill pipeline stage, which assigns values to fields when they are Null or missing.
fill(FillOptions, Iterable<? extends FillOutputField>) - Static method in class com.mongodb.client.model.Aggregates
Creates a $fill pipeline stage, which assigns values to fields when they are Null or missing.
fillOptions() - Static method in interface com.mongodb.client.model.fill.FillOptions
Returns FillOptions that represents server defaults.
FillOptions - Interface in com.mongodb.client.model.fill
Represents optional fields of the $fill pipeline stage of an aggregation pipeline.
FillOutputField - Interface in com.mongodb.client.model.fill
The core part of the $fill pipeline stage of an aggregation pipeline.
filter(Iterable<? extends SearchOperator>) - Method in interface com.mongodb.client.model.search.CompoundSearchOperatorBase
Creates a new CompoundSearchOperator by adding to it clauses that, similarly to CompoundSearchOperatorBase.must(Iterable), must all be satisfied.
filter(Function<? super T, ? extends MqlBoolean>) - Method in interface com.mongodb.client.model.mql.MqlArray
An array consisting of only those elements in this array that match the provided predicate.
filter(Bson) - Method in interface com.mongodb.client.model.search.VectorSearchOptions
Creates a new VectorSearchOptions with the filter specified.
FilterCompoundSearchOperator - Interface in com.mongodb.client.model.search
A representation of a CompoundSearchOperator that allows changing filter-specific options, if any.
Filters - Class in com.mongodb.client.model
A factory for query filters.
findByValue(String) - Static method in enum class com.mongodb.ServerApiVersion
Gets the ServerApiVersion that corresponds to the given value.
FindOneAndDeleteOptions - Class in com.mongodb.client.model
The options to apply to an operation that atomically finds a document and deletes it.
FindOneAndDeleteOptions() - Constructor for class com.mongodb.client.model.FindOneAndDeleteOptions
 
FindOneAndReplaceOptions - Class in com.mongodb.client.model
The options to apply to an operation that atomically finds a document and replaces it.
FindOneAndReplaceOptions() - Constructor for class com.mongodb.client.model.FindOneAndReplaceOptions
 
FindOneAndUpdateOptions - Class in com.mongodb.client.model
The options to apply to an operation that atomically finds a document and updates it.
FindOneAndUpdateOptions() - Constructor for class com.mongodb.client.model.FindOneAndUpdateOptions
 
findServerIncompatiblyNewerThanDriver() - Method in class com.mongodb.connection.ClusterDescription
Return a server in the cluster that is incompatibly newer than the driver.
findServerIncompatiblyOlderThanDriver() - Method in class com.mongodb.connection.ClusterDescription
Return a server in the cluster that is incompatibly older than the driver.
first() - Method in interface com.mongodb.client.model.mql.MqlArray
Returns the first element of this array.
first(String, TExpression) - Static method in class com.mongodb.client.model.Accumulators
Gets a field name for a $group operation representing the value of the given expression when applied to the first member of the group.
first(String, TExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the evaluation result of the expression against the first document in the window.
firstN(String, InExpression, NExpression) - Static method in class com.mongodb.client.model.Accumulators
Returns a combination of a computed field and an accumulator that produces a BSON Array of values of the given inExpression computed for the first N elements within a presorted group, where N is the positive integral value of the nExpression.
firstN(String, InExpression, NExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of a BSON Array of evaluation results of the inExpression against the first N documents in the window, where N is the positive integral value of the nExpression.
fromErrorCode(int) - Static method in enum class com.mongodb.ErrorCategory
Translate an error code into an error category
fromInt(int) - Static method in enum class com.mongodb.client.model.CollationStrength
Gets the order from the given integer representation.
fromMechanismName(String) - Static method in enum class com.mongodb.AuthenticationMechanism
Gets the mechanism by its name.
fromString(String) - Static method in enum class com.mongodb.client.model.BucketGranularity
Tries find the enum instance for the given value
fromString(String) - Static method in enum class com.mongodb.client.model.changestream.FullDocument
Returns the ChangeStreamFullDocument from the string value.
fromString(String) - Static method in enum class com.mongodb.client.model.changestream.FullDocumentBeforeChange
Returns the FullDocumentBeforeChange from the string value.
fromString(String) - Static method in enum class com.mongodb.client.model.changestream.OperationType
Returns the ChangeStreamOperationType from the string value.
fromString(String) - Static method in enum class com.mongodb.client.model.CollationAlternate
Returns the CollationAlternate from the string value.
fromString(String) - Static method in enum class com.mongodb.client.model.CollationCaseFirst
Returns the CollationCaseFirst from the string value.
fromString(String) - Static method in enum class com.mongodb.client.model.CollationMaxVariable
Returns the CollationMaxVariable from the string value.
fromString(String) - Static method in enum class com.mongodb.client.model.ValidationAction
Returns the validationAction from the string representation of a validation action.
fromString(String) - Static method in enum class com.mongodb.client.model.ValidationLevel
Returns the ValidationLevel from the string representation of the validation level.
fromString(String) - Static method in enum class com.mongodb.ReadConcernLevel
Returns the ReadConcern from the string read concern level.
fromThrowable(Throwable) - Static method in exception com.mongodb.MongoException
Static helper to create or cast a MongoException from a throwable
fromThrowableNonNull(Throwable) - Static method in exception com.mongodb.MongoException
Static helper to create or cast a MongoException from a throwable
FullDocument - Enum Class in com.mongodb.client.model.changestream
Change Stream fullDocument configuration.
FullDocumentBeforeChange - Enum Class in com.mongodb.client.model.changestream
Change Stream fullDocumentBeforeChange configuration.
fullRangeWithStep(long, MongoTimeUnit) - Static method in interface com.mongodb.client.model.densify.DensifyRange
Returns a DensifyRange that represents an interval with the smallest BSON Date value of the field in the sequence of documents being its lower bound, and the largest value being the upper bound.
fullRangeWithStep(Number) - Static method in interface com.mongodb.client.model.densify.DensifyRange
Returns a DensifyRange that represents an interval with the smallest BSON 32-bit integer / 64-bit integer / Double / Decimal128 value of the field in the sequence of documents being its lower bound, and the largest value being the upper bound.
function(SearchScoreExpression) - Static method in interface com.mongodb.client.model.search.SearchScore
Returns a SearchScore that instructs to compute the score using the specified expression.
Function<T,R> - Interface in com.mongodb
Apply a function to the input object yielding an appropriate result object.
FunctionSearchScore - Interface in com.mongodb.client.model.search
 
fuzzy() - Method in interface com.mongodb.client.model.search.AutocompleteSearchOperator
Creates a new AutocompleteSearchOperator that uses fuzzy search.
fuzzy() - Method in interface com.mongodb.client.model.search.TextSearchOperator
Creates a new TextSearchOperator that uses fuzzy search and does not use synonyms.
fuzzy(FuzzySearchOptions) - Method in interface com.mongodb.client.model.search.AutocompleteSearchOperator
Creates a new AutocompleteSearchOperator that uses fuzzy search.
fuzzy(FuzzySearchOptions) - Method in interface com.mongodb.client.model.search.TextSearchOperator
Creates a new TextSearchOperator that uses fuzzy search and does not use synonyms.
fuzzySearchOptions() - Static method in interface com.mongodb.client.model.search.FuzzySearchOptions
Returns FuzzySearchOptions that represents server defaults.
FuzzySearchOptions - Interface in com.mongodb.client.model.search
Fuzzy search options that may be used with some SearchOperators.

G

gaussExpression(double, PathSearchScoreExpression, double) - Static method in interface com.mongodb.client.model.search.SearchScoreExpression
Returns a SearchScoreExpression that represents a Gaussian function whose output is within the interval [0, 1].
GaussSearchScoreExpression - Interface in com.mongodb.client.model.search
 
generateIdIfAbsentFromDocument(DBObject) - Method in class com.mongodb.DBObjectCodec
 
geo2d(String) - Static method in class com.mongodb.client.model.Indexes
Create an index key for a 2d index on the given field.
geo2dsphere(String...) - Static method in class com.mongodb.client.model.Indexes
Create an index key for an 2dsphere index on the given fields.
geo2dsphere(List<String>) - Static method in class com.mongodb.client.model.Indexes
Create an index key for an 2dsphere index on the given fields.
geoIntersects(String, Geometry) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with geospatial data that intersects with the specified shape.
geoIntersects(String, Bson) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with geospatial data that intersects with the specified shape.
GeoJsonCodecProvider - Class in com.mongodb.client.model.geojson.codecs
A provider of codecs for GeoJSON objects.
GeoJsonCodecProvider() - Constructor for class com.mongodb.client.model.geojson.codecs.GeoJsonCodecProvider
 
GeoJsonObjectType - Enum Class in com.mongodb.client.model.geojson
An enumeration of GeoJSON object types.
Geometry - Class in com.mongodb.client.model.geojson
An abstract class for representations of GeoJSON geometry objects.
Geometry() - Constructor for class com.mongodb.client.model.geojson.Geometry
Construct an instance with no specified coordinate reference system.
Geometry(CoordinateReferenceSystem) - Constructor for class com.mongodb.client.model.geojson.Geometry
Construct an instance with the specified coordinate reference system.
GEOMETRY_COLLECTION - Enum constant in enum class com.mongodb.client.model.geojson.GeoJsonObjectType
A GeometryCollection
GeometryCodec - Class in com.mongodb.client.model.geojson.codecs
A Codec for a GeoJSON Geometry.
GeometryCodec(CodecRegistry) - Constructor for class com.mongodb.client.model.geojson.codecs.GeometryCodec
Construct a new instance
GeometryCollection - Class in com.mongodb.client.model.geojson
A representation of a GeoJSON GeometryCollection.
GeometryCollection(CoordinateReferenceSystem, List<? extends Geometry>) - Constructor for class com.mongodb.client.model.geojson.GeometryCollection
Construct an instance with the given list of Geometry objects
GeometryCollection(List<? extends Geometry>) - Constructor for class com.mongodb.client.model.geojson.GeometryCollection
Construct an instance with the given list of Geometry objects
GeometryCollectionCodec - Class in com.mongodb.client.model.geojson.codecs
A Codec for a GeoJSON GeometryCollection.
GeometryCollectionCodec(CodecRegistry) - Constructor for class com.mongodb.client.model.geojson.codecs.GeometryCollectionCodec
Constructs an instance.
geoNear(Point, String) - Static method in class com.mongodb.client.model.Aggregates
Creates a $geoNear pipeline stage that outputs documents in order of nearest to farthest from a specified point.
geoNear(Point, String, GeoNearOptions) - Static method in class com.mongodb.client.model.Aggregates
Creates a $geoNear pipeline stage that outputs documents in order of nearest to farthest from a specified point.
geoNearOptions() - Static method in interface com.mongodb.client.model.GeoNearOptions
Returns GeoNearOptions that represents server defaults.
GeoNearOptions - Interface in com.mongodb.client.model
GeoNearSearchOperator - Interface in com.mongodb.client.model.search
 
geoWithin(String, Geometry) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with geospatial data that exists entirely within the specified shape.
geoWithin(String, Bson) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with geospatial data that exists entirely within the specified shape.
geoWithinBox(String, double, double, double, double) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with grid coordinates data that exist entirely within the specified box.
geoWithinCenter(String, double, double, double) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with grid coordinates data that exist entirely within the specified circle.
geoWithinCenterSphere(String, double, double, double) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with geospatial data (GeoJSON or legacy coordinate pairs) that exist entirely within the specified circle, using spherical geometry.
geoWithinPolygon(String, List<List<Double>>) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with grid coordinates data that exist entirely within the specified polygon.
get() - Method in class com.mongodb.BasicDBObjectBuilder
Gets the top level document.
get(MqlString) - Method in interface com.mongodb.client.model.mql.MqlMap
The value corresponding to the provided key.
get(MqlString, T) - Method in interface com.mongodb.client.model.mql.MqlMap
The value corresponding to the provided key, or the other value if an entry for the key is not present.
get(Class<T>) - Method in interface com.mongodb.RequestContext
Resolve a value given a type key within the RequestContext.
get(Class<T>, List<Type>, CodecRegistry) - Method in class com.mongodb.Jep395RecordCodecProvider
 
get(Class<T>, List<Type>, CodecRegistry) - Method in class com.mongodb.KotlinCodecProvider
 
get(Class<T>, CodecRegistry) - Method in class com.mongodb.client.gridfs.codecs.GridFSFileCodecProvider
 
get(Class<T>, CodecRegistry) - Method in class com.mongodb.client.model.geojson.codecs.GeoJsonCodecProvider
 
get(Class<T>, CodecRegistry) - Method in class com.mongodb.client.model.mql.ExpressionCodecProvider
 
get(Class<T>, CodecRegistry) - Method in class com.mongodb.DBObjectCodecProvider
 
get(Class<T>, CodecRegistry) - Method in class com.mongodb.DBRefCodecProvider
 
get(Class<T>, CodecRegistry) - Method in class com.mongodb.Jep395RecordCodecProvider
 
get(Class<T>, CodecRegistry) - Method in class com.mongodb.KotlinCodecProvider
 
get(Object) - Method in interface com.mongodb.RequestContext
Resolve a value given a key that exists within the RequestContext, or throw a NoSuchElementException if the key is not present.
get(String) - Method in interface com.mongodb.client.model.mql.MqlMap
The value corresponding to the provided key.
get(String, T) - Method in interface com.mongodb.client.model.mql.MqlMap
The value corresponding to the provided key, or the other value if an entry for the key is not present.
getAccessKeyId() - Method in class com.mongodb.AwsCredential
Gets the access key ID that identifies the temporary security credentials.
getAccessToken() - Method in class com.mongodb.MongoCredential.OidcCallbackResult
 
getAddress() - Method in class com.mongodb.connection.ServerDescription
Gets the address of this server
getAddress() - Method in class com.mongodb.connection.ServerId
Gets the server address.
getAddress() - Method in class com.mongodb.ServerCursor
Gets the server address.
getAlgorithm() - Method in class com.mongodb.client.model.vault.EncryptOptions
Gets the encryption algorithm, which must be either: AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic AEAD_AES_256_CBC_HMAC_SHA_512-Random Indexed Unindexed Range
getAllocator() - Method in class com.mongodb.connection.NettyTransportSettings
Gets the allocator.
getAlternate() - Method in class com.mongodb.client.model.Collation
Returns the collation alternate
getApplicationName() - Method in class com.mongodb.ConnectionString
Gets the logical name of the application.
getApplicationName() - Method in class com.mongodb.MongoClientSettings
Gets the logical name of the application using this MongoClient.
getArbiters() - Method in class com.mongodb.connection.ServerDescription
Gets the arbiters in the replica set
getArray(String) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the array value of the field with the provided fieldName.
getArray(String, MqlArray<? extends T>) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the array value of the field with the provided fieldName, or the other value if the field is not an array or if the document MqlDocument.hasField(java.lang.String) no such field.
getArrayFilters() - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Returns the array filters option
getArrayFilters() - Method in class com.mongodb.client.model.UpdateOptions
Returns the array filters option
getAuthenticationMechanism() - Method in class com.mongodb.MongoCredential
Gets the mechanism
getAutoEncryptionSettings() - Method in class com.mongodb.MongoClientSettings
Gets the auto-encryption settings.
getBackwards() - Method in class com.mongodb.client.model.Collation
Returns the backwards value
getBits() - Method in class com.mongodb.client.model.IndexOptions
Gets the number of precision of the stored geohash value of the location data in 2d indexes.
getBoolean(String) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the boolean value of the field with the provided fieldName.
getBoolean(String, boolean) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the boolean value of the field with the provided fieldName, or the other value if the field is not a boolean or if the document MqlDocument.hasField(java.lang.String) no such field.
getBoolean(String, MqlBoolean) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the boolean value of the field with the provided fieldName, or the other value if the field is not a boolean or if the document MqlDocument.hasField(java.lang.String) no such field.
getBucketMaxSpan(TimeUnit) - Method in class com.mongodb.client.model.TimeSeriesOptions
Returns the maximum time span between measurements in a bucket.
getBucketRounding(TimeUnit) - Method in class com.mongodb.client.model.TimeSeriesOptions
Returns the time interval that determines the starting timestamp for a new bucket.
getBulkWriteResult() - Method in class com.mongodb.client.model.vault.RewrapManyDataKeyResult
 
getBypassDocumentValidation() - Method in class com.mongodb.client.model.BulkWriteOptions
Gets the bypass document level validation flag
getBypassDocumentValidation() - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Gets the bypass document level validation flag
getBypassDocumentValidation() - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Gets the bypass document level validation flag
getBypassDocumentValidation() - Method in class com.mongodb.client.model.InsertManyOptions
Gets the bypass document level validation flag
getBypassDocumentValidation() - Method in class com.mongodb.client.model.InsertOneOptions
Gets the bypass document level validation flag
getBypassDocumentValidation() - Method in class com.mongodb.client.model.ReplaceOptions
Gets the bypass document level validation flag
getBypassDocumentValidation() - Method in class com.mongodb.client.model.UpdateOptions
Gets the bypass document level validation flag
getCanonicalAddress() - Method in class com.mongodb.connection.ServerDescription
Gets the string representing the host name and port that this member of a replica set was configured with, e.g.
getCaseFirst() - Method in class com.mongodb.client.model.Collation
Returns the collation case first value
getCaseLevel() - Method in class com.mongodb.client.model.Collation
Returns the case level value
getCaseSensitive() - Method in class com.mongodb.client.model.TextSearchOptions
Returns the case-sensitive flag to use with the text search
getCategory() - Method in class com.mongodb.WriteError
Gets the category of this error.
getChangeStreamPreAndPostImagesOptions() - Method in class com.mongodb.client.model.CreateCollectionOptions
Gets change stream pre- and post- images options.
getCheckedOutCount() - Method in interface com.mongodb.management.ConnectionPoolStatisticsMBean
Gets the count of connections that are currently in use.
getChunkSize() - Method in class com.mongodb.client.gridfs.model.GridFSFile
The size, in bytes, of each data chunk of this file
getChunkSizeBytes() - Method in class com.mongodb.client.gridfs.model.GridFSUploadOptions
The number of bytes per chunk of this file.
getClientId() - Method in interface com.mongodb.MongoCredential.IdpInfo
 
getClusterDescription() - Method in exception com.mongodb.MongoIncompatibleDriverException
The cluster description which was determined to be incompatible.
getClusteredIndexOptions() - Method in class com.mongodb.client.model.CreateCollectionOptions
Gets the clustered index collection options.
getClusterId() - Method in class com.mongodb.connection.ServerId
Gets the cluster identifier.
getClusterId() - Method in class com.mongodb.event.ClusterClosedEvent
Gets the cluster id associated with this event.
getClusterId() - Method in class com.mongodb.event.ClusterDescriptionChangedEvent
Gets the cluster id associated with this event.
getClusterId() - Method in class com.mongodb.event.ClusterOpeningEvent
Gets the cluster id.
getClusterListeners() - Method in class com.mongodb.connection.ClusterSettings
Gets the cluster listeners.
getClusterSettings() - Method in class com.mongodb.connection.ClusterDescription
Gets the cluster settings, which may be null if not provided.
getClusterSettings() - Method in class com.mongodb.MongoClientSettings
Gets the cluster settings.
getClusterTime() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Gets the cluster time at which the change occurred.
getClusterTime() - Method in interface com.mongodb.session.ClientSession
 
getClusterType() - Method in class com.mongodb.connection.ServerDescription
Gets the type of the cluster this server is in (for example, replica set).
getClusterType() - Method in enum class com.mongodb.connection.ServerType
The type of the cluster to which this server belongs
getCode() - Method in class com.mongodb.bulk.WriteConcernError
Gets the code associated with this error.
getCode() - Method in exception com.mongodb.MongoException
Gets the exception code
getCode() - Method in class com.mongodb.WriteError
Gets the code associated with this error.
getCodecRegistry() - Method in class com.mongodb.MongoClientSettings
The codec registry to use, or null if not set.
getCodeName() - Method in class com.mongodb.bulk.WriteConcernError
Gets the name associated with the error code.
getCollation() - Method in class com.mongodb.client.model.CountOptions
Returns the collation options
getCollation() - Method in class com.mongodb.client.model.CreateCollectionOptions
Returns the collation options
getCollation() - Method in class com.mongodb.client.model.CreateViewOptions
Returns the collation options
getCollation() - Method in class com.mongodb.client.model.DeleteOptions
Returns the collation options
getCollation() - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Returns the collation options
getCollation() - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Returns the collation options
getCollation() - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Returns the collation options
getCollation() - Method in class com.mongodb.client.model.IndexOptions
Returns the collation options
getCollation() - Method in class com.mongodb.client.model.ReplaceOptions
Returns the collation options
getCollation() - Method in class com.mongodb.client.model.UpdateOptions
Returns the collation options
getCollection() - Method in class com.mongodb.ConnectionString
Gets the collection name
getCollectionName() - Method in class com.mongodb.DBRef
Gets the name of the collection in which the referenced document is stored.
getCollectionName() - Method in class com.mongodb.MongoNamespace
Gets the collection name.
getCommand() - Method in class com.mongodb.event.CommandStartedEvent
Gets the command document.
getCommandListeners() - Method in class com.mongodb.MongoClientSettings
Gets the list of added CommandListener.
getCommandName() - Method in class com.mongodb.event.CommandEvent
Gets the name of the command.
getComment() - Method in class com.mongodb.client.model.BulkWriteOptions
Returns the comment to send with the query.
getComment() - Method in class com.mongodb.client.model.CountOptions
 
getComment() - Method in class com.mongodb.client.model.DeleteOptions
 
getComment() - Method in class com.mongodb.client.model.EstimatedDocumentCountOptions
 
getComment() - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
 
getComment() - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
 
getComment() - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
 
getComment() - Method in class com.mongodb.client.model.InsertManyOptions
 
getComment() - Method in class com.mongodb.client.model.InsertOneOptions
 
getComment() - Method in class com.mongodb.client.model.ReplaceOptions
 
getComment() - Method in class com.mongodb.client.model.UpdateOptions
 
getCommitQuorum() - Method in class com.mongodb.client.model.CreateIndexOptions
Gets the create index commit quorum for this operation.
getCompressorList() - Method in class com.mongodb.ConnectionString
Gets the list of compressors.
getCompressorList() - Method in class com.mongodb.MongoClientSettings
Gets the compressors to use for compressing messages to the server.
getCompressors() - Method in class com.mongodb.connection.ConnectionDescription
Gets the compressors supported by this connection.
getConnectionDescription() - Method in class com.mongodb.event.CommandEvent
Gets the description of the connection to which the operation will be sent.
getConnectionId() - Method in class com.mongodb.connection.ConnectionDescription
Gets the id of the connection.
getConnectionId() - Method in class com.mongodb.event.ConnectionCheckedInEvent
Gets the connection id
getConnectionId() - Method in class com.mongodb.event.ConnectionCheckedOutEvent
Gets the connection id
getConnectionId() - Method in class com.mongodb.event.ConnectionClosedEvent
Gets the connection id
getConnectionId() - Method in class com.mongodb.event.ConnectionCreatedEvent
Gets the connection id
getConnectionId() - Method in class com.mongodb.event.ConnectionReadyEvent
Gets the connection id
getConnectionId() - Method in class com.mongodb.event.ServerHeartbeatFailedEvent
Gets the connectionId.
getConnectionId() - Method in class com.mongodb.event.ServerHeartbeatStartedEvent
Gets the connectionId.
getConnectionId() - Method in class com.mongodb.event.ServerHeartbeatSucceededEvent
Gets the connectionId.
getConnectionMode() - Method in class com.mongodb.connection.ClusterDescription
Gets whether this cluster is connecting to a single server or multiple servers.
getConnectionPoolListeners() - Method in class com.mongodb.connection.ConnectionPoolSettings
Gets the list of added ConnectionPoolListener.
getConnectionPoolSettings() - Method in class com.mongodb.MongoClientSettings
Gets the settings for the connection provider in a settings object.
getConnectionString() - Method in class com.mongodb.ConnectionString
Get the unparsed connection string.
getConnectTimeout() - Method in class com.mongodb.ConnectionString
Gets the socket connect timeout specified in the connection string.
getConnectTimeout(TimeUnit) - Method in class com.mongodb.connection.SocketSettings
Gets the timeout for socket connect.
getContentionFactor() - Method in class com.mongodb.client.model.vault.EncryptOptions
Gets the contention factor.
getContext() - Method in class com.mongodb.connection.SslSettings
Gets the SSLContext configured for use with SSL connections.
getContextProvider() - Method in class com.mongodb.MongoClientSettings
Get the context provider
getCoordinateReferenceSystem() - Method in class com.mongodb.client.model.geojson.Geometry
Gets the coordinate reference system, which may be null
getCoordinates() - Method in class com.mongodb.client.model.geojson.LineString
Gets the GeoJSON coordinates of this LineString.
getCoordinates() - Method in class com.mongodb.client.model.geojson.MultiLineString
Gets the GeoJSON coordinates of this MultiLineString
getCoordinates() - Method in class com.mongodb.client.model.geojson.MultiPoint
Gets the GeoJSON coordinates of this MultiPoint.
getCoordinates() - Method in class com.mongodb.client.model.geojson.MultiPolygon
Gets the coordinates.
getCoordinates() - Method in class com.mongodb.client.model.geojson.Point
Gets the GeoJSON coordinates of this point.
getCoordinates() - Method in class com.mongodb.client.model.geojson.Polygon
Gets the GeoJSON coordinates of the polygon
getCount() - Method in class com.mongodb.WriteConcernResult
Returns the number of documents affected by the write operation.
getCounter() - Method in class com.mongodb.connection.TopologyVersion
Get the counter
getCredential() - Method in class com.mongodb.ConnectionString
Gets the credential or null if no credentials were specified in the connection string.
getCredential() - Method in class com.mongodb.MongoClientSettings
Gets the credential.
getCredential() - Method in exception com.mongodb.MongoSecurityException
The credential being authenticated.
getCursorId() - Method in exception com.mongodb.MongoCursorNotFoundException
Get the cursor id that wasn't found.
getDatabase() - Method in class com.mongodb.ConnectionString
Gets the database name
getDatabaseName() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns the database name
getDatabaseName() - Method in class com.mongodb.DBRef
Gets the name of the database in which the referenced document is stored.
getDatabaseName() - Method in class com.mongodb.event.CommandEvent
Gets the database on which the operation will be executed.
getDatabaseName() - Method in class com.mongodb.MongoNamespace
Gets the database name.
getDate(String) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the date value of the field with the provided fieldName.
getDate(String, MqlDate) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the date value of the field with the provided fieldName, or the other value if the field is not a date or if the document MqlDocument.hasField(java.lang.String) no such field.
getDate(String, Instant) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the date value of the field with the provided fieldName, or the other value if the field is not a date or if the document MqlDocument.hasField(java.lang.String) no such field.
getDefaultBucket() - Method in class com.mongodb.client.model.BucketOptions
 
getDefaultCodecRegistry() - Static method in class com.mongodb.MongoClientSettings
Gets the default codec registry.
getDefaultLanguage() - Method in class com.mongodb.client.model.IndexOptions
Gets the language for a text index.
getDefaultMaxDocumentSize() - Static method in class com.mongodb.connection.ServerDescription
Get the default maximum document size.
getDefaultMaxMessageSize() - Static method in class com.mongodb.connection.ConnectionDescription
Get the default maximum message size.
getDefaultMaxWireVersion() - Static method in class com.mongodb.connection.ServerDescription
Get the default maximum wire version
getDefaultMaxWriteBatchSize() - Static method in class com.mongodb.connection.ConnectionDescription
Get the default maximum write batch size.
getDefaultMinWireVersion() - Static method in class com.mongodb.connection.ServerDescription
Get the default minimum wire version
getDefaultTimeout(TimeUnit) - Method in class com.mongodb.ClientSessionOptions
Gets the default time limit for the following operations executed on the session: commitTransaction abortTransaction withTransaction close
getDefaultTransactionOptions() - Method in class com.mongodb.ClientSessionOptions
Gets the default transaction options for the session.
getDefinition() - Method in class com.mongodb.client.model.SearchIndexModel
Get the Atlas Search index mapping definition.
getDeletedCount() - Method in class com.mongodb.bulk.BulkWriteResult
Returns the number of documents deleted by the write operation.
getDeletedCount() - Method in class com.mongodb.client.result.DeleteResult
Gets the number of documents deleted.
getDeprecationErrors() - Method in class com.mongodb.ServerApi
Gets whether the application requires use of deprecated server APIs to be reported as errors.
getDepthField() - Method in class com.mongodb.client.model.GraphLookupOptions
 
getDescription() - Method in class com.mongodb.connection.ClusterId
Gets the user defined description of the MongoClient.
getDestinationNamespace() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns the destination namespace, derived from the "to" field in a change stream document.
getDestinationNamespaceDocument() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns the destination namespace document, derived from the "to" field in a change stream document.
getDetails() - Method in class com.mongodb.bulk.WriteConcernError
Gets the details associated with this error.
getDetails() - Method in class com.mongodb.WriteError
Gets the details associated with this error.
getDiacriticSensitive() - Method in class com.mongodb.client.model.TextSearchOptions
Returns the diacritic-sensitive flag to use with the text search
getDisambiguatedPaths() - Method in class com.mongodb.client.model.changestream.UpdateDescription
A document containing a map that associates an update path to an array containing the path components used in the update document.
getDnsClient() - Method in class com.mongodb.MongoClientSettings
Gets the DnsClient to use for resolving DNS queries.
getDocument() - Method in class com.mongodb.client.model.InsertOneModel
Gets the document to insert.
getDocument(String) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the document value of the field with the provided fieldName.
getDocument(String, MqlDocument) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the document value of the field with the provided fieldName, or the other value if the document MqlDocument.hasField(java.lang.String) no such field, or if the specified field is not a (child) document (or other document-like value.
getDocument(String, Bson) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the document value of the field with the provided fieldName, or the other value if the document MqlDocument.hasField(java.lang.String) no such field, or if the specified field is not a (child) document (or other document-like value.
getDocumentId(DBObject) - Method in class com.mongodb.DBObjectCodec
 
getDocumentKey() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns a document containing just the _id of the changed document.
getDriverNames() - Method in class com.mongodb.MongoDriverInformation
Returns the driverNames
getDriverPlatforms() - Method in class com.mongodb.MongoDriverInformation
Returns the driverPlatforms
getDriverVersions() - Method in class com.mongodb.MongoDriverInformation
Returns the driverVersions
getElapsedTime(TimeUnit) - Method in class com.mongodb.event.CommandFailedEvent
Gets the elapsed time in the given unit of time.
getElapsedTime(TimeUnit) - Method in class com.mongodb.event.CommandSucceededEvent
Gets the elapsed time in the given unit of time.
getElapsedTime(TimeUnit) - Method in class com.mongodb.event.ConnectionCheckedOutEvent
The time it took to check out the connection.
getElapsedTime(TimeUnit) - Method in class com.mongodb.event.ConnectionCheckOutFailedEvent
The time it took to check out the connection.
getElapsedTime(TimeUnit) - Method in class com.mongodb.event.ConnectionReadyEvent
The time it took to establish the connection.
getElapsedTime(TimeUnit) - Method in class com.mongodb.event.ServerHeartbeatFailedEvent
Gets the elapsed time in the given time unit.
getElapsedTime(TimeUnit) - Method in class com.mongodb.event.ServerHeartbeatSucceededEvent
Gets the elapsed time in the given time unit.
getElectionId() - Method in class com.mongodb.connection.ServerDescription
The replica set electionid reported by this MongoDB server.
getEncoderClass() - Method in class com.mongodb.BSONTimestampCodec
 
getEncoderClass() - Method in class com.mongodb.client.gridfs.codecs.GridFSFileCodec
 
getEncoderClass() - Method in class com.mongodb.client.model.geojson.codecs.PolygonCodec
 
getEncoderClass() - Method in class com.mongodb.client.model.geojson.codecs.NamedCoordinateReferenceSystemCodec
 
getEncoderClass() - Method in class com.mongodb.DBObjectCodec
 
getEncoderClass() - Method in class com.mongodb.DBRefCodec
 
getEncryptedFields() - Method in class com.mongodb.client.model.CreateCollectionOptions
Gets any explicitly set encrypted fields.
getEncryptedFields() - Method in class com.mongodb.client.model.DropCollectionOptions
Gets any explicitly set encrypted fields.
getEncryptedFields() - Method in exception com.mongodb.MongoUpdatedEncryptedFieldsException
The encryptedFields document that allows inferring which data keys are known to be created before this exception happened by comparing this document with the original encryptedFields configuration.
getEncryptedFieldsMap() - Method in class com.mongodb.AutoEncryptionSettings
Gets the mapping of a collection namespace to encryptedFields.
getError() - Method in exception com.mongodb.MongoWriteException
Gets the error.
getErrorCode() - Method in exception com.mongodb.MongoCommandException
Gets the error code associated with the command failure.
getErrorCode() - Method in exception com.mongodb.WriteConcernException
Gets the error code associated with the write concern failure.
getErrorCodeName() - Method in exception com.mongodb.MongoCommandException
Gets the name associated with the error code.
getErrorCodeName() - Method in exception com.mongodb.MongoServerException
Get the error code name, which may be null
getErrorLabels() - Method in exception com.mongodb.MongoException
Gets the set of error labels associated with this exception.
getErrorMessage() - Method in exception com.mongodb.MongoCommandException
Gets the error message associated with the command failure.
getErrorMessage() - Method in exception com.mongodb.WriteConcernException
Gets the error message associated with the write concern failure.
getEventLoopGroup() - Method in class com.mongodb.connection.NettyTransportSettings
Gets the event loop group.
getException() - Method in class com.mongodb.connection.ServerDescription
Gets the exception thrown while attempting to determine the server description.
getExpireAfter(TimeUnit) - Method in class com.mongodb.client.model.CreateCollectionOptions
Returns the expire-after option.
getExpireAfter(TimeUnit) - Method in class com.mongodb.client.model.IndexOptions
Gets the time to live for documents in the collection
getExterior() - Method in class com.mongodb.client.model.geojson.Polygon
Gets the exterior coordinates.
getExterior() - Method in class com.mongodb.client.model.geojson.PolygonCoordinates
Gets the exterior of the polygon.
getExtraElements() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Any extra elements that are part of the change stream document but not otherwise mapped to fields.
getExtraOptions() - Method in class com.mongodb.AutoEncryptionSettings
Gets the extra options that control the behavior of auto-encryption components.
getField() - Method in class com.mongodb.client.model.changestream.TruncatedArray
Returns the name of the truncated field.
getField(String) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the MqlValue value of the field with the provided fieldName.
getFilename() - Method in class com.mongodb.client.gridfs.model.GridFSFile
The filename
getFilter() - Method in class com.mongodb.client.model.DeleteManyModel
Gets the query filter.
getFilter() - Method in class com.mongodb.client.model.DeleteOneModel
Gets the query filter.
getFilter() - Method in class com.mongodb.client.model.ReplaceOneModel
Gets the query filter.
getFilter() - Method in class com.mongodb.client.model.UpdateManyModel
Gets the query filter.
getFilter() - Method in class com.mongodb.client.model.UpdateOneModel
Gets the query filter.
getFragment() - Method in class com.mongodb.client.model.changestream.SplitEvent
Which 1-based fragment this is, out of the total number of fragments.
getFullDocument() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns the fullDocument.
getFullDocumentBeforeChange() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns the fullDocument before change
getFullName() - Method in class com.mongodb.MongoNamespace
Gets the full name, which is the database name and the collection name, separated by a period.
getGeometries() - Method in class com.mongodb.client.model.geojson.GeometryCollection
Gets the list of Geometry objects in this collection.
getGranularity() - Method in class com.mongodb.client.model.BucketAutoOptions
 
getGranularity() - Method in class com.mongodb.client.model.TimeSeriesOptions
Gets the granularity of the time-series data.
getHeartbeatFrequency() - Method in class com.mongodb.ConnectionString
 
getHeartbeatFrequency(TimeUnit) - Method in class com.mongodb.connection.ServerSettings
Gets the frequency that the cluster monitor attempts to reach each server.
getHeartbeatSocketSettings() - Method in class com.mongodb.MongoClientSettings
Gets the connection settings for the heartbeat thread (the background task that checks the state of the cluster) wrapped in a settings object.
getHedgeOptions() - Method in class com.mongodb.TaggableReadPreference
Gets the hedge options.
getHint() - Method in class com.mongodb.client.model.CountOptions
Gets the hint to apply.
getHint() - Method in class com.mongodb.client.model.DeleteOptions
Gets the hint to apply.
getHint() - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Gets the hint to apply.
getHint() - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Returns the hint for which index to use.
getHint() - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Returns the hint for which index to use.
getHint() - Method in class com.mongodb.client.model.ReplaceOptions
Returns the hint for which index to use.
getHint() - Method in class com.mongodb.client.model.UpdateOptions
Returns the hint for which index to use.
getHintString() - Method in class com.mongodb.client.model.CountOptions
Gets the hint string to apply.
getHintString() - Method in class com.mongodb.client.model.DeleteOptions
Gets the hint string to apply.
getHintString() - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Gets the hint string to apply.
getHintString() - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Gets the hint string to apply.
getHintString() - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Gets the hint string to apply.
getHintString() - Method in class com.mongodb.client.model.ReplaceOptions
Gets the hint string to apply.
getHintString() - Method in class com.mongodb.client.model.UpdateOptions
Gets the hint string to apply.
getHoles() - Method in class com.mongodb.client.model.geojson.Polygon
Get the holes in this polygon.
getHoles() - Method in class com.mongodb.client.model.geojson.PolygonCoordinates
Gets the holes in the polygon.
getHost() - Method in class com.mongodb.connection.ProxySettings
Gets the SOCKS5 proxy host.
getHost() - Method in interface com.mongodb.management.ConnectionPoolStatisticsMBean
Gets the host that this connection pool is connecting to.
getHost() - Method in class com.mongodb.ServerAddress
Gets the hostname
getHosts() - Method in class com.mongodb.connection.ClusterSettings
Gets the seed list of hosts for the cluster.
getHosts() - Method in class com.mongodb.connection.ServerDescription
Get a Set of strings in the format of "[hostname]:[port]" that contains all members of the replica set that are neither hidden, passive, nor arbiters.
getHosts() - Method in class com.mongodb.ConnectionString
Gets the list of hosts
getId() - Method in class com.mongodb.bulk.BulkWriteInsert
Gets the id of the inserted item.
getId() - Method in class com.mongodb.bulk.BulkWriteUpsert
Gets the id of the upserted item.
getId() - Method in class com.mongodb.client.gridfs.model.GridFSFile
The BsonValue id for this file.
getId() - Method in class com.mongodb.DBRef
Gets the _id of the referenced document
getId() - Method in class com.mongodb.ServerCursor
Gets the cursor id that the server uses to uniquely identify the cursor.
getIdentifier() - Method in interface com.mongodb.session.ServerSession
 
getIdpInfo() - Method in interface com.mongodb.MongoCredential.OidcCallbackContext
 
getIncludeArrayIndex() - Method in class com.mongodb.client.model.UnwindOptions
Gets the includeArrayIndex field if set or null
getIndex() - Method in class com.mongodb.bulk.BulkWriteError
The index of the item in the bulk write operation with this error.
getIndex() - Method in class com.mongodb.bulk.BulkWriteInsert
Gets the index of the inserted item based on the order it was added to the bulk write operation.
getIndex() - Method in class com.mongodb.bulk.BulkWriteUpsert
Gets the index of the upserted item based on the order it was added to the bulk write operation.
getIndexOptionDefaults() - Method in class com.mongodb.client.model.CreateCollectionOptions
Gets the index option defaults for the collection.
getInetAddressResolver() - Method in class com.mongodb.MongoClientSettings
Gets the explicitly set InetAddressResolver to use for looking up the InetAddress instances for each host.
getInsertedCount() - Method in class com.mongodb.bulk.BulkWriteResult
Returns the number of documents inserted by the write operation.
getInsertedId() - Method in class com.mongodb.client.result.InsertOneResult
If the _id of the inserted document is available, otherwise null
getInsertedIds() - Method in class com.mongodb.client.result.InsertManyResult
An unmodifiable map of the index of the inserted document to the id of the inserted document.
getInserts() - Method in class com.mongodb.bulk.BulkWriteResult
Gets an unmodifiable list of inserted items, or the empty list if there were none.
getInteger(String) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the integer value of the field with the provided fieldName.
getInteger(String, int) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the integer value of the field with the provided fieldName, or the other value if the field is not an integer or if the document MqlDocument.hasField(java.lang.String) no such field.
getInteger(String, long) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the integer value of the field with the provided fieldName, or the other value if the field is not an integer or if the document MqlDocument.hasField(java.lang.String) no such field.
getInteger(String, MqlInteger) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the integer value of the field with the provided fieldName, or the other value if the field is not an integer or if the document MqlDocument.hasField(java.lang.String) no such field.
getIntRepresentation() - Method in enum class com.mongodb.client.model.CollationStrength
The integer representation of the collation strength.
getIssuer() - Method in interface com.mongodb.MongoCredential.IdpInfo
 
getJournal() - Method in class com.mongodb.WriteConcern
Gets the journal property.
getKey() - Method in class com.mongodb.client.model.ClusteredIndexOptions
Gets the index key.
getKey() - Method in interface com.mongodb.client.model.mql.MqlEntry
The key of this entry.
getKeyAltName() - Method in class com.mongodb.client.model.vault.EncryptOptions
Gets the alternate name with which to look up the key.
getKeyAltNames() - Method in class com.mongodb.client.model.vault.DataKeyOptions
Gets the alternate key names.
getKeyId() - Method in class com.mongodb.client.model.vault.EncryptOptions
Gets the key identifier.
getKeyMaterial() - Method in class com.mongodb.client.model.vault.DataKeyOptions
Gets the custom key material if set.
getKeys() - Method in class com.mongodb.client.model.IndexModel
Gets the index keys.
getKeyVaultMongoClientSettings() - Method in class com.mongodb.AutoEncryptionSettings
Gets the key vault settings.
getKeyVaultMongoClientSettings() - Method in class com.mongodb.ClientEncryptionSettings
Gets the MongoClientSettings that will be used to access the key vault.
getKeyVaultNamespace() - Method in class com.mongodb.AutoEncryptionSettings
Gets the key vault namespace.
getKeyVaultNamespace() - Method in class com.mongodb.ClientEncryptionSettings
Gets the key vault namespace.
getKmsProvider() - Method in class com.mongodb.client.model.CreateEncryptedCollectionParams
The name of the KMS provider.
getKmsProviderPropertySuppliers() - Method in class com.mongodb.AutoEncryptionSettings
This method is similar to AutoEncryptionSettings.getKmsProviders(), but instead of getting properties for KMS providers, it gets Suppliers of properties.
getKmsProviderPropertySuppliers() - Method in class com.mongodb.ClientEncryptionSettings
This method is similar to ClientEncryptionSettings.getKmsProviders(), but instead of getting properties for KMS providers, it gets Suppliers of properties.
getKmsProviders() - Method in class com.mongodb.AutoEncryptionSettings
Gets the map of KMS provider properties.
getKmsProviders() - Method in class com.mongodb.ClientEncryptionSettings
Gets the map of KMS provider properties.
getKmsProviderSslContextMap() - Method in class com.mongodb.AutoEncryptionSettings
Gets the KMS provider to SSLContext map.
getKmsProviderSslContextMap() - Method in class com.mongodb.ClientEncryptionSettings
Gets the KMS provider to SSLContext map.
getLanguage() - Method in class com.mongodb.client.model.TextSearchOptions
Returns the language to be used with the text search
getLanguageOverride() - Method in class com.mongodb.client.model.IndexOptions
Gets the name of the field that contains the language string.
getLastUpdateTime(TimeUnit) - Method in class com.mongodb.connection.ServerDescription
Gets the time that this server description was created, using a monotonic clock like System.nanoTime().
getLastWriteDate() - Method in class com.mongodb.connection.ServerDescription
Gets the last write date.
getLength() - Method in class com.mongodb.client.gridfs.model.GridFSFile
The length, in bytes of this file
getLet() - Method in class com.mongodb.client.model.BulkWriteOptions
Add top-level variables to the operation
getLet() - Method in class com.mongodb.client.model.DeleteOptions
Add top-level variables to the operation
getLet() - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Add top-level variables to the operation
getLet() - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Add top-level variables to the operation
getLet() - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Add top-level variables to the operation
getLet() - Method in class com.mongodb.client.model.ReplaceOptions
Add top-level variables to the operation
getLet() - Method in class com.mongodb.client.model.UpdateOptions
Add top-level variables to the operation
getLevel() - Method in class com.mongodb.ReadConcern
Gets the read concern level.
getLimit() - Method in class com.mongodb.client.model.CountOptions
Gets the limit to apply.
getLocale() - Method in class com.mongodb.client.model.Collation
Returns the locale
getLocalThreshold() - Method in class com.mongodb.ConnectionString
 
getLocalThreshold(TimeUnit) - Method in class com.mongodb.connection.ClusterSettings
Gets the local threshold.
getLocalValue() - Method in class com.mongodb.connection.ConnectionId
Gets the locally created id value for the connection
getLoggerSettings() - Method in class com.mongodb.MongoClientSettings
Gets the logger settings.
getLogicalSessionTimeoutMinutes() - Method in class com.mongodb.connection.ClusterDescription
Gets the logical session timeout in minutes, or null if at least one of the known servers does not support logical sessions.
getLogicalSessionTimeoutMinutes() - Method in class com.mongodb.connection.ConnectionDescription
Gets the session timeout in minutes.
getLogicalSessionTimeoutMinutes() - Method in class com.mongodb.connection.ServerDescription
Gets the session timeout in minutes.
getLsid() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns the identifier for the session associated with the transaction
getMaintenanceFrequency(TimeUnit) - Method in class com.mongodb.connection.ConnectionPoolSettings
Returns the time period between runs of the maintenance job.
getMaintenanceInitialDelay(TimeUnit) - Method in class com.mongodb.connection.ConnectionPoolSettings
Returns the period of time to wait before running the first maintenance job on the connection pool.
getMap(String) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the map value of the field with the provided fieldName.
getMap(String, MqlMap<? extends T>) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the map value of the field with the provided fieldName, or the other value if the document MqlDocument.hasField(java.lang.String) no such field, or if the specified field is not a map (or other MqlValue.isMapOr(com.mongodb.client.model.mql.MqlMap<? extends T>) map-like value}).
getMap(String, Bson) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the map value of the field with the provided fieldName, or the other value if the document MqlDocument.hasField(java.lang.String) no such field, or if the specified field is not a map (or other MqlValue.isMapOr(com.mongodb.client.model.mql.MqlMap<? extends T>) map-like value}).
getMasterKey() - Method in class com.mongodb.client.model.CreateEncryptedCollectionParams
The master key for creating a data key.
getMasterKey() - Method in class com.mongodb.client.model.vault.DataKeyOptions
Gets the master key document
getMasterKey() - Method in class com.mongodb.client.model.vault.RewrapManyDataKeyOptions
Gets the master key document
getMatchedCount() - Method in class com.mongodb.bulk.BulkWriteResult
Returns the number of documents matched by updates or replacements in the write operation.
getMatchedCount() - Method in class com.mongodb.client.result.UpdateResult
Gets the number of documents matched by the query.
getMax() - Method in class com.mongodb.client.model.IndexOptions
Gets the upper inclusive boundary for the longitude and latitude values for 2d indexes..
getMax() - Method in class com.mongodb.client.model.vault.RangeOptions
 
getMaxBatchCount() - Method in class com.mongodb.connection.ConnectionDescription
Gets the max batch count for bulk write operations.
getMaxCommitTime(TimeUnit) - Method in class com.mongodb.TransactionOptions
Gets the maximum amount of time to allow a single commitTransaction command to execute.
getMaxConnecting() - Method in class com.mongodb.connection.ConnectionPoolSettings
The maximum number of connections a pool may be establishing concurrently.
getMaxConnecting() - Method in class com.mongodb.ConnectionString
Gets the maximum number of connections a pool may be establishing concurrently specified in the connection string.
getMaxConnectionIdleTime() - Method in class com.mongodb.ConnectionString
Gets the maximum connection idle time specified in the connection string.
getMaxConnectionIdleTime(TimeUnit) - Method in class com.mongodb.connection.ConnectionPoolSettings
Returns the maximum idle time of a pooled connection.
getMaxConnectionLifeTime() - Method in class com.mongodb.ConnectionString
Gets the maximum connection lifetime specified in the connection string.
getMaxConnectionLifeTime(TimeUnit) - Method in class com.mongodb.connection.ConnectionPoolSettings
The maximum time a pooled connection can live for.
getMaxConnectionPoolSize() - Method in class com.mongodb.ConnectionString
Gets the maximum connection pool size specified in the connection string.
getMaxDepth() - Method in class com.mongodb.client.model.GraphLookupOptions
 
getMaxDocumentLength() - Method in class com.mongodb.LoggerSettings
Gets the max length of the extended JSON representation of a BSON document within a log message.
getMaxDocuments() - Method in class com.mongodb.client.model.CreateCollectionOptions
Gets the maximum number of documents allowed in a capped collection.
getMaxDocumentSize() - Method in class com.mongodb.connection.ConnectionDescription
Gets the max document size in bytes for documents to be stored in collections.
getMaxDocumentSize() - Method in class com.mongodb.connection.ServerDescription
The maximum permitted size of a BSON object in bytes for this mongod process.
getMaxMessageSize() - Method in class com.mongodb.connection.ConnectionDescription
Gets the max message size in bytes for wire protocol messages to be sent to the server.
getMaxSize() - Method in class com.mongodb.connection.ConnectionPoolSettings
The maximum number of connections allowed.
getMaxSize() - Method in interface com.mongodb.management.ConnectionPoolStatisticsMBean
Gets the maximum allowed size of the pool, including idle and in-use members.
getMaxStaleness(TimeUnit) - Method in class com.mongodb.TaggableReadPreference
Gets the maximum acceptable staleness of a secondary in order to be considered for read operations.
getMaxTime(TimeUnit) - Method in class com.mongodb.client.model.CountOptions
Gets the maximum execution time on the server for this operation.
getMaxTime(TimeUnit) - Method in class com.mongodb.client.model.CreateIndexOptions
Gets the maximum execution time on the server for this operation.
getMaxTime(TimeUnit) - Method in class com.mongodb.client.model.DropIndexOptions
Gets the maximum execution time on the server for this operation.
getMaxTime(TimeUnit) - Method in class com.mongodb.client.model.EstimatedDocumentCountOptions
Gets the maximum execution time on the server for this operation.
getMaxTime(TimeUnit) - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Gets the maximum execution time for the find one and delete operation.
getMaxTime(TimeUnit) - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Gets the maximum execution time for the find one and replace operation.
getMaxTime(TimeUnit) - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Gets the maximum execution time for the find one and update operation.
getMaxVariable() - Method in class com.mongodb.client.model.Collation
Returns the maxVariable
getMaxWaitTime() - Method in class com.mongodb.ConnectionString
The maximum duration to wait until either: an in-use connection becomes available; or a connection is created and begins to be established.
getMaxWaitTime(TimeUnit) - Method in class com.mongodb.connection.ConnectionPoolSettings
The maximum duration to wait until either: an in-use connection becomes available; or a connection is created and begins to be established.
getMaxWireVersion() - Method in class com.mongodb.connection.ConnectionDescription
The latest version of the wire protocol that this MongoDB server is capable of using to communicate with clients.
getMaxWireVersion() - Method in class com.mongodb.connection.ServerDescription
The latest version of the wire protocol that this MongoDB server is capable of using to communicate with clients.
getMechanism() - Method in class com.mongodb.MongoCredential
Gets the mechanism
getMechanismName() - Method in enum class com.mongodb.AuthenticationMechanism
Get the mechanism name.
getMechanismProperty(String, T) - Method in class com.mongodb.MongoCredential
Get the value of the given key to a mechanism property, or defaultValue if there is no mapping.
getMessage() - Method in class com.mongodb.bulk.WriteConcernError
Gets the message associated with this error.
getMessage() - Method in class com.mongodb.WriteError
Gets the message associated with this error.
getMetadata() - Method in class com.mongodb.client.gridfs.model.GridFSFile
Any additional metadata stored along with the file
getMetadata() - Method in class com.mongodb.client.gridfs.model.GridFSUploadOptions
Returns any user provided data for the 'metadata' field of the files collection document.
getMetaField() - Method in class com.mongodb.client.model.TimeSeriesOptions
Gets the name of the meta field.
getMin() - Method in class com.mongodb.client.model.IndexOptions
Gets the lower inclusive boundary for the longitude and latitude values for 2d indexes..
getMin() - Method in class com.mongodb.client.model.vault.RangeOptions
 
getMinConnectionPoolSize() - Method in class com.mongodb.ConnectionString
Gets the minimum connection pool size specified in the connection string.
getMinHeartbeatFrequency(TimeUnit) - Method in class com.mongodb.connection.ServerSettings
Gets the minimum heartbeat frequency.
getMinRoundTripTimeNanos() - Method in class com.mongodb.connection.ServerDescription
Get the recent min time it took to make the round trip for requesting this information from the server in nanoseconds.
getMinSize() - Method in class com.mongodb.connection.ConnectionPoolSettings
The minimum number of connections.
getMinSize() - Method in interface com.mongodb.management.ConnectionPoolStatisticsMBean
Gets the minimum allowed size of the pool, including idle and in-use members.
getMinWireVersion() - Method in class com.mongodb.connection.ServerDescription
The earliest version of the wire protocol that this MongoDB server is capable of using to communicate with clients.
getMode() - Method in class com.mongodb.connection.ClusterSettings
Gets the mode.
getModifiedCount() - Method in class com.mongodb.bulk.BulkWriteResult
Returns the number of documents modified by the write operation.
getModifiedCount() - Method in class com.mongodb.client.result.UpdateResult
Gets the number of documents modified by the update.
getName() - Method in class com.mongodb.client.model.BsonField
Gets the field name
getName() - Method in class com.mongodb.client.model.ClusteredIndexOptions
Gets the index name
getName() - Method in class com.mongodb.client.model.Facet
 
getName() - Method in class com.mongodb.client.model.Field
 
getName() - Method in class com.mongodb.client.model.geojson.NamedCoordinateReferenceSystem
Gets the name of this Coordinate Reference System.
getName() - Method in class com.mongodb.client.model.IndexOptions
Gets the name of the index.
getName() - Method in class com.mongodb.client.model.SearchIndexModel
Get the Atlas Search index name.
getName() - Method in class com.mongodb.client.model.Variable
 
getName() - Method in class com.mongodb.MongoCompressor
Gets the name of the compressor.
getName() - Method in class com.mongodb.ReadPreference
Gets the name of this read preference.
getName() - Method in class com.mongodb.Tag
Gets the name of the replica set tag.
getNamespace() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns the namespace, derived from the "ns" field in a change stream document.
getNamespaceDocument() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns the namespace document, derived from the "ns" field in a change stream document.
getNewDescription() - Method in class com.mongodb.event.ClusterDescriptionChangedEvent
Gets the new cluster description.
getNewDescription() - Method in class com.mongodb.event.ServerDescriptionChangedEvent
Gets the new server description.
getNewSize() - Method in class com.mongodb.client.model.changestream.TruncatedArray
Returns the size of the new field value.
getNormalization() - Method in class com.mongodb.client.model.Collation
Returns the normalization value
getNumber(String) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the number value of the field with the provided fieldName.
getNumber(String, MqlNumber) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the number value of the field with the provided fieldName, or the other value if the field is not a number or if the document MqlDocument.hasField(java.lang.String) no such field.
getNumber(String, Number) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the number value of the field with the provided fieldName, or the other value if the field is not a number or if the document MqlDocument.hasField(java.lang.String) no such field.
getNumericOrdering() - Method in class com.mongodb.client.model.Collation
Returns the numeric ordering, if true will order numbers based on numerical order and not collation order.
getObjectId() - Method in class com.mongodb.client.gridfs.model.GridFSFile
The ObjectId for this file.
getOf() - Method in class com.mongodb.client.model.changestream.SplitEvent
The total number of fragments.
getOperationId() - Method in class com.mongodb.event.CommandEvent
Gets the operation identifier
getOperationId() - Method in class com.mongodb.event.ConnectionCheckedInEvent
Gets the operation identifier
getOperationId() - Method in class com.mongodb.event.ConnectionCheckedOutEvent
Gets the operation identifier
getOperationId() - Method in class com.mongodb.event.ConnectionCheckOutFailedEvent
Gets the operation identifier
getOperationId() - Method in class com.mongodb.event.ConnectionCheckOutStartedEvent
Gets the operation identifier
getOperationTime() - Method in interface com.mongodb.session.ClientSession
Gets the operation time of the last operation executed in this session.
getOperationType() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns the operationType.
getOperationTypeString() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns the operation type as a string.
getOptions() - Method in class com.mongodb.client.model.DeleteManyModel
Gets the options to apply.
getOptions() - Method in class com.mongodb.client.model.DeleteOneModel
Gets the options to apply.
getOptions() - Method in class com.mongodb.client.model.IndexModel
Gets the index options.
getOptions() - Method in class com.mongodb.client.model.UpdateManyModel
Gets the options to apply.
getOptions() - Method in class com.mongodb.client.model.UpdateOneModel
Gets the options to apply.
getOptions() - Method in interface com.mongodb.session.ClientSession
Get the options for this session.
getOrDefault(Object, T) - Method in interface com.mongodb.RequestContext
Resolve a value given a key within the RequestContext.
getOrEmpty(Object) - Method in interface com.mongodb.RequestContext
Resolve a value given a key within the RequestContext.
getOriginator() - Method in interface com.mongodb.session.ClientSession
Gets the originator for the session.
getOutput() - Method in class com.mongodb.client.model.BucketAutoOptions
 
getOutput() - Method in class com.mongodb.client.model.BucketOptions
 
getPartialFilterExpression() - Method in class com.mongodb.client.model.IndexOptions
Get the filter expression for the documents to be included in the index or null if not set
getPassives() - Method in class com.mongodb.connection.ServerDescription
Gets the passive members of the replica set.
getPassword() - Method in class com.mongodb.connection.ProxySettings
Gets the SOCKS5 proxy password.
getPassword() - Method in class com.mongodb.ConnectionString
Gets the password
getPassword() - Method in class com.mongodb.MongoCredential
Gets the password.
getPinnedServerAddress() - Method in interface com.mongodb.session.ClientSession
Get the server address of the pinned mongos on this session.
getPipeline() - Method in class com.mongodb.client.model.Facet
 
getPort() - Method in class com.mongodb.connection.ProxySettings
Gets the SOCKS5 proxy port.
getPort() - Method in interface com.mongodb.management.ConnectionPoolStatisticsMBean
Gets the port that this connection pool is connecting to.
getPort() - Method in class com.mongodb.ServerAddress
Gets the port number
getPosition() - Method in class com.mongodb.client.model.geojson.Point
Gets the position of this point.
getPosition() - Method in class com.mongodb.client.model.PushOptions
Gets the position at which to add the pushed values in the array.
getPrecision() - Method in class com.mongodb.client.model.vault.RangeOptions
 
getPreviousDescription() - Method in class com.mongodb.event.ClusterDescriptionChangedEvent
Gets the previous cluster description.
getPreviousDescription() - Method in class com.mongodb.event.ServerDescriptionChangedEvent
Gets the previous server description.
getPrimary() - Method in class com.mongodb.connection.ServerDescription
Gets the address of the current primary in the replica set
getProcessId() - Method in class com.mongodb.connection.TopologyVersion
Get the process identifier
getProjection() - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Gets a document describing the fields to return for all matching documents.
getProjection() - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Gets a document describing the fields to return for all matching documents.
getProjection() - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Gets a document describing the fields to return for all matching documents.
getProperty(String, T) - Method in class com.mongodb.MongoCompressor
Gets the property with the given key.
getPropertyNonNull(String, T) - Method in class com.mongodb.MongoCompressor
Gets the property with the given key.
getProvider() - Method in class com.mongodb.client.model.vault.RewrapManyDataKeyOptions
 
getProxyHost() - Method in class com.mongodb.ConnectionString
Gets the SOCKS5 proxy host specified in the connection string.
getProxyPassword() - Method in class com.mongodb.ConnectionString
Gets the SOCKS5 proxy password specified in the connection string.
getProxyPort() - Method in class com.mongodb.ConnectionString
Gets the SOCKS5 proxy port specified in the connection string.
getProxySettings() - Method in class com.mongodb.connection.SocketSettings
Gets the proxy settings used for connecting to MongoDB via a SOCKS5 proxy server.
getProxyUsername() - Method in class com.mongodb.ConnectionString
Gets the SOCKS5 proxy username specified in the connection string.
getQueryType() - Method in class com.mongodb.client.model.vault.EncryptOptions
Gets the QueryType.
getRangeOptions() - Method in class com.mongodb.client.model.vault.EncryptOptions
Gets the RangeOptions
getReadConcern() - Method in class com.mongodb.ConnectionString
Gets the read concern specified in the connection string.
getReadConcern() - Method in class com.mongodb.MongoClientSettings
The read concern to use.
getReadConcern() - Method in class com.mongodb.TransactionOptions
Gets the read concern.
getReadPreference() - Method in class com.mongodb.ConnectionString
Gets the read preference specified in the connection string.
getReadPreference() - Method in class com.mongodb.MongoClientSettings
The read preference to use for queries, map-reduce, aggregation, and count.
getReadPreference() - Method in class com.mongodb.TransactionOptions
Gets the read preference.
getReadTimeout(TimeUnit) - Method in class com.mongodb.connection.SocketSettings
Gets the timeout for socket reads.
getReason() - Method in class com.mongodb.event.ConnectionCheckOutFailedEvent
Gets the reason for the check out failure.
getReason() - Method in class com.mongodb.event.ConnectionClosedEvent
Get the reason the connection was removed.
getReceiveBufferSize() - Method in class com.mongodb.connection.SocketSettings
Gets the receive buffer size.
getRecoveryToken() - Method in interface com.mongodb.session.ClientSession
Get the recovery token from the latest outcome in a sharded transaction.
getRefreshToken() - Method in interface com.mongodb.MongoCredential.OidcCallbackContext
 
getRefreshToken() - Method in class com.mongodb.MongoCredential.OidcCallbackResult
 
getRemovedFields() - Method in class com.mongodb.client.model.changestream.UpdateDescription
Returns the removedFields
getReplacement() - Method in class com.mongodb.client.model.ReplaceOneModel
Gets the document which will replace the document matching the query filter.
getReplaceOptions() - Method in class com.mongodb.client.model.ReplaceOneModel
Gets the ReplaceOptions to apply.
getReply() - Method in class com.mongodb.event.ServerHeartbeatSucceededEvent
Gets the reply to the hello command executed for this heartbeat.
getRequestContext() - Method in class com.mongodb.event.CommandEvent
Gets the request context associated with this event.
getRequestId() - Method in class com.mongodb.event.CommandEvent
Gets the request identifier
getRequestScopes() - Method in interface com.mongodb.MongoCredential.IdpInfo
 
getRequiredClusterType() - Method in class com.mongodb.connection.ClusterSettings
Gets the required cluster type This setting is not used if ClusterSettings.getMode() is ClusterConnectionMode.LOAD_BALANCED.
getRequiredReplicaSetName() - Method in class com.mongodb.connection.ClusterSettings
Gets the required replica set name.
getRequiredReplicaSetName() - Method in class com.mongodb.ConnectionString
Gets the required replica set name specified in the connection string.
getResourceRecordData(String, String) - Method in interface com.mongodb.spi.dns.DnsClient
Gets the resource record values for the given name and type.
getResponse() - Method in class com.mongodb.event.CommandSucceededEvent
Gets the response document.
getResponse() - Method in exception com.mongodb.MongoCommandException
Gets the full server response document describing the error.
getResponse() - Method in exception com.mongodb.WriteConcernException
Gets the response to the write operation.
getResponseCode() - Method in exception com.mongodb.spi.dns.DnsWithResponseCodeException
Gets the response code
getRestrictSearchWithMatch() - Method in class com.mongodb.client.model.GraphLookupOptions
 
getResumeToken() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns the resumeToken
getRetryReads() - Method in class com.mongodb.ConnectionString
Gets whether reads should be retried if they fail due to a network error
getRetryReads() - Method in class com.mongodb.MongoClientSettings
Returns true if reads should be retried if they fail due to a network error or other retryable error.
getRetryWrites() - Method in class com.mongodb.MongoClientSettings
Returns true if writes should be retried if they fail due to a network error or other retryable error.
getRetryWritesValue() - Method in class com.mongodb.ConnectionString
Gets whether writes should be retried if they fail due to a network error
getReturnDocument() - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Gets the ReturnDocument value indicating whether to return the document before it was replaced or after
getReturnDocument() - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Gets the ReturnDocument value indicating whether to return the document before it was updated / inserted or after
getRevision() - Method in class com.mongodb.client.gridfs.model.GridFSDownloadOptions
Gets the revision to download identifier
getRoundTripTimeNanos() - Method in class com.mongodb.connection.ServerDescription
Get the weighted average time it took to make the round trip for requesting this information from the server in nanoseconds.
getSaslSupportedMechanisms() - Method in class com.mongodb.connection.ConnectionDescription
Get the supported SASL mechanisms.
getSchemaMap() - Method in class com.mongodb.AutoEncryptionSettings
Gets the map of namespace to local JSON schema.
getSecretAccessKey() - Method in class com.mongodb.AwsCredential
Gets the secret access key that can be used to sign requests.
getSendBufferSize() - Method in class com.mongodb.connection.SocketSettings
Gets the send buffer size.
getServerAddress() - Method in class com.mongodb.connection.ConnectionDescription
Gets the server address.
getServerAddress() - Method in exception com.mongodb.MongoBulkWriteException
The address of the server which performed the bulk write operation.
getServerAddress() - Method in exception com.mongodb.MongoServerException
Gets the address of the server.
getServerAddress() - Method in exception com.mongodb.MongoSocketException
Gets the server address for this exception.
getServerApi() - Method in class com.mongodb.MongoClientSettings
Gets the server API to use when sending commands to the server.
getServerDescriptions() - Method in class com.mongodb.connection.ClusterDescription
Returns an unmodifiable list of the server descriptions in this cluster description.
getServerId() - Method in class com.mongodb.connection.ConnectionId
Gets the server id.
getServerId() - Method in class com.mongodb.event.ConnectionCheckOutFailedEvent
Gets the server id
getServerId() - Method in class com.mongodb.event.ConnectionCheckOutStartedEvent
Gets the server id
getServerId() - Method in class com.mongodb.event.ConnectionPoolClearedEvent
Gets the server id
getServerId() - Method in class com.mongodb.event.ConnectionPoolClosedEvent
Gets the server id
getServerId() - Method in class com.mongodb.event.ConnectionPoolCreatedEvent
Gets the server id
getServerId() - Method in class com.mongodb.event.ConnectionPoolReadyEvent
Gets the server id
getServerId() - Method in class com.mongodb.event.ServerClosedEvent
Gets the serverId.
getServerId() - Method in class com.mongodb.event.ServerDescriptionChangedEvent
Gets the serverId.
getServerId() - Method in class com.mongodb.event.ServerOpeningEvent
Gets the serverId.
getServerListeners() - Method in class com.mongodb.connection.ServerSettings
Gets the server listeners.
getServerMonitoringMode() - Method in class com.mongodb.connection.ServerSettings
Gets the server monitoring mode, which defines the monitoring protocol to use.
getServerMonitoringMode() - Method in class com.mongodb.ConnectionString
The server monitoring mode, which defines the monitoring protocol to use.
getServerMonitorListeners() - Method in class com.mongodb.connection.ServerSettings
Gets the server monitor listeners.
getServerSelectionTimeout() - Method in class com.mongodb.ConnectionString
 
getServerSelectionTimeout(TimeUnit) - Method in class com.mongodb.connection.ClusterSettings
Gets the timeout to apply when selecting a server.
getServerSelector() - Method in class com.mongodb.connection.ClusterSettings
Gets the server selector.
getServerSelectors() - Method in class com.mongodb.selector.CompositeServerSelector
 
getServerSession() - Method in interface com.mongodb.session.ClientSession
 
getServerSettings() - Method in class com.mongodb.connection.ClusterDescription
Gets the server settings, which may be null if not provided.
getServerSettings() - Method in class com.mongodb.MongoClientSettings
Gets the server-specific settings wrapped in a settings object.
getServerType() - Method in class com.mongodb.connection.ConnectionDescription
Gets the server type.
getServerValue() - Method in class com.mongodb.connection.ConnectionId
Gets the server generated id value for the connection or null if not set.
getServiceId() - Method in class com.mongodb.connection.ConnectionDescription
Gets the id of the service this connection is to
getServiceId() - Method in class com.mongodb.event.ConnectionPoolClearedEvent
Gets the service id.
getSessionToken() - Method in class com.mongodb.AwsCredential
Gets the session token.
getSetName() - Method in class com.mongodb.connection.ServerDescription
Gets the name of the replica set
getSettings() - Method in class com.mongodb.event.ConnectionPoolCreatedEvent
Gets the connection pool settings.
getSetVersion() - Method in class com.mongodb.connection.ServerDescription
The replica set setVersion reported by this MongoDB server.
getShortDescription() - Method in class com.mongodb.connection.ClusterDescription
Returns a short, pretty description for this ClusterDescription.
getShortDescription() - Method in class com.mongodb.connection.ClusterSettings
Returns a short, pretty description for these ClusterSettings.
getShortDescription() - Method in class com.mongodb.connection.ServerDescription
Returns a short, pretty description for this ServerDescription.
getSize() - Method in interface com.mongodb.management.ConnectionPoolStatisticsMBean
Gets the current size of the pool, including idle and in-use members.
getSizeInBytes() - Method in class com.mongodb.client.model.CreateCollectionOptions
Gets the maximum size in bytes of a capped collection.
getSkip() - Method in class com.mongodb.client.model.CountOptions
Gets the number of documents to skip.
getSlice() - Method in class com.mongodb.client.model.PushOptions
Gets the slice value, which is the limit on the number of array elements allowed.
getSnapshotTimestamp() - Method in interface com.mongodb.session.ClientSession
For internal use only.
getSocketChannelClass() - Method in class com.mongodb.connection.NettyTransportSettings
Gets the socket channel class.
getSocketSettings() - Method in class com.mongodb.MongoClientSettings
Gets the connection-specific settings wrapped in a settings object.
getSocketTimeout() - Method in class com.mongodb.ConnectionString
Gets the socket timeout specified in the connection string.
getSort() - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Gets the sort criteria to apply to the query.
getSort() - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Gets the sort criteria to apply to the query.
getSort() - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Gets the sort criteria to apply to the query.
getSort() - Method in class com.mongodb.client.model.PushOptions
Gets the sort direction for sorting array elements that are not documents.
getSortDocument() - Method in class com.mongodb.client.model.PushOptions
Gets the sort direction for sorting array elements that are documents.
getSource() - Method in class com.mongodb.MongoCredential
Gets the source of the user name, typically the name of the database where the user is defined.
getSparsity() - Method in class com.mongodb.client.model.vault.RangeOptions
 
getSphereVersion() - Method in class com.mongodb.client.model.IndexOptions
Gets the 2dsphere index version number.
getSplitEvent() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
The split event.
getSrvHost() - Method in class com.mongodb.connection.ClusterSettings
Gets the host name from which to lookup SRV record for the seed list
getSrvMaxHosts() - Method in class com.mongodb.connection.ClusterSettings
Gets the maximum number of hosts to connect to when using SRV protocol.
getSrvMaxHosts() - Method in class com.mongodb.ConnectionString
Gets the maximum number of hosts to connect to when using SRV protocol.
getSrvResolutionException() - Method in class com.mongodb.connection.ClusterDescription
Gets any exception encountered while resolving the SRV record for the initial host.
getSrvServiceName() - Method in class com.mongodb.connection.ClusterSettings
Gets the SRV service name.
getSrvServiceName() - Method in class com.mongodb.ConnectionString
Gets the SRV service name.
getSslContext() - Method in class com.mongodb.connection.NettyTransportSettings
Gets the SSL Context.
getSslEnabled() - Method in class com.mongodb.ConnectionString
Gets the SSL enabled value specified in the connection string.
getSslInvalidHostnameAllowed() - Method in class com.mongodb.ConnectionString
Gets the SSL invalidHostnameAllowed value specified in the connection string.
getSslSettings() - Method in class com.mongodb.MongoClientSettings
Gets the SSL settings.
getState() - Method in class com.mongodb.connection.ServerDescription
Gets the current state of the connection to the server.
getStorageEngine() - Method in class com.mongodb.client.model.IndexOptionDefaults
Gets the default storage engine options document for indexes.
getStorageEngine() - Method in class com.mongodb.client.model.IndexOptions
Gets the storage engine options document for this index.
getStorageEngineOptions() - Method in class com.mongodb.client.model.CreateCollectionOptions
Gets the storage engine options document for the collection.
getStrength() - Method in class com.mongodb.client.model.Collation
Returns the collation strength
getStrict() - Method in class com.mongodb.ServerApi
Gets whether the application requires strict server API version enforcement.
getString(String) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the string value of the field with the provided fieldName.
getString(String, MqlString) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the string value of the field with the provided fieldName, or the other value if the field is not a string or if the document MqlDocument.hasField(java.lang.String) no such field.
getString(String, String) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns the string value of the field with the provided fieldName, or the other value if the field is not a string or if the document MqlDocument.hasField(java.lang.String) no such field.
getSubject() - Method in class com.mongodb.KerberosSubjectProvider
Gets a Subject instance associated with a LoginContext after its been logged in.
getSubject() - Method in interface com.mongodb.SubjectProvider
Gets the Subject to use for an authentication request.
getTagSet() - Method in class com.mongodb.connection.ServerDescription
A set of all tags assigned to this member.
getTagSetList() - Method in class com.mongodb.TaggableReadPreference
Gets the list of tag sets as a list of TagSet instances.
getTextVersion() - Method in class com.mongodb.client.model.IndexOptions
The text index version number.
getThrowable() - Method in class com.mongodb.event.CommandFailedEvent
Gets the throwable cause of the failure
getThrowable() - Method in class com.mongodb.event.ServerHeartbeatFailedEvent
Gets the exceptions that caused the failure
getTimeField() - Method in class com.mongodb.client.model.TimeSeriesOptions
Gets the name of the field holding the time value.
getTimeout() - Method in class com.mongodb.ConnectionString
The time limit for the full execution of an operation in milliseconds.
getTimeout() - Method in interface com.mongodb.MongoCredential.OidcCallbackContext
 
getTimeout(TimeUnit) - Method in class com.mongodb.ClientEncryptionSettings
The time limit for the full execution of an operation.
getTimeout(TimeUnit) - Method in class com.mongodb.MongoClientSettings
The time limit for the full execution of an operation.
getTimeout(TimeUnit) - Method in class com.mongodb.TransactionOptions
The time limit for the full execution of the transaction.
getTimeoutContext() - Method in interface com.mongodb.session.ClientSession
Gets the timeout context to use with this session: MongoClientSettings#getTimeoutMS ClientSessionOptions#getDefaultTimeout
getTimeSeriesOptions() - Method in class com.mongodb.client.model.CreateCollectionOptions
Gets the time series collection options.
getTopologyVersion() - Method in class com.mongodb.connection.ServerDescription
The topologyVersion reported by this MongoDB server.
getTransactionContext() - Method in interface com.mongodb.session.ClientSession
Gets the transaction context.
getTransactionNumber() - Method in interface com.mongodb.session.ServerSession
Gets the current transaction number.
getTransportSettings() - Method in class com.mongodb.MongoClientSettings
Gets the settings for the underlying transport implementation
getTrimFactor() - Method in class com.mongodb.client.model.vault.RangeOptions
 
getTruncatedArrays() - Method in class com.mongodb.client.model.changestream.UpdateDescription
Returns information about the updated fields of the array type when the changes are reported as truncations.
getTxnNumber() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns the transaction number
getType() - Method in class com.mongodb.client.model.geojson.CoordinateReferenceSystem
Gets the type of this Coordinate Reference System.
getType() - Method in class com.mongodb.client.model.geojson.Geometry
Gets the GeoJSON object type.
getType() - Method in class com.mongodb.client.model.geojson.GeometryCollection
 
getType() - Method in class com.mongodb.client.model.geojson.LineString
 
getType() - Method in class com.mongodb.client.model.geojson.MultiLineString
 
getType() - Method in class com.mongodb.client.model.geojson.MultiPoint
 
getType() - Method in class com.mongodb.client.model.geojson.MultiPolygon
 
getType() - Method in class com.mongodb.client.model.geojson.NamedCoordinateReferenceSystem
 
getType() - Method in class com.mongodb.client.model.geojson.Point
 
getType() - Method in class com.mongodb.client.model.geojson.Polygon
 
getType() - Method in class com.mongodb.client.model.SearchIndexModel
Get the Atlas Search index type.
getType() - Method in class com.mongodb.connection.ClusterDescription
Gets the specific type of this cluster
getType() - Method in class com.mongodb.connection.ServerDescription
Gets the type of the server, for example whether it's a standalone or in a replica set.
getTypeName() - Method in enum class com.mongodb.client.model.geojson.CoordinateReferenceSystemType
Gets the GeoJSON-defined name for the type.
getTypeName() - Method in enum class com.mongodb.client.model.geojson.GeoJsonObjectType
Gets the GeoJSON-defined name for the object type.
getUniqueIdentifier() - Method in class com.mongodb.client.model.MergeOptions
Gets the fields that act as a unique identifier for a document.
getUpdate() - Method in class com.mongodb.client.model.UpdateManyModel
Gets the document specifying the updates to apply to the matching document.
getUpdate() - Method in class com.mongodb.client.model.UpdateOneModel
Gets the document specifying the updates to apply to the matching document.
getUpdateDescription() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
Returns the updateDescription
getUpdatedFields() - Method in class com.mongodb.client.model.changestream.UpdateDescription
Returns information about the updated fields excluding the fields reported via UpdateDescription.getTruncatedArrays().
getUpdatePipeline() - Method in class com.mongodb.client.model.UpdateManyModel
Gets the pipeline specifying the updates to apply to the matching document.
getUpdatePipeline() - Method in class com.mongodb.client.model.UpdateOneModel
Gets the pipeline specifying the updates to apply to the matching document.
getUploadDate() - Method in class com.mongodb.client.gridfs.model.GridFSFile
The date and time this file was added to GridFS
getUpsertedId() - Method in class com.mongodb.client.result.UpdateResult
If the replace resulted in an inserted document, gets the _id of the inserted document, otherwise null.
getUpsertedId() - Method in class com.mongodb.WriteConcernResult
Returns the value of _id if this write resulted in an upsert.
getUpserts() - Method in class com.mongodb.bulk.BulkWriteResult
Gets an unmodifiable list of upserted items, or the empty list if there were none.
getUsername() - Method in class com.mongodb.connection.ProxySettings
Gets the SOCKS5 proxy username.
getUsername() - Method in class com.mongodb.ConnectionString
Gets the username
getUserName() - Method in class com.mongodb.MongoCredential
Gets the user name
getUserName() - Method in interface com.mongodb.MongoCredential.OidcCallbackContext
 
getUuidRepresentation() - Method in class com.mongodb.ConnectionString
Gets the UUID representation.
getUuidRepresentation() - Method in class com.mongodb.MongoClientSettings
Gets the UUID representation to use when encoding instances of UUID and when decoding BSON binary values with subtype of 3.
getValidationAction() - Method in class com.mongodb.client.model.ValidationOptions
getValidationLevel() - Method in class com.mongodb.client.model.ValidationOptions
Gets the ValidationLevel that determines how strictly MongoDB applies the validation rules to existing documents during an insert or update.
getValidationOptions() - Method in class com.mongodb.client.model.CreateCollectionOptions
Gets the validation options for documents being inserted or updated in a collection
getValidator() - Method in class com.mongodb.client.model.ValidationOptions
Gets the validation rules if set or null.
getValue() - Method in class com.mongodb.client.model.BsonField
Gets the field value
getValue() - Method in enum class com.mongodb.client.model.BucketGranularity
Returns the display as defined in the preferred number article
getValue() - Method in enum class com.mongodb.client.model.changestream.FullDocument
 
getValue() - Method in enum class com.mongodb.client.model.changestream.FullDocumentBeforeChange
The string value.
getValue() - Method in enum class com.mongodb.client.model.changestream.OperationType
 
getValue() - Method in enum class com.mongodb.client.model.CollationAlternate
 
getValue() - Method in enum class com.mongodb.client.model.CollationCaseFirst
 
getValue() - Method in enum class com.mongodb.client.model.CollationMaxVariable
 
getValue() - Method in class com.mongodb.client.model.Field
 
getValue() - Method in enum class com.mongodb.client.model.MapReduceAction
Deprecated.
 
getValue() - Method in interface com.mongodb.client.model.mql.MqlEntry
The value of this entry.
getValue() - Method in enum class com.mongodb.client.model.ValidationAction
 
getValue() - Method in enum class com.mongodb.client.model.ValidationLevel
 
getValue() - Method in class com.mongodb.client.model.Variable
 
getValue() - Method in class com.mongodb.connection.ClusterId
Gets the value of the identifier.
getValue() - Method in enum class com.mongodb.ReadConcernLevel
 
getValue() - Method in enum class com.mongodb.ServerApiVersion
Gets the version as a string.
getValue() - Method in class com.mongodb.Tag
Gets the value of the replica set tag.
getValues() - Method in class com.mongodb.client.model.geojson.Position
Gets the values of this position
getVariables() - Method in class com.mongodb.client.model.MergeOptions
Gets the variables accessible for use in the whenMatched pipeline
getVersion() - Method in class com.mongodb.client.model.IndexOptions
Gets the index version number.
getVersion() - Method in interface com.mongodb.MongoCredential.OidcCallbackContext
 
getVersion() - Method in class com.mongodb.ServerApi
Gets the server API version
getVersionList() - Method in class com.mongodb.connection.ServerVersion
Gets the version list.
getW() - Method in class com.mongodb.WriteConcern
Gets the w value as an integer.
getWallTime() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
The wall time of the server at the moment the change occurred.
getWeights() - Method in class com.mongodb.client.model.IndexOptions
Gets the weighting object for use with a text index
getWhenMatched() - Method in class com.mongodb.client.model.MergeOptions
Gets the behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s).
getWhenMatchedPipeline() - Method in class com.mongodb.client.model.MergeOptions
Gets aggregation pipeline to update the document in the collection.
getWhenNotMatched() - Method in class com.mongodb.client.model.MergeOptions
Gets the behavior of $merge if a result document does not match an existing document in the out collection.
getWildcardProjection() - Method in class com.mongodb.client.model.IndexOptions
Gets the wildcard projection of a wildcard index
getWObject() - Method in class com.mongodb.WriteConcern
Gets the w value.
getWriteConcern() - Method in class com.mongodb.ConnectionString
Gets the write concern specified in the connection string.
getWriteConcern() - Method in class com.mongodb.MongoClientSettings
The write concern to use.
getWriteConcern() - Method in class com.mongodb.TransactionOptions
Gets the write concern.
getWriteConcernError() - Method in exception com.mongodb.MongoBulkWriteException
The write concern error, which may be null (in which case the list of errors will not be empty).
getWriteConcernError() - Method in exception com.mongodb.MongoWriteConcernException
Gets the write concern error.
getWriteConcernResult() - Method in exception com.mongodb.WriteConcernException
Gets the write result.
getWriteErrors() - Method in exception com.mongodb.MongoBulkWriteException
The list of errors, which will not be null, but may be empty (if the write concern error is not null).
getWriteResult() - Method in exception com.mongodb.MongoBulkWriteException
The result of all successfully processed write operations.
getWriteResult() - Method in exception com.mongodb.MongoWriteConcernException
Gets the write result.
getWString() - Method in class com.mongodb.WriteConcern
Gets the w parameter as a String.
getWTimeout(TimeUnit) - Method in class com.mongodb.WriteConcern
Gets the wTimeout in the given time unit.
granularity(BucketGranularity) - Method in class com.mongodb.client.model.BucketAutoOptions
Specifies the granularity of the bucket definitions.
granularity(TimeSeriesGranularity) - Method in class com.mongodb.client.model.TimeSeriesOptions
Sets the granularity of the time-series data.
graphLookup(String, TExpression, String, String, String) - Static method in class com.mongodb.client.model.Aggregates
Creates a graphLookup pipeline stage for the specified filter
graphLookup(String, TExpression, String, String, String, GraphLookupOptions) - Static method in class com.mongodb.client.model.Aggregates
Creates a graphLookup pipeline stage for the specified filter
GraphLookupOptions - Class in com.mongodb.client.model
The options for a graphLookup aggregation pipeline stage
GraphLookupOptions() - Constructor for class com.mongodb.client.model.GraphLookupOptions
 
GridFSDownloadOptions - Class in com.mongodb.client.gridfs.model
The GridFS download by name options
GridFSDownloadOptions() - Constructor for class com.mongodb.client.gridfs.model.GridFSDownloadOptions
Download the most recent version of the file.
GridFSFile - Class in com.mongodb.client.gridfs.model
The GridFSFile
GridFSFile(BsonValue, String, long, int, Date, Document) - Constructor for class com.mongodb.client.gridfs.model.GridFSFile
Creates a new GridFSFile
GridFSFileCodec - Class in com.mongodb.client.gridfs.codecs
A codec for GridFS Files
GridFSFileCodec(CodecRegistry) - Constructor for class com.mongodb.client.gridfs.codecs.GridFSFileCodec
Create a new instance
GridFSFileCodecProvider - Class in com.mongodb.client.gridfs.codecs
A provider of codecs for GridFSFiles.
GridFSFileCodecProvider() - Constructor for class com.mongodb.client.gridfs.codecs.GridFSFileCodecProvider
 
GridFSUploadOptions - Class in com.mongodb.client.gridfs.model
GridFS upload options
GridFSUploadOptions() - Constructor for class com.mongodb.client.gridfs.model.GridFSUploadOptions
Construct a new instance.
group(TExpression, BsonField...) - Static method in class com.mongodb.client.model.Aggregates
Creates a $group pipeline stage for the specified filter
group(TExpression, List<BsonField>) - Static method in class com.mongodb.client.model.Aggregates
Creates a $group pipeline stage for the specified filter
GSSAPI - Enum constant in enum class com.mongodb.AuthenticationMechanism
The GSSAPI mechanism.
GSSAPI_MECHANISM - Static variable in class com.mongodb.MongoCredential
The GSSAPI mechanism.
gt(MqlValue) - Method in interface com.mongodb.client.model.mql.MqlValue
Whether this value is greater than the other value.
gt(Number) - Method in interface com.mongodb.client.model.search.NumberRangeSearchOperatorBase
Creates a new NumberRangeSearchOperator that tests if values are within (l; ∞).
gt(String, TItem) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of the given field is greater than the specified value.
gt(Instant) - Method in interface com.mongodb.client.model.search.DateRangeSearchOperatorBase
Creates a new DateRangeSearchOperator that tests if values are within (l; ∞).
gte(MqlValue) - Method in interface com.mongodb.client.model.mql.MqlValue
Whether this value is greater than or equal to the other value.
gte(Number) - Method in interface com.mongodb.client.model.search.NumberRangeSearchOperatorBase
Creates a new NumberRangeSearchOperator that tests if values are within [l; ∞).
gte(String, TItem) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of the given field is greater than or equal to the specified value.
gte(Instant) - Method in interface com.mongodb.client.model.search.DateRangeSearchOperatorBase
Creates a new DateRangeSearchOperator that tests if values are within [l; ∞).
gteLt(Number, Number) - Method in interface com.mongodb.client.model.search.NumberRangeSearchOperatorBase
Creates a new NumberRangeSearchOperator that tests if values are within [l; u).
gteLt(Instant, Instant) - Method in interface com.mongodb.client.model.search.DateRangeSearchOperatorBase
Creates a new DateRangeSearchOperator that tests if values are within [l; u).
gteLte(Number, Number) - Method in interface com.mongodb.client.model.search.NumberRangeSearchOperatorBase
Creates a new NumberRangeSearchOperator that tests if values are within [l; u].
gteLte(Instant, Instant) - Method in interface com.mongodb.client.model.search.DateRangeSearchOperatorBase
Creates a new DateRangeSearchOperator that tests if values are within [l; u].
gtLt(Number, Number) - Method in interface com.mongodb.client.model.search.NumberRangeSearchOperatorBase
Creates a new NumberRangeSearchOperator that tests if values are within (l; u).
gtLt(Instant, Instant) - Method in interface com.mongodb.client.model.search.DateRangeSearchOperatorBase
Creates a new DateRangeSearchOperator that tests if values are within (l; u).
gtLte(Number, Number) - Method in interface com.mongodb.client.model.search.NumberRangeSearchOperatorBase
Creates a new NumberRangeSearchOperator that tests if values are within (l; u].
gtLte(Instant, Instant) - Method in interface com.mongodb.client.model.search.DateRangeSearchOperatorBase
Creates a new DateRangeSearchOperator that tests if values are within (l; u].

H

has(MqlString) - Method in interface com.mongodb.client.model.mql.MqlMap
Whether this map has a value (including null) for the provided key.
has(String) - Method in interface com.mongodb.client.model.mql.MqlMap
Whether this map has a value (including null) for the provided key.
hasErrorLabel(String) - Method in exception com.mongodb.MongoException
Return true if the exception is labelled with the given error label, and false otherwise.
hasField(String) - Method in interface com.mongodb.client.model.mql.MqlDocument
Whether this document has a field with the provided fieldName (if a field is set to null, it is present).
hashCode() - Method in class com.mongodb.BasicDBObject
 
hashCode() - Method in class com.mongodb.bulk.BulkWriteError
 
hashCode() - Method in class com.mongodb.bulk.BulkWriteInsert
 
hashCode() - Method in class com.mongodb.bulk.BulkWriteUpsert
 
hashCode() - Method in class com.mongodb.bulk.WriteConcernError
 
hashCode() - Method in class com.mongodb.client.gridfs.model.GridFSFile
 
hashCode() - Method in class com.mongodb.client.model.BsonField
 
hashCode() - Method in class com.mongodb.client.model.BucketAutoOptions
 
hashCode() - Method in class com.mongodb.client.model.BucketOptions
 
hashCode() - Method in class com.mongodb.client.model.changestream.ChangeStreamDocument
 
hashCode() - Method in class com.mongodb.client.model.changestream.SplitEvent
 
hashCode() - Method in class com.mongodb.client.model.changestream.TruncatedArray
 
hashCode() - Method in class com.mongodb.client.model.changestream.UpdateDescription
 
hashCode() - Method in class com.mongodb.client.model.Collation
 
hashCode() - Method in class com.mongodb.client.model.Facet
 
hashCode() - Method in class com.mongodb.client.model.Field
 
hashCode() - Method in class com.mongodb.client.model.geojson.Geometry
 
hashCode() - Method in class com.mongodb.client.model.geojson.GeometryCollection
 
hashCode() - Method in class com.mongodb.client.model.geojson.LineString
 
hashCode() - Method in class com.mongodb.client.model.geojson.MultiLineString
 
hashCode() - Method in class com.mongodb.client.model.geojson.MultiPoint
 
hashCode() - Method in class com.mongodb.client.model.geojson.MultiPolygon
 
hashCode() - Method in class com.mongodb.client.model.geojson.NamedCoordinateReferenceSystem
 
hashCode() - Method in class com.mongodb.client.model.geojson.Point
 
hashCode() - Method in class com.mongodb.client.model.geojson.Polygon
 
hashCode() - Method in class com.mongodb.client.model.geojson.PolygonCoordinates
 
hashCode() - Method in class com.mongodb.client.model.geojson.Position
 
hashCode() - Method in class com.mongodb.client.model.GraphLookupOptions
 
hashCode() - Method in class com.mongodb.client.model.MergeOptions
 
hashCode() - Method in class com.mongodb.client.model.PushOptions
 
hashCode() - Method in class com.mongodb.client.model.TextSearchOptions
 
hashCode() - Method in class com.mongodb.client.model.Variable
 
hashCode() - Method in class com.mongodb.ClientSessionOptions
 
hashCode() - Method in class com.mongodb.connection.ClusterDescription
 
hashCode() - Method in class com.mongodb.connection.ClusterId
 
hashCode() - Method in class com.mongodb.connection.ClusterSettings
 
hashCode() - Method in class com.mongodb.connection.ConnectionDescription
 
hashCode() - Method in class com.mongodb.connection.ConnectionId
 
hashCode() - Method in class com.mongodb.connection.ConnectionPoolSettings
 
hashCode() - Method in class com.mongodb.connection.ProxySettings
 
hashCode() - Method in class com.mongodb.connection.ServerDescription
 
hashCode() - Method in class com.mongodb.connection.ServerId
 
hashCode() - Method in class com.mongodb.connection.ServerSettings
 
hashCode() - Method in class com.mongodb.connection.ServerVersion
 
hashCode() - Method in class com.mongodb.connection.SocketSettings
 
hashCode() - Method in class com.mongodb.connection.SslSettings
 
hashCode() - Method in class com.mongodb.connection.TopologyVersion
 
hashCode() - Method in class com.mongodb.ConnectionString
 
hashCode() - Method in class com.mongodb.DBObjectCodecProvider
 
hashCode() - Method in class com.mongodb.DBRef
 
hashCode() - Method in class com.mongodb.DBRefCodecProvider
 
hashCode() - Method in class com.mongodb.DocumentToDBRefTransformer
 
hashCode() - Method in class com.mongodb.LoggerSettings
 
hashCode() - Method in exception com.mongodb.MongoBulkWriteException
 
hashCode() - Method in class com.mongodb.MongoClientSettings
 
hashCode() - Method in class com.mongodb.MongoCompressor
 
hashCode() - Method in class com.mongodb.MongoCredential
 
hashCode() - Method in class com.mongodb.MongoNamespace
 
hashCode() - Method in class com.mongodb.ReadConcern
 
hashCode() - Method in class com.mongodb.ReadPreferenceHedgeOptions
 
hashCode() - Method in class com.mongodb.selector.CompositeServerSelector
 
hashCode() - Method in class com.mongodb.ServerAddress
 
hashCode() - Method in class com.mongodb.ServerApi
 
hashCode() - Method in class com.mongodb.ServerCursor
 
hashCode() - Method in class com.mongodb.Tag
 
hashCode() - Method in class com.mongodb.TaggableReadPreference
 
hashCode() - Method in class com.mongodb.TagSet
 
hashCode() - Method in class com.mongodb.TransactionOptions
 
hashCode() - Method in class com.mongodb.WriteConcern
 
hashCode() - Method in class com.mongodb.WriteError
 
hashed(String) - Static method in class com.mongodb.client.model.Indexes
Create an index key for a hashed index on the given field.
hasKey(Object) - Method in interface com.mongodb.RequestContext
Return true if a particular key resolves to a value within the RequestContext.
hasReadableServer(ReadPreference) - Method in class com.mongodb.connection.ClusterDescription
Returns true if this cluster has at least one server that satisfies the given read preference.
hasRecordSupport() - Method in class com.mongodb.Jep395RecordCodecProvider
This method is not part of the public API and may be removed or changed at any time.
hasTags(TagSet) - Method in class com.mongodb.connection.ServerDescription
Returns true if the server has the given tags.
hasWritableServer() - Method in class com.mongodb.connection.ClusterDescription
Returns true if this cluster has at least one server that can be used for write operations.
heartbeatFrequency(long, TimeUnit) - Method in class com.mongodb.connection.ServerSettings.Builder
Sets the frequency that the cluster monitor attempts to reach each server.
helloOk(boolean) - Method in class com.mongodb.connection.ServerDescription.Builder
Sets whether this server supports the "hello" command.
hidden(boolean) - Method in class com.mongodb.client.model.IndexOptions
Should the index not be used by the query planner when executing operations.
highlight(SearchHighlight) - Method in interface com.mongodb.client.model.search.SearchOptions
Creates a new SearchOptions with the highlighting options specified.
hint(Bson) - Method in class com.mongodb.client.model.CountOptions
Sets the hint to apply.
hint(Bson) - Method in class com.mongodb.client.model.DeleteOptions
Sets the hint to apply.
hint(Bson) - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Sets the hint to apply.
hint(Bson) - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Sets the hint for which index to use.
hint(Bson) - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Sets the hint for which index to use.
hint(Bson) - Method in class com.mongodb.client.model.ReplaceOptions
Sets the hint for which index to use.
hint(Bson) - Method in class com.mongodb.client.model.UpdateOptions
Sets the hint for which index to use.
hintString(String) - Method in class com.mongodb.client.model.CountOptions
Sets the hint to apply.
hintString(String) - Method in class com.mongodb.client.model.DeleteOptions
Sets the hint to apply.
hintString(String) - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Sets the hint to apply.
hintString(String) - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Sets the hint to apply.
hintString(String) - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Sets the hint to apply.
hintString(String) - Method in class com.mongodb.client.model.ReplaceOptions
Sets the hint to apply.
hintString(String) - Method in class com.mongodb.client.model.UpdateOptions
Sets the hint to apply.
host(String) - Method in class com.mongodb.connection.ProxySettings.Builder
Sets the SOCKS5 proxy host to establish a connection through.
hosts(List<ServerAddress>) - Method in class com.mongodb.connection.ClusterSettings.Builder
Sets the hosts for the cluster.
hosts(Set<String>) - Method in class com.mongodb.connection.ServerDescription.Builder
Sets all members of the replica set that are neither hidden, passive, nor arbiters.
hour(MqlString) - Method in interface com.mongodb.client.model.mql.MqlDate
The hour of this date as determined by the provided timezone, as an integer between 0 and 23.
HOUR - Enum constant in enum class com.mongodb.client.model.MongoTimeUnit
HOURS - Enum constant in enum class com.mongodb.client.model.TimeSeriesGranularity
Hours-level granularity.

I

IDENTICAL - Enum constant in enum class com.mongodb.client.model.CollationStrength
When all other levels are equal, the identical level is used as a tiebreaker.
IDLE - Enum constant in enum class com.mongodb.event.ConnectionClosedEvent.Reason
The connection became stale by being idle for too long
Immutable - Annotation Interface in com.mongodb.annotations
The class to which this annotation is applied is immutable.
in(String, Iterable<TItem>) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of a field equals any value in the list of specified values.
in(String, TItem...) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of a field equals any value in the list of specified values.
inc(String, Number) - Static method in class com.mongodb.client.model.Updates
Creates an update that increments the value of the field with the given name by the given value.
include(String...) - Static method in class com.mongodb.client.model.Projections
Creates a projection that includes all of the given fields.
include(List<String>) - Static method in class com.mongodb.client.model.Projections
Creates a projection that includes all of the given fields.
includeArrayIndex(String) - Method in class com.mongodb.client.model.UnwindOptions
Sets the field to be used to store the array index of the unwound item
includeLocs(String) - Method in interface com.mongodb.client.model.GeoNearOptions
This specifies the output field that identifies the location used to calculate the distance.
index(String) - Method in interface com.mongodb.client.model.search.SearchOptions
Creates a new SearchOptions with the index name specified.
Indexes - Class in com.mongodb.client.model
A factory for defining index keys.
IndexModel - Class in com.mongodb.client.model
A model describing the creation of a single index.
IndexModel(Bson) - Constructor for class com.mongodb.client.model.IndexModel
Construct an instance with the given keys.
IndexModel(Bson, IndexOptions) - Constructor for class com.mongodb.client.model.IndexModel
Construct an instance with the given keys and options.
indexOptionDefaults(IndexOptionDefaults) - Method in class com.mongodb.client.model.CreateCollectionOptions
Sets the index option defaults for the collection.
IndexOptionDefaults - Class in com.mongodb.client.model
The default options for a collection to apply on the creation of indexes.
IndexOptionDefaults() - Constructor for class com.mongodb.client.model.IndexOptionDefaults
 
IndexOptions - Class in com.mongodb.client.model
The options to apply to the creation of an index.
IndexOptions() - Constructor for class com.mongodb.client.model.IndexOptions
 
inetAddressResolver(InetAddressResolver) - Method in class com.mongodb.MongoClientSettings.Builder
Sets the InetAddressResolver to use for looking up the InetAddress instances for each host.
InetAddressResolver - Interface in com.mongodb.spi.dns
This interface defines operations for looking up host names.
InetAddressResolverProvider - Interface in com.mongodb.spi.dns
Service-provider class for InetAddressResolver.
INSERT - Enum constant in enum class com.mongodb.client.model.changestream.OperationType
The insert operation type
INSERT - Enum constant in enum class com.mongodb.client.model.MergeOptions.WhenNotMatched
Insert the document into the output collection.
InsertManyOptions - Class in com.mongodb.client.model
The options to apply to an operation that inserts multiple documents into a collection.
InsertManyOptions() - Constructor for class com.mongodb.client.model.InsertManyOptions
 
InsertManyResult - Class in com.mongodb.client.result
The result of an insert many operation.
InsertManyResult() - Constructor for class com.mongodb.client.result.InsertManyResult
 
InsertOneModel<T> - Class in com.mongodb.client.model
A model describing an insert of a single document.
InsertOneModel(T) - Constructor for class com.mongodb.client.model.InsertOneModel
Construct a new instance.
InsertOneOptions - Class in com.mongodb.client.model
The options to apply to an operation that inserts a single document into a collection.
InsertOneOptions() - Constructor for class com.mongodb.client.model.InsertOneOptions
 
InsertOneResult - Class in com.mongodb.client.result
The result of an insert one operation.
InsertOneResult() - Constructor for class com.mongodb.client.result.InsertOneResult
 
integral(String, TExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the approximate integral of a function that maps values of the sortBy field to evaluation results of the expression against the same document.
INVALIDATE - Enum constant in enum class com.mongodb.client.model.changestream.OperationType
The invalidate operation type
invalidHostNameAllowed(boolean) - Method in class com.mongodb.connection.SslSettings.Builder
Define whether invalid host names should be allowed.
is(Function<? super T, MqlBoolean>, Function<? super T, ? extends R>) - Method in class com.mongodb.client.model.mql.Branches
A successful check for the specified predicate produces a value specified by the mapping.
is(Function<? super T, MqlBoolean>, Function<? super T, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
A successful check for the specified predicate produces a value specified by the mapping.
isAcknowledged() - Method in class com.mongodb.WriteConcern
Returns true if this write concern indicates that write operations must be acknowledged.
isArray(Function<? super MqlArray<Q>, ? extends R>) - Method in class com.mongodb.client.model.mql.Branches
A successful check for being an array produces a value specified by the mapping.
isArray(Function<? super MqlArray<Q>, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
A successful check for being an array produces a value specified by the mapping.
isArrayOr(MqlArray<? extends T>) - Method in interface com.mongodb.client.model.mql.MqlValue
this value as a array if this is an array, or the other array value if this is null, or is missing, or is of any other non-array type.
isAwaited() - Method in class com.mongodb.event.ServerHeartbeatFailedEvent
Gets whether the heartbeat was awaited.
isAwaited() - Method in class com.mongodb.event.ServerHeartbeatStartedEvent
Gets whether the heartbeat is for an awaitable `hello` / legacy hello.
isAwaited() - Method in class com.mongodb.event.ServerHeartbeatSucceededEvent
Gets whether the heartbeat was awaited.
isBackground() - Method in class com.mongodb.client.model.IndexOptions
Create the index in the background
isBoolean(Function<? super MqlBoolean, ? extends R>) - Method in class com.mongodb.client.model.mql.Branches
A successful check for being a boolean produces a value specified by the mapping.
isBoolean(Function<? super MqlBoolean, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
A successful check for being a boolean produces a value specified by the mapping.
isBooleanOr(MqlBoolean) - Method in interface com.mongodb.client.model.mql.MqlValue
this value as a boolean if this is a boolean, or the other boolean value if this is null, or is missing, or is of any other non-boolean type.
isBypassAutoEncryption() - Method in class com.mongodb.AutoEncryptionSettings
Gets whether auto-encryption should be bypassed.
isBypassQueryAnalysis() - Method in class com.mongodb.AutoEncryptionSettings
Gets whether automatic analysis of outgoing commands is set.
isCapped() - Method in class com.mongodb.client.model.CreateCollectionOptions
Gets whether the collection is capped.
isCausallyConsistent() - Method in class com.mongodb.ClientSessionOptions
Whether operations using the session should causally consistent with each other.
isCausallyConsistent() - Method in interface com.mongodb.session.ClientSession
Returns true if operations in this session must be causally consistent
isClosed() - Method in interface com.mongodb.session.ServerSession
Whether the server session is closed.
isCompatibleWithDriver() - Method in class com.mongodb.connection.ClusterDescription
Return whether all servers in the cluster are compatible with the driver.
isCompatibleWithDriver() - Method in class com.mongodb.connection.ServerDescription
Return whether the server is compatible with the driver.
isCryptd() - Method in class com.mongodb.connection.ServerDescription
Returns whether this server is mongocryptd.
isDate(Function<? super MqlDate, ? extends R>) - Method in class com.mongodb.client.model.mql.Branches
A successful check for being a date produces a value specified by the mapping.
isDate(Function<? super MqlDate, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
A successful check for being a date produces a value specified by the mapping.
isDateOr(MqlDate) - Method in interface com.mongodb.client.model.mql.MqlValue
this value as a boolean if this is a date, or the other date value if this is null, or is missing, or is of any other non-date type.
isDirectConnection() - Method in class com.mongodb.ConnectionString
Indicates if the connection should be a direct connection
isDocument(Function<? super MqlDocument, ? extends R>) - Method in class com.mongodb.client.model.mql.Branches
A successful check for being a document (or document-like value, see MqlMap and MqlEntry) produces a value specified by the mapping.
isDocument(Function<? super MqlDocument, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
A successful check for being a document (or document-like value, see MqlMap and MqlEntry) produces a value specified by the mapping.
isDocumentOr(T) - Method in interface com.mongodb.client.model.mql.MqlValue
this value as a document if this is a document (or document-like value, see MqlMap and MqlEntry) or the other document value if this is null, or is missing, or is of any other non-document type.
isDropTarget() - Method in class com.mongodb.client.model.RenameCollectionOptions
Gets if mongod should drop the target of renameCollection prior to renaming the collection.
isEmpty() - Method in class com.mongodb.BasicDBObjectBuilder
Returns true if no key/value was inserted into the top level document.
isEmpty() - Method in interface com.mongodb.RequestContext
Return true if the RequestContext is empty.
isEnabled() - Method in class com.mongodb.client.model.ChangeStreamPreAndPostImagesOptions
Gets whether change stream pre- and post- images are enabled for the collection.
isEnabled() - Method in class com.mongodb.connection.SslSettings
Returns whether SSL is enabled.
isEnabled() - Method in class com.mongodb.ReadPreferenceHedgeOptions
Gets whether hedged reads are enabled in the server.
isHelloOk() - Method in class com.mongodb.connection.ServerDescription
Gets whether this server supports the "hello" command.
isHidden() - Method in class com.mongodb.client.model.IndexOptions
Gets whether the index should not be used by the query planner when executing operations.
isIncompatiblyNewerThanDriver() - Method in class com.mongodb.connection.ServerDescription
Return whether the server is compatible with the driver.
isIncompatiblyOlderThanDriver() - Method in class com.mongodb.connection.ServerDescription
Return whether the server is compatible with the driver.
isInteger(Function<? super MqlInteger, ? extends R>) - Method in class com.mongodb.client.model.mql.Branches
A successful check for being an integer produces a value specified by the mapping.
isInteger(Function<? super MqlInteger, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
A successful check for being an integer produces a value specified by the mapping.
isIntegerOr(MqlInteger) - Method in interface com.mongodb.client.model.mql.MqlValue
this value as an integer if this is an integer, or the other integer value if this is null, or is missing, or is of any other non-integer type.
isInvalidHostNameAllowed() - Method in class com.mongodb.connection.SslSettings
Returns whether invalid host names should be allowed.
isLoadBalanced() - Method in class com.mongodb.ConnectionString
Indicates if the connection is through a load balancer.
isMap(Function<? super MqlMap<Q>, ? extends R>) - Method in class com.mongodb.client.model.mql.Branches
A successful check for being a map (or map-like value, see MqlDocument and MqlEntry) produces a value specified by the mapping.
isMap(Function<? super MqlMap<Q>, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
A successful check for being a map (or map-like value, see MqlDocument and MqlEntry) produces a value specified by the mapping.
isMapOr(MqlMap<? extends T>) - Method in interface com.mongodb.client.model.mql.MqlValue
this value as a map if this is a map (or map-like value, see MqlDocument and MqlEntry) or the other map value if this is null, or is missing, or is of any other non-map type.
isMarkedDirty() - Method in interface com.mongodb.session.ServerSession
Whether the server session is marked dirty.
isNull(Function<? super MqlValue, ? extends R>) - Method in class com.mongodb.client.model.mql.Branches
A successful check for MqlValues.ofNull() being the null value} produces a value specified by the mapping.
isNull(Function<? super MqlValue, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
A successful check for MqlValues.ofNull() being the null value} produces a value specified by the mapping.
isNumber(Function<? super MqlNumber, ? extends R>) - Method in class com.mongodb.client.model.mql.Branches
A successful check for being a number produces a value specified by the mapping.
isNumber(Function<? super MqlNumber, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
A successful check for being a number produces a value specified by the mapping.
isNumberOr(MqlNumber) - Method in interface com.mongodb.client.model.mql.MqlValue
this value as a number if this is a number, or the other number value if this is null, or is missing, or is of any other non-number type.
isOk() - Method in class com.mongodb.connection.ServerDescription
The isOK() result from requesting this information from the server
isOrdered() - Method in class com.mongodb.client.model.BulkWriteOptions
If true, then when a write fails, return without performing the remaining writes.
isOrdered() - Method in class com.mongodb.client.model.InsertManyOptions
Gets whether the documents should be inserted in the order provided, stopping on the first failed insertion.
isPartialObject() - Method in class com.mongodb.BasicDBList
 
isPartialObject() - Method in class com.mongodb.BasicDBObject
Whether BasicDBObject.markAsPartialObject() was ever called only matters if you are going to upsert and do not want to risk losing fields.
isPartialObject() - Method in interface com.mongodb.DBObject
Whether DBObject.markAsPartialObject() was ever called only matters if you are going to upsert and do not want to risk losing fields.
isPreserveNullAndEmptyArrays() - Method in class com.mongodb.client.model.UnwindOptions
If true the unwind stage will include documents that have null values or empty arrays
isPrimary() - Method in class com.mongodb.connection.ServerDescription
Returns whether this can be treated as a primary server.
isProxyEnabled() - Method in class com.mongodb.connection.ProxySettings
Checks if the SOCKS5 proxy is enabled.
isReplicaSetMember() - Method in class com.mongodb.connection.ServerDescription
Gets whether this server is a replica set member.
isSecondary() - Method in class com.mongodb.connection.ServerDescription
Returns whether this can be treated as a secondary server.
isSecondaryOk() - Method in class com.mongodb.ReadPreference
True if this read preference allows reading from a secondary member of a replica set.
isSecondaryOk() - Method in class com.mongodb.TaggableReadPreference
 
isServerDefault() - Method in class com.mongodb.ReadConcern
 
isServerDefault() - Method in class com.mongodb.WriteConcern
Gets whether this write concern indicates that the server's default write concern will be used.
isShardRouter() - Method in class com.mongodb.connection.ServerDescription
Gets whether this is a server that is the entry point to a sharded instance of MongoDB.
isSnapshot() - Method in class com.mongodb.ClientSessionOptions
Whether read operations using this session should all share the same snapshot.
isSparse() - Method in class com.mongodb.client.model.IndexOptions
If true, the index only references documents with the specified field
isSrvProtocol() - Method in class com.mongodb.ConnectionString
Returns true if the connection string requires SRV protocol to resolve the host lists from the configured host.
isStandAlone() - Method in class com.mongodb.connection.ServerDescription
Gets whether this is part of a replica set/sharded system, or is a single server.
isString(Function<? super MqlString, ? extends R>) - Method in class com.mongodb.client.model.mql.Branches
A successful check for being a string produces a value specified by the mapping.
isString(Function<? super MqlString, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
A successful check for being a string produces a value specified by the mapping.
isStringOr(MqlString) - Method in interface com.mongodb.client.model.mql.MqlValue
this value as a string if this is a string, or the other string value if this is null, or is missing, or is of any other non-string type.
isTailable() - Method in enum class com.mongodb.CursorType
True if the cursor type is tailable.
isUnique() - Method in class com.mongodb.client.model.ClusteredIndexOptions
Gets whether the index entries must be unique
isUnique() - Method in class com.mongodb.client.model.IndexOptions
Gets if the index should be unique.
isUpdateOfExisting() - Method in class com.mongodb.WriteConcernResult
Returns true if the write was an update of an existing document.
isUpsert() - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Returns true if a new document should be inserted if there are no matches to the query filter.
isUpsert() - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Returns true if a new document should be inserted if there are no matches to the query filter.
isUpsert() - Method in class com.mongodb.client.model.ReplaceOptions
Returns true if a new document should be inserted if there are no matches to the query filter.
isUpsert() - Method in class com.mongodb.client.model.UpdateOptions
Returns true if a new document should be inserted if there are no matches to the query filter.
ITERATION - Enum constant in enum class com.mongodb.client.cursor.TimeoutMode
The timeout is reset for each batch iteration of the cursor
iterator() - Method in class com.mongodb.TagSet
 

J

JAVA_SASL_CLIENT_PROPERTIES_KEY - Static variable in class com.mongodb.MongoCredential
Mechanism property key for overriding the SaslClient properties for GSSAPI authentication.
JAVA_SUBJECT_KEY - Static variable in class com.mongodb.MongoCredential
Mechanism property key for overriding the Subject under which GSSAPI authentication executes.
JAVA_SUBJECT_PROVIDER_KEY - Static variable in class com.mongodb.MongoCredential
Mechanism property key for controlling the Subject under which GSSAPI authentication executes.
Jep395RecordCodecProvider - Class in com.mongodb
A CodecProvider for Java Records.
Jep395RecordCodecProvider() - Constructor for class com.mongodb.Jep395RecordCodecProvider
 
JMXConnectionPoolListener - Class in com.mongodb.management
A connection pool listener that manages a set of JMX MBeans, one for each connection pool.
JMXConnectionPoolListener() - Constructor for class com.mongodb.management.JMXConnectionPoolListener
 
joinStrings(Function<? super T, MqlString>) - Method in interface com.mongodb.client.model.mql.MqlArray
The string-concatenation of all the values of this array, via the provided mapper.
JOURNALED - Static variable in class com.mongodb.WriteConcern
Write operations wait for the server to group commit to the journal file on disk.
jsonSchema(Bson) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents that validate against the given JSON schema document.

K

KEEP_EXISTING - Enum constant in enum class com.mongodb.client.model.MergeOptions.WhenMatched
Keep the existing document in the output collection.
KerberosSubjectProvider - Class in com.mongodb
An implementation of SubjectProvider suitable for use as the value of the MongoCredential.JAVA_SUBJECT_PROVIDER_KEY mechanism property for Kerberos credentials, created via MongoCredential.createGSSAPICredential(String).
KerberosSubjectProvider() - Constructor for class com.mongodb.KerberosSubjectProvider
Construct an instance with the default login context name "com.sun.security.jgss.krb5.initiate".
KerberosSubjectProvider(String) - Constructor for class com.mongodb.KerberosSubjectProvider
Construct an instance with the specified login context name
key(String) - Method in interface com.mongodb.client.model.GeoNearOptions
Specify the geospatial indexed field to use when calculating the distance.
keyAltName(String) - Method in class com.mongodb.client.model.vault.EncryptOptions
Sets the alternate key name
keyAltNames(List<String>) - Method in class com.mongodb.client.model.vault.DataKeyOptions
Set the alternate key names.
keyId(BsonBinary) - Method in class com.mongodb.client.model.vault.EncryptOptions
Sets the key identifier
keyMaterial(byte[]) - Method in class com.mongodb.client.model.vault.DataKeyOptions
Sets the key material
keyVaultMongoClientSettings(MongoClientSettings) - Method in class com.mongodb.AutoEncryptionSettings.Builder
Sets the key vault settings.
keyVaultMongoClientSettings(MongoClientSettings) - Method in class com.mongodb.ClientEncryptionSettings.Builder
Sets the MongoClientSettings that will be used to access the key vault.
keyVaultNamespace(String) - Method in class com.mongodb.AutoEncryptionSettings.Builder
Sets the key vault namespace
keyVaultNamespace(String) - Method in class com.mongodb.ClientEncryptionSettings.Builder
Sets the key vault namespace
kmsProviderPropertySuppliers(Map<String, Supplier<Map<String, Object>>>) - Method in class com.mongodb.AutoEncryptionSettings.Builder
This method is similar to AutoEncryptionSettings.Builder.kmsProviders(Map), but instead of configuring properties for KMS providers, it configures Suppliers of properties.
kmsProviderPropertySuppliers(Map<String, Supplier<Map<String, Object>>>) - Method in class com.mongodb.ClientEncryptionSettings.Builder
This method is similar to ClientEncryptionSettings.Builder.kmsProviders(Map), but instead of setting properties for KMS providers, it sets Suppliers of properties.
kmsProviders(Map<String, Map<String, Object>>) - Method in class com.mongodb.AutoEncryptionSettings.Builder
Sets the KMS providers map.
kmsProviders(Map<String, Map<String, Object>>) - Method in class com.mongodb.ClientEncryptionSettings.Builder
Sets the KMS providers map.
kmsProviderSslContextMap(Map<String, SSLContext>) - Method in class com.mongodb.AutoEncryptionSettings.Builder
Sets the KMS provider to SSLContext map
kmsProviderSslContextMap(Map<String, SSLContext>) - Method in class com.mongodb.ClientEncryptionSettings.Builder
Sets the KMS provider to SSLContext map
KotlinCodecProvider - Class in com.mongodb
A CodecProvider for Kotlin data classes.
KotlinCodecProvider() - Constructor for class com.mongodb.KotlinCodecProvider
 

L

language(String) - Method in class com.mongodb.client.model.TextSearchOptions
Set the language for the text search
languageOverride(String) - Method in class com.mongodb.client.model.IndexOptions
Sets the name of the field that contains the language string.
last() - Method in interface com.mongodb.client.model.mql.MqlArray
Returns the last element of this array.
last(String, TExpression) - Static method in class com.mongodb.client.model.Accumulators
Gets a field name for a $group operation representing the value of the given expression when applied to the last member of the group.
last(String, TExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the evaluation result of the expression against the last document in the window.
lastN(String, InExpression, NExpression) - Static method in class com.mongodb.client.model.Accumulators
Returns a combination of a computed field and an accumulator that produces a BSON Array of values of the given inExpression computed for the last N elements within a presorted group, where N is the positive integral value of the nExpression.
lastN(String, InExpression, NExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of a BSON Array of evaluation results of the inExpression against the last N documents in the window, where N is the positive integral value of the nExpression.
lastUpdateTimeNanos(long) - Method in class com.mongodb.connection.ServerDescription.Builder
Sets the last update time for this description, which is simply the time that the server description was created.
lastWriteDate(Date) - Method in class com.mongodb.connection.ServerDescription.Builder
Sets the lastWriteDate reported by this server
length() - Method in interface com.mongodb.client.model.mql.MqlString
The number of Unicode code points in this string.
lengthBytes() - Method in interface com.mongodb.client.model.mql.MqlString
The number of UTF-8 encoded bytes in this string.
let(Bson) - Method in class com.mongodb.client.model.BulkWriteOptions
Add top-level variables for the operation
let(Bson) - Method in class com.mongodb.client.model.DeleteOptions
Add top-level variables for the operation
let(Bson) - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Add top-level variables for the operation
let(Bson) - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Add top-level variables for the operation
let(Bson) - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Add top-level variables for the operation
let(Bson) - Method in class com.mongodb.client.model.ReplaceOptions
Add top-level variables for the operation
let(Bson) - Method in class com.mongodb.client.model.UpdateOptions
Add top-level variables for the operation
LEVEL - Static variable in class com.mongodb.MongoCompressor
The property key for defining the compression level.
limit(int) - Static method in class com.mongodb.client.model.Aggregates
Creates a $limit pipeline stage for the specified filter
limit(int) - Method in class com.mongodb.client.model.CountOptions
Sets the limit to apply.
LINE_STRING - Enum constant in enum class com.mongodb.client.model.geojson.GeoJsonObjectType
A LineString
linear(String) - Static method in interface com.mongodb.client.model.fill.FillOutputField
Returns a FillOutputField that uses the linear method.
linearFill(String, TExpression) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of a value that is equal to the evaluation result of the expression when it is non-Null, or to the linear interpolation of surrounding evaluation results of the expression when the result is Null.
LinearFillOutputField - Interface in com.mongodb.client.model.fill
 
LINEARIZABLE - Enum constant in enum class com.mongodb.ReadConcernLevel
The linearizable read concern level.
LINEARIZABLE - Static variable in class com.mongodb.ReadConcern
The linearizable read concern.
LineString - Class in com.mongodb.client.model.geojson
A representation of a GeoJSON LineString.
LineString(CoordinateReferenceSystem, List<Position>) - Constructor for class com.mongodb.client.model.geojson.LineString
Construct an instance with the given coordinates and coordinate reference system.
LineString(List<Position>) - Constructor for class com.mongodb.client.model.geojson.LineString
Construct an instance with the given coordinates.
LineStringCodec - Class in com.mongodb.client.model.geojson.codecs
A Codec for a GeoJSON LineString.
LineStringCodec(CodecRegistry) - Constructor for class com.mongodb.client.model.geojson.codecs.LineStringCodec
Construct a new instance
LINK - Enum constant in enum class com.mongodb.client.model.geojson.CoordinateReferenceSystemType
A coordinate reference system that is specifed by a dereferenceable URI
LOAD_BALANCED - Enum constant in enum class com.mongodb.connection.ClusterConnectionMode
Connect to one or more mongos servers via a load balancer
LOAD_BALANCED - Enum constant in enum class com.mongodb.connection.ClusterType
A load-balanced cluster, connected via a single load balancer
LOAD_BALANCER - Enum constant in enum class com.mongodb.connection.ServerType
 
LOCAL - Enum constant in enum class com.mongodb.ReadConcernLevel
The local read concern level.
LOCAL - Static variable in class com.mongodb.ReadConcern
The local read concern.
locale(String) - Method in class com.mongodb.client.model.Collation.Builder
Sets the locale
localThreshold(long, TimeUnit) - Method in class com.mongodb.connection.ClusterSettings.Builder
Sets the local threshold.
locf(String) - Static method in interface com.mongodb.client.model.fill.FillOutputField
Returns a FillOutputField that uses the locf method.
locf(String, TExpression) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the last observed non-Null evaluation result of the expression.
LocfFillOutputField - Interface in com.mongodb.client.model.fill
 
log1pExpression(SearchScoreExpression) - Static method in interface com.mongodb.client.model.search.SearchScoreExpression
Returns a SearchScoreExpression that evaluates into log10(expressionValue + 1), where expressionValue is the value of the expression.
Log1pSearchScoreExpression - Interface in com.mongodb.client.model.search
 
logExpression(SearchScoreExpression) - Static method in interface com.mongodb.client.model.search.SearchScoreExpression
Returns a SearchScoreExpression that evaluates into log10(expressionValue), where expressionValue is the value of the expression.
LoggerSettings - Class in com.mongodb
An immutable class representing settings for logging.
LoggerSettings.Builder - Class in com.mongodb
A builder for an instance of LoggerSettings.
logicalSessionTimeoutMinutes(Integer) - Method in class com.mongodb.connection.ServerDescription.Builder
Sets the session timeout in minutes.
LogSearchScoreExpression - Interface in com.mongodb.client.model.search
 
lookup(String, String, String, String) - Static method in class com.mongodb.client.model.Aggregates
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
lookup(String, List<? extends Bson>, String) - Static method in class com.mongodb.client.model.Aggregates
Creates a $lookup pipeline stage, joining the current collection with the one specified in from using the given pipeline.
lookup(String, List<Variable<TExpression>>, List<? extends Bson>, String) - Static method in class com.mongodb.client.model.Aggregates
Creates a $lookup pipeline stage, joining the current collection with the one specified in from using the given pipeline.
lookupByName(String) - Method in interface com.mongodb.spi.dns.InetAddressResolver
Given the name of a host, returns a list of IP addresses of the requested address family associated with a provided hostname.
LOWER - Enum constant in enum class com.mongodb.client.model.CollationCaseFirst
Lowercase first
lowerBound() - Static method in interface com.mongodb.client.model.search.SearchCount
Returns a SearchCount that instructs to count documents exactly only up to a threshold.
LowerBoundSearchCount - Interface in com.mongodb.client.model.search
 
lt(MqlValue) - Method in interface com.mongodb.client.model.mql.MqlValue
Whether this value is less than the other value.
lt(Number) - Method in interface com.mongodb.client.model.search.NumberRangeSearchOperatorBase
Creates a new NumberRangeSearchOperator that tests if values are within (-∞; u).
lt(String, TItem) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of the given field is less than the specified value.
lt(Instant) - Method in interface com.mongodb.client.model.search.DateRangeSearchOperatorBase
Creates a new DateRangeSearchOperator that tests if values are within (-∞; u).
lt(T, Function<? super T, ? extends R>) - Method in class com.mongodb.client.model.mql.Branches
A successful check for being less than the provided value v produces a value specified by the mapping.
lt(T, Function<? super T, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
A successful check for being less than the provided value v produces a value specified by the mapping.
lte(MqlValue) - Method in interface com.mongodb.client.model.mql.MqlValue
Whether this value is less than or equal to the other value.
lte(Number) - Method in interface com.mongodb.client.model.search.NumberRangeSearchOperatorBase
Creates a new NumberRangeSearchOperator that tests if values are within (-∞; u].
lte(String, TItem) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of the given field is less than or equal to the specified value.
lte(Instant) - Method in interface com.mongodb.client.model.search.DateRangeSearchOperatorBase
Creates a new DateRangeSearchOperator that tests if values are within (-∞; u].
lte(T, Function<? super T, ? extends R>) - Method in class com.mongodb.client.model.mql.Branches
A successful check for being less than or equal to the provided value v produces a value specified by the mapping.
lte(T, Function<? super T, ? extends R>) - Method in class com.mongodb.client.model.mql.BranchesIntermediary
A successful check for being less than or equal to the provided value v produces a value specified by the mapping.

M

maintenanceFrequency(long, TimeUnit) - Method in class com.mongodb.connection.ConnectionPoolSettings.Builder
The time period between runs of the maintenance job.
maintenanceInitialDelay(long, TimeUnit) - Method in class com.mongodb.connection.ConnectionPoolSettings.Builder
The period of time to wait before running the first maintenance job on the connection pool.
MAJORITY - Enum constant in enum class com.mongodb.ReadConcernLevel
The majority read concern level.
MAJORITY - Static variable in class com.mongodb.CreateIndexCommitQuorum
A create index commit quorum of majority.
MAJORITY - Static variable in class com.mongodb.ReadConcern
The majority read concern.
MAJORITY - Static variable in class com.mongodb.WriteConcern
Exceptions are raised for network issues, and server errors; waits on a majority of servers for the write operation.
map(Function<? super T, ? extends R>) - Method in interface com.mongodb.client.model.mql.MqlArray
An array consisting of the results of applying the provided function to the elements of this array.
MapReduceAction - Enum Class in com.mongodb.client.model
Deprecated.
Superseded by aggregate
markAsPartialObject() - Method in class com.mongodb.BasicDBList
 
markAsPartialObject() - Method in class com.mongodb.BasicDBObject
If this object was retrieved with only some fields (using a field filter) this method will be called to mark it as such.
markAsPartialObject() - Method in interface com.mongodb.DBObject
If this object was retrieved with only some fields (using a field filter) this method will be called to mark it as such.
markDirty() - Method in interface com.mongodb.session.ServerSession
Mark the server session as dirty.
masterKey(BsonDocument) - Method in class com.mongodb.client.model.CreateEncryptedCollectionParams
Sets the master key for creating a data key.
masterKey(BsonDocument) - Method in class com.mongodb.client.model.vault.DataKeyOptions
Sets the master key document.
masterKey(BsonDocument) - Method in class com.mongodb.client.model.vault.RewrapManyDataKeyOptions
Sets the optional master key document.
match(Bson) - Static method in class com.mongodb.client.model.Aggregates
Creates a $match pipeline stage for the specified filter
max(MqlInteger) - Method in interface com.mongodb.client.model.mql.MqlInteger
The larger value of this and the other value.
max(MqlNumber) - Method in interface com.mongodb.client.model.mql.MqlNumber
The larger value of this and the other value.
max(Double) - Method in class com.mongodb.client.model.IndexOptions
Sets the upper inclusive boundary for the longitude and latitude values for 2d indexes..
max(String, TExpression) - Static method in class com.mongodb.client.model.Accumulators
Gets a field name for a $group operation representing the maximum of the values of the given expression when applied to all members of the group.
max(String, TExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the largest of the evaluation results of the expression over the window.
max(String, TItem) - Static method in class com.mongodb.client.model.Updates
Creates an update that sets the value of the field to the given value if the given value is greater than the current value of the field.
max(BsonValue) - Method in class com.mongodb.client.model.vault.RangeOptions
Set the maximum value set in the encryptedFields of the destination collection.
max(T) - Method in interface com.mongodb.client.model.mql.MqlArray
The largest value all the values of this array, or the other value if this array is empty.
MAX_DRIVER_WIRE_VERSION - Static variable in class com.mongodb.connection.ServerDescription
The maximum supported driver wire version
maxCharsToExamine(int) - Method in interface com.mongodb.client.model.search.SearchHighlight
Creates a new SearchHighlight with the maximum number of characters to examine on a document when performing highlighting for a field.
maxCommitTime(Long, TimeUnit) - Method in class com.mongodb.TransactionOptions.Builder
Sets the maximum execution time on the server for the commitTransaction operation.
maxConnecting(int) - Method in class com.mongodb.connection.ConnectionPoolSettings.Builder
The maximum number of connections a pool may be establishing concurrently.
maxConnectionIdleTime(long, TimeUnit) - Method in class com.mongodb.connection.ConnectionPoolSettings.Builder
The maximum idle time of a pooled connection.
maxConnectionLifeTime(long, TimeUnit) - Method in class com.mongodb.connection.ConnectionPoolSettings.Builder
The maximum time a pooled connection can live for.
maxDepth(Integer) - Method in class com.mongodb.client.model.GraphLookupOptions
Specifies a maximum recursive depth for the $graphLookup.
maxDistance(Number) - Method in interface com.mongodb.client.model.GeoNearOptions
The maximum distance from the center point that the documents can be.
maxDocumentLength(int) - Method in class com.mongodb.LoggerSettings.Builder
Sets the max document length.
maxDocuments(long) - Method in class com.mongodb.client.model.CreateCollectionOptions
Sets the maximum number of documents allowed in a capped collection.
maxDocumentSize(int) - Method in class com.mongodb.connection.ServerDescription.Builder
The maximum permitted size of a BSON object in bytes for this mongod process.
maxEdits(int) - Method in interface com.mongodb.client.model.search.FuzzySearchOptions
Creates a new FuzzySearchOptions with the maximum number of single-character edits required to match a search term.
maxExpansions(int) - Method in interface com.mongodb.client.model.search.FuzzySearchOptions
Creates a new FuzzySearchOptions with the maximum number of variations to generate and consider to match a search term.
maxN(MqlInteger) - Method in interface com.mongodb.client.model.mql.MqlArray
The largest n elements of this array, or all elements if the array contains fewer than n elements.
maxN(String, InExpression, NExpression) - Static method in class com.mongodb.client.model.Accumulators
Returns a combination of a computed field and an accumulator that produces a BSON Array of N largest values of the given inExpression, where N is the positive integral value of the nExpression.
maxN(String, InExpression, NExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of a BSON Array of N largest evaluation results of the inExpression over the window, where N is the positive integral value of the nExpression.
maxNumPassages(int) - Method in interface com.mongodb.client.model.search.SearchHighlight
Creates a new SearchHighlight with the maximum number of high-scoring passages to return per document in the "highlights" results for each field.
maxSize(int) - Method in class com.mongodb.connection.ConnectionPoolSettings.Builder
The maximum number of connections allowed.
maxTime(long, TimeUnit) - Method in class com.mongodb.client.model.CountOptions
Sets the maximum execution time on the server for this operation.
maxTime(long, TimeUnit) - Method in class com.mongodb.client.model.CreateIndexOptions
Sets the maximum execution time on the server for this operation.
maxTime(long, TimeUnit) - Method in class com.mongodb.client.model.DropIndexOptions
Sets the maximum execution time on the server for this operation.
maxTime(long, TimeUnit) - Method in class com.mongodb.client.model.EstimatedDocumentCountOptions
Sets the maximum execution time on the server for this operation.
maxTime(long, TimeUnit) - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Sets the maximum execution time on the server for this operation.
maxTime(long, TimeUnit) - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Sets the maximum execution time on the server for this operation.
maxTime(long, TimeUnit) - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Sets the maximum execution time on the server for this operation.
maxWaitTime(long, TimeUnit) - Method in class com.mongodb.connection.ConnectionPoolSettings.Builder
The maximum duration to wait until either: an in-use connection becomes available; or a connection is created and begins to be established.
maxWireVersion(int) - Method in class com.mongodb.connection.ServerDescription.Builder
The latest version of the wire protocol that this MongoDB server is capable of using to communicate with clients.
median(String, InExpression, QuantileMethod) - Static method in class com.mongodb.client.model.Accumulators
Returns a combination of a computed field and an accumulator that generates a BSON Double representing the median value computed from the given inExpression within a group.
median(String, InExpression, QuantileMethod, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field representing the median value of the evaluation results of the inExpression over documents in the specified window.
merge(MqlDocument) - Method in interface com.mongodb.client.model.mql.MqlDocument
Returns a document with the same fields as this document, but with any fields present in the other document overwritten with the fields of that other document.
merge(MqlMap<? extends T>) - Method in interface com.mongodb.client.model.mql.MqlMap
Returns a map with the same entries as this map, but with any keys present in the other map overwritten with the values of that other map.
merge(MongoNamespace) - Static method in class com.mongodb.client.model.Aggregates
Creates a $merge pipeline stage that merges into the specified namespace
merge(MongoNamespace, MergeOptions) - Static method in class com.mongodb.client.model.Aggregates
Creates a $merge pipeline stage that merges into the specified namespace using the specified options.
merge(TransactionOptions, TransactionOptions) - Static method in class com.mongodb.TransactionOptions
Merge the two provided transaction options, with the first taking precedence over the second.
merge(String) - Static method in class com.mongodb.client.model.Aggregates
Creates a $merge pipeline stage that merges into the specified collection
merge(String, MergeOptions) - Static method in class com.mongodb.client.model.Aggregates
Creates a $merge pipeline stage that merges into the specified collection using the specified options.
MERGE - Enum constant in enum class com.mongodb.client.model.MapReduceAction
Deprecated.
Merge the new result with the existing result if the output collection already exists.
MERGE - Enum constant in enum class com.mongodb.client.model.MergeOptions.WhenMatched
Merge the matching documents
mergeObjects(String, TExpression) - Static method in class com.mongodb.client.model.Accumulators
Gets a field name for a $group operation representing the result of merging the fields of the documents.
MergeOptions - Class in com.mongodb.client.model
Options to control the behavior of the $merge aggregation stage
MergeOptions() - Constructor for class com.mongodb.client.model.MergeOptions
 
MergeOptions.WhenMatched - Enum Class in com.mongodb.client.model
The behavior of $merge if a result document and an existing document in the collection have the same value for the specified on field(s).
MergeOptions.WhenNotMatched - Enum Class in com.mongodb.client.model
The behavior of $merge if a result document does not match an existing document in the out collection.
meta(String, String) - Static method in class com.mongodb.client.model.Projections
Creates a $meta projection to the given field name for the given meta field name.
metadata(Document) - Method in class com.mongodb.client.gridfs.model.GridFSUploadOptions
Sets metadata to stored alongside the filename in the files collection
metaField(String) - Method in class com.mongodb.client.model.TimeSeriesOptions
Sets the name of the meta field.
metaSearchHighlights(String) - Static method in class com.mongodb.client.model.Projections
Creates a projection to the given field name of the searchHighlights, for use with Aggregates.search(SearchOperator, SearchOptions) / Aggregates.search(SearchCollector, SearchOptions).
metaSearchScore(String) - Static method in class com.mongodb.client.model.Projections
Creates a projection to the given field name of the searchScore, for use with Aggregates.search(SearchOperator, SearchOptions) / Aggregates.search(SearchCollector, SearchOptions).
metaTextScore(String) - Static method in class com.mongodb.client.model.Projections
Creates a projection to the given field name of the textScore, for use with text queries.
metaTextScore(String) - Static method in class com.mongodb.client.model.Sorts
Create a sort specification for the text score meta projection on the given field.
metaVectorSearchScore(String) - Static method in class com.mongodb.client.model.Projections
Creates a projection to the given field name of the vectorSearchScore, for use with Aggregates.vectorSearch(FieldSearchPath, Iterable, String, long, VectorSearchOptions) .
millisecond(MqlString) - Method in interface com.mongodb.client.model.mql.MqlDate
The millisecond part of this date as determined by the provided timezone, as an integer between 0 and 999.
MILLISECOND - Enum constant in enum class com.mongodb.client.model.MongoTimeUnit
millisecondsAsDate() - Method in interface com.mongodb.client.model.mql.MqlInteger
The date corresponding to this value when taken to be the number of milliseconds since the Unix epoch.
min(MqlInteger) - Method in interface com.mongodb.client.model.mql.MqlInteger
The smaller value of this and the other value.
min(MqlNumber) - Method in interface com.mongodb.client.model.mql.MqlNumber
The smaller value of this and the other value.
min(Double) - Method in class com.mongodb.client.model.IndexOptions
Sets the lower inclusive boundary for the longitude and latitude values for 2d indexes..
min(String, TExpression) - Static method in class com.mongodb.client.model.Accumulators
Gets a field name for a $group operation representing the minimum of the values of the given expression when applied to all members of the group.
min(String, TExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the smallest of the evaluation results of the expression over the window.
min(String, TItem) - Static method in class com.mongodb.client.model.Updates
Creates an update that sets the value of the field to the given value if the given value is less than the current value of the field.
min(BsonValue) - Method in class com.mongodb.client.model.vault.RangeOptions
Set the minimum value set in the encryptedFields of the destination collection.
min(T) - Method in interface com.mongodb.client.model.mql.MqlArray
The smallest value all the values of this array, or the other value if this array is empty.
MIN_DRIVER_SERVER_VERSION - Static variable in class com.mongodb.connection.ServerDescription
The minimum supported driver server version
MIN_DRIVER_WIRE_VERSION - Static variable in class com.mongodb.connection.ServerDescription
The minimum supported driver wire version
minDistance(Number) - Method in interface com.mongodb.client.model.GeoNearOptions
The minimum distance from the center point that the documents can be.
minHeartbeatFrequency(long, TimeUnit) - Method in class com.mongodb.connection.ServerSettings.Builder
Sets the minimum heartbeat frequency.
minimumShouldMatch(int) - Method in interface com.mongodb.client.model.search.ShouldCompoundSearchOperator
Creates a new ShouldCompoundSearchOperator that requires at least the requested number of clauses of those specified via CompoundSearchOperatorBase.should(Iterable) to be satisfied.
minN(MqlInteger) - Method in interface com.mongodb.client.model.mql.MqlArray
The smallest n elements of this array, or all elements if the array contains fewer than n elements.
minN(String, InExpression, NExpression) - Static method in class com.mongodb.client.model.Accumulators
Returns a combination of a computed field and an accumulator that produces a BSON Array of N smallest values of the given inExpression, where N is the positive integral value of the nExpression.
minN(String, InExpression, NExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of a BSON Array of N smallest evaluation results of the inExpression over the window, where N is the positive integral value of the nExpression.
minRoundTripTime(long, TimeUnit) - Method in class com.mongodb.connection.ServerDescription.Builder
Set the recent min time it took to make the round trip for requesting this information from the server
minSize(int) - Method in class com.mongodb.connection.ConnectionPoolSettings.Builder
The minimum number of connections.
minute(MqlString) - Method in interface com.mongodb.client.model.mql.MqlDate
The minute of this date as determined by the provided timezone, as an integer between 0 and 59.
MINUTE - Enum constant in enum class com.mongodb.client.model.MongoTimeUnit
MINUTES - Enum constant in enum class com.mongodb.client.model.TimeSeriesGranularity
Minutes-level granularity.
minWireVersion(int) - Method in class com.mongodb.connection.ServerDescription.Builder
The earliest version of the wire protocol that this MongoDB server is capable of using to communicate with clients.
mod(String, long, long) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of a field divided by a divisor has the specified remainder (i.e.
mode(ClusterConnectionMode) - Method in class com.mongodb.connection.ClusterSettings.Builder
Sets the mode for this cluster.
MODERATE - Enum constant in enum class com.mongodb.client.model.ValidationLevel
Applies validation rules to inserts and to updates on existing valid documents.
MongoBulkWriteException - Exception in com.mongodb
An exception that represents all errors associated with a bulk write operation.
MongoBulkWriteException(BulkWriteResult, List<BulkWriteError>, WriteConcernError, ServerAddress, Set<String>) - Constructor for exception com.mongodb.MongoBulkWriteException
Constructs a new instance.
MongoChangeStreamException - Exception in com.mongodb
An exception indicating that a failure occurred when running a $changeStream.
MongoChangeStreamException(String) - Constructor for exception com.mongodb.MongoChangeStreamException
Constructs a new instance.
MongoClientException - Exception in com.mongodb
A base class for exceptions indicating a failure condition with the MongoClient.
MongoClientException(String) - Constructor for exception com.mongodb.MongoClientException
Constructs a new instance.
MongoClientException(String, Throwable) - Constructor for exception com.mongodb.MongoClientException
Constructs a new instance.
MongoClientSettings - Class in com.mongodb
Various settings to control the behavior of a MongoClient.
MongoClientSettings.Builder - Class in com.mongodb
A builder for MongoClientSettings so that MongoClientSettings can be immutable, and to support easier construction through chaining.
MongoCommandException - Exception in com.mongodb
An exception indicating that a command sent to a MongoDB server returned a failure.
MongoCommandException(BsonDocument, ServerAddress) - Constructor for exception com.mongodb.MongoCommandException
Construct a new instance with the CommandResult from a failed command
MongoCompressor - Class in com.mongodb
Metadata describing a compressor to use for sending and receiving messages to a MongoDB server.
MongoConfigurationException - Exception in com.mongodb
An exception indicating a configuration error in the client.
MongoConfigurationException(String) - Constructor for exception com.mongodb.MongoConfigurationException
Construct an instance with the given message.
MongoConfigurationException(String, Throwable) - Constructor for exception com.mongodb.MongoConfigurationException
Construct an instance with the given message and cause.
MongoConnectionPoolClearedException - Exception in com.mongodb
An exception that may usually happen as a result of another thread clearing a connection pool.
MongoConnectionPoolClearedException(ServerId, Throwable) - Constructor for exception com.mongodb.MongoConnectionPoolClearedException
Not part of the public API.
MongoCredential - Class in com.mongodb
Represents credentials to authenticate to a mongo server,as well as the source of the credentials and the authentication mechanism to use.
MongoCredential.IdpInfo - Interface in com.mongodb
The OIDC Identity Provider's configuration that can be used to acquire an Access Token.
MongoCredential.OidcCallback - Interface in com.mongodb
This callback is invoked when the OIDC-based authenticator requests tokens from the identity provider.
MongoCredential.OidcCallbackContext - Interface in com.mongodb
The context for the OIDC request callback.
MongoCredential.OidcCallbackResult - Class in com.mongodb
The OIDC credential information.
MongoCursorNotFoundException - Exception in com.mongodb
Subclass of MongoException representing a cursor-not-found exception.
MongoCursorNotFoundException(long, BsonDocument, ServerAddress) - Constructor for exception com.mongodb.MongoCursorNotFoundException
Construct an instance.
MONGODB_AWS - Enum constant in enum class com.mongodb.AuthenticationMechanism
The MONGODB-AWS mechanism.
MONGODB_OIDC - Enum constant in enum class com.mongodb.AuthenticationMechanism
The MONGODB-OIDC mechanism.
MONGODB_X509 - Enum constant in enum class com.mongodb.AuthenticationMechanism
The MongoDB X.509 mechanism.
MONGODB_X509_MECHANISM - Static variable in class com.mongodb.MongoCredential
The MongoDB X.509
MongoDriverInformation - Class in com.mongodb
The MongoDriverInformation class allows driver and library authors to add extra information about their library.
MongoDriverInformation.Builder - Class in com.mongodb
 
MongoException - Exception in com.mongodb
Top level Exception for all Exceptions, server-side or client-side, that come from the driver.
MongoException(int, String) - Constructor for exception com.mongodb.MongoException
 
MongoException(int, String, Throwable) - Constructor for exception com.mongodb.MongoException
 
MongoException(int, String, BsonDocument) - Constructor for exception com.mongodb.MongoException
 
MongoException(String) - Constructor for exception com.mongodb.MongoException
 
MongoException(String, Throwable) - Constructor for exception com.mongodb.MongoException
 
MongoExecutionTimeoutException - Exception in com.mongodb
Exception indicating that the execution of the current operation timed out as a result of the maximum operation time being exceeded.
MongoExecutionTimeoutException(int, String) - Constructor for exception com.mongodb.MongoExecutionTimeoutException
Construct a new instance.
MongoExecutionTimeoutException(int, String, BsonDocument) - Constructor for exception com.mongodb.MongoExecutionTimeoutException
Construct a new instance.
MongoExecutionTimeoutException(String) - Constructor for exception com.mongodb.MongoExecutionTimeoutException
Construct a new instance.
MongoGridFSException - Exception in com.mongodb
An exception indicating that a failure occurred in GridFS.
MongoGridFSException(String) - Constructor for exception com.mongodb.MongoGridFSException
Constructs a new instance.
MongoGridFSException(String, Throwable) - Constructor for exception com.mongodb.MongoGridFSException
Constructs a new instance.
MongoIncompatibleDriverException - Exception in com.mongodb
An exception indicating that this version of the driver is not compatible with at least one of the servers that it is currently connected to.
MongoIncompatibleDriverException(String, ClusterDescription) - Constructor for exception com.mongodb.MongoIncompatibleDriverException
Construct a new instance.
MongoInternalException - Exception in com.mongodb
A Mongo exception internal to the driver, not carrying any error code.
MongoInternalException(String) - Constructor for exception com.mongodb.MongoInternalException
 
MongoInternalException(String, Throwable) - Constructor for exception com.mongodb.MongoInternalException
 
MongoInterruptedException - Exception in com.mongodb
A driver-specific non-checked counterpart to InterruptedException.
MongoInterruptedException(String, Exception) - Constructor for exception com.mongodb.MongoInterruptedException
Construct a new instance.
MongoNamespace - Class in com.mongodb
A MongoDB namespace, which includes a database name and collection name.
MongoNamespace(String) - Constructor for class com.mongodb.MongoNamespace
Construct an instance for the given full name.
MongoNamespace(String, String) - Constructor for class com.mongodb.MongoNamespace
Construct an instance from the given database name and collection name.
MongoNodeIsRecoveringException - Exception in com.mongodb
An exception indicating that the server is a member of a replica set but is in recovery mode, and therefore refused to execute the operation.
MongoNodeIsRecoveringException(BsonDocument, ServerAddress) - Constructor for exception com.mongodb.MongoNodeIsRecoveringException
Construct an instance.
MongoNotPrimaryException - Exception in com.mongodb
An exception indicating that the server is a member of a replica set but is not the primary, and therefore refused to execute either a write operation or a read operation that required a primary.
MongoNotPrimaryException(BsonDocument, ServerAddress) - Constructor for exception com.mongodb.MongoNotPrimaryException
Construct an instance.
MongoOperationTimeoutException - Exception in com.mongodb
Exception thrown to indicate that a MongoDB operation has exceeded the specified timeout for the full execution of operation.
MongoOperationTimeoutException(String) - Constructor for exception com.mongodb.MongoOperationTimeoutException
Construct a new instance.
MongoOperationTimeoutException(String, Throwable) - Constructor for exception com.mongodb.MongoOperationTimeoutException
Construct a new instance
MongoQueryException - Exception in com.mongodb
An exception indicating that a query operation failed on the server.
MongoQueryException(BsonDocument, ServerAddress) - Constructor for exception com.mongodb.MongoQueryException
Construct an instance.
MongoSecurityException - Exception in com.mongodb
This exception is thrown when there is an error reported by the underlying client authentication mechanism.
MongoSecurityException(MongoCredential, String) - Constructor for exception com.mongodb.MongoSecurityException
Construct an instance
MongoSecurityException(MongoCredential, String, Throwable) - Constructor for exception com.mongodb.MongoSecurityException
Construct an instance
MongoServerException - Exception in com.mongodb
An exception indicating that some error has been raised by a MongoDB server in response to an operation.
MongoServerException(int, String, ServerAddress) - Constructor for exception com.mongodb.MongoServerException
Construct a new instance.
MongoServerException(int, String, String, ServerAddress) - Constructor for exception com.mongodb.MongoServerException
Construct a new instance.
MongoServerException(String, ServerAddress) - Constructor for exception com.mongodb.MongoServerException
Construct a new instance.
MongoServerUnavailableException - Exception in com.mongodb
An exception indicating that the server on which an operation is selected to run is no longer available to execute operations.
MongoServerUnavailableException(String) - Constructor for exception com.mongodb.MongoServerUnavailableException
Construct a new instance.
MongoSocketClosedException - Exception in com.mongodb
This exception is thrown when trying to read or write from a closed socket.
MongoSocketClosedException(String, ServerAddress) - Constructor for exception com.mongodb.MongoSocketClosedException
Construct an instance.
MongoSocketException - Exception in com.mongodb
Subclass of MongoException representing a network-related exception
MongoSocketException(String, ServerAddress) - Constructor for exception com.mongodb.MongoSocketException
Construct a new instance.
MongoSocketException(String, ServerAddress, Throwable) - Constructor for exception com.mongodb.MongoSocketException
 
MongoSocketOpenException - Exception in com.mongodb
This exception is thrown when there is an exception opening a Socket.
MongoSocketOpenException(String, ServerAddress) - Constructor for exception com.mongodb.MongoSocketOpenException
Construct an instance.
MongoSocketOpenException(String, ServerAddress, Throwable) - Constructor for exception com.mongodb.MongoSocketOpenException
Construct an instance.
MongoSocketReadException - Exception in com.mongodb
This exception is thrown when there is an exception reading a response from a Socket.
MongoSocketReadException(String, ServerAddress) - Constructor for exception com.mongodb.MongoSocketReadException
Construct a new instance.
MongoSocketReadException(String, ServerAddress, Throwable) - Constructor for exception com.mongodb.MongoSocketReadException
Construct a new instance.
MongoSocketReadTimeoutException - Exception in com.mongodb
This exception is thrown when there is a timeout reading a response from the socket.
MongoSocketReadTimeoutException(String, ServerAddress, Throwable) - Constructor for exception com.mongodb.MongoSocketReadTimeoutException
Construct a new instance
MongoSocketWriteException - Exception in com.mongodb
This exception is thrown when there is an exception writing a response to a Socket.
MongoSocketWriteException(String, ServerAddress, Throwable) - Constructor for exception com.mongodb.MongoSocketWriteException
Construct a new instance.
MongoSocketWriteTimeoutException - Exception in com.mongodb
This exception is thrown when there is a timeout writing a response from the socket.
MongoSocketWriteTimeoutException(String, ServerAddress, Throwable) - Constructor for exception com.mongodb.MongoSocketWriteTimeoutException
Construct a new instance
MongoTimeoutException - Exception in com.mongodb
An exception indicating that the driver has timed out waiting for either a server or a connection to become available.
MongoTimeoutException(String) - Constructor for exception com.mongodb.MongoTimeoutException
Construct a new instance.
MongoTimeoutException(String, Throwable) - Constructor for exception com.mongodb.MongoTimeoutException
Construct a new instance
MongoTimeUnit - Enum Class in com.mongodb.client.model
Units for specifying time-based values.
MongoUpdatedEncryptedFieldsException - Exception in com.mongodb
An exception thrown by methods that may automatically create data encryption keys where needed based on the encryptedFields configuration.
MongoUpdatedEncryptedFieldsException(BsonDocument, String, Throwable) - Constructor for exception com.mongodb.MongoUpdatedEncryptedFieldsException
Not part of the public API.
MongoWriteConcernException - Exception in com.mongodb
An exception indicating a failure to apply the write concern to the requested write operation
MongoWriteConcernException(WriteConcernError, ServerAddress) - Constructor for exception com.mongodb.MongoWriteConcernException
MongoWriteConcernException(WriteConcernError, WriteConcernResult, ServerAddress) - Constructor for exception com.mongodb.MongoWriteConcernException
MongoWriteConcernException(WriteConcernError, WriteConcernResult, ServerAddress, Collection<String>) - Constructor for exception com.mongodb.MongoWriteConcernException
Construct an instance.
MongoWriteException - Exception in com.mongodb
An exception indicating the failure of a write operation.
MongoWriteException(WriteError, ServerAddress) - Constructor for exception com.mongodb.MongoWriteException
MongoWriteException(WriteError, ServerAddress, Collection<String>) - Constructor for exception com.mongodb.MongoWriteException
Construct an instance
month(MqlString) - Method in interface com.mongodb.client.model.mql.MqlDate
The month of this date as determined by the provided timezone, as an integer between 1 and 12.
MONTH - Enum constant in enum class com.mongodb.client.model.MongoTimeUnit
MqlArray<T extends MqlValue> - Interface in com.mongodb.client.model.mql
An array value in the context of the MongoDB Query Language (MQL).
MqlBoolean - Interface in com.mongodb.client.model.mql
A boolean value in the context of the MongoDB Query Language (MQL).
MqlDate - Interface in com.mongodb.client.model.mql
A UTC date-time value in the context of the MongoDB Query Language (MQL).
MqlDocument - Interface in com.mongodb.client.model.mql
A document value in the context of the MongoDB Query Language (MQL).
MqlEntry<T extends MqlValue> - Interface in com.mongodb.client.model.mql
A map entry value in the context of the MongoDB Query Language (MQL).
MqlInteger - Interface in com.mongodb.client.model.mql
An integer value in the context of the MongoDB Query Language (MQL).
MqlMap<T extends MqlValue> - Interface in com.mongodb.client.model.mql
A map value in the context of the MongoDB Query Language (MQL).
MqlNumber - Interface in com.mongodb.client.model.mql
A number value in the context of the MongoDB Query Language (MQL).
MqlString - Interface in com.mongodb.client.model.mql
A string value in the context of the MongoDB Query Language (MQL).
MqlUnchecked - Annotation Interface in com.mongodb.client.model.mql
Documents places where the API relies on a user asserting something that is not checked at run-time.
MqlUnchecked.Unchecked - Enum Class in com.mongodb.client.model.mql
 
MqlValue - Interface in com.mongodb.client.model.mql
A value in the context of the MongoDB Query Language (MQL).
MqlValues - Class in com.mongodb.client.model.mql
Convenience methods related to MqlValue, used primarily to produce values in the context of the MongoDB Query Language (MQL).
mul(String, Number) - Static method in class com.mongodb.client.model.Updates
Creates an update that multiplies the value of the field with the given name by the given number.
multi(String) - Method in interface com.mongodb.client.model.search.FieldSearchPath
Creates a new FieldSearchPath with the name of the alternate analyzer specified.
MULTI_LINE_STRING - Enum constant in enum class com.mongodb.client.model.geojson.GeoJsonObjectType
A MultiLineString
MULTI_POINT - Enum constant in enum class com.mongodb.client.model.geojson.GeoJsonObjectType
A MultiPoint
MULTI_POLYGON - Enum constant in enum class com.mongodb.client.model.geojson.GeoJsonObjectType
A MultiPolygon
MultiLineString - Class in com.mongodb.client.model.geojson
A representation of a GeoJSON MultiLineString.
MultiLineString(CoordinateReferenceSystem, List<List<Position>>) - Constructor for class com.mongodb.client.model.geojson.MultiLineString
Construct an instance with the given coordinates and coordinate reference system.
MultiLineString(List<List<Position>>) - Constructor for class com.mongodb.client.model.geojson.MultiLineString
Construct an instance with the given coordinates.
MultiLineStringCodec - Class in com.mongodb.client.model.geojson.codecs
A Codec for a GeoJSON MultiLineString.
MultiLineStringCodec(CodecRegistry) - Constructor for class com.mongodb.client.model.geojson.codecs.MultiLineStringCodec
Constructs an instance.
MULTIPLE - Enum constant in enum class com.mongodb.connection.ClusterConnectionMode
Connect to multiple servers in a cluster (either a replica set or multiple mongos servers)
multiply(int) - Method in interface com.mongodb.client.model.mql.MqlInteger
The product of multiplying this and the other value.
multiply(MqlInteger) - Method in interface com.mongodb.client.model.mql.MqlInteger
The product of multiplying this and the other value.
multiply(MqlNumber) - Method in interface com.mongodb.client.model.mql.MqlNumber
The product of multiplying this and the other value.
multiply(Number) - Method in interface com.mongodb.client.model.mql.MqlNumber
The product of multiplying this and the other value.
multiply(Function<? super T, ? extends MqlNumber>) - Method in interface com.mongodb.client.model.mql.MqlArray
The product of multiplying together all the values of this array, via the provided mapper.
multiplyExpression(Iterable<? extends SearchScoreExpression>) - Static method in interface com.mongodb.client.model.search.SearchScoreExpression
Returns a SearchScoreExpression that evaluates into the product of the values of the specified expressions.
MultiplySearchScoreExpression - Interface in com.mongodb.client.model.search
 
MultiPoint - Class in com.mongodb.client.model.geojson
A representation of a GeoJSON MultiPoint.
MultiPoint(CoordinateReferenceSystem, List<Position>) - Constructor for class com.mongodb.client.model.geojson.MultiPoint
Construct an instance with the given coordinates and coordinate reference system.
MultiPoint(List<Position>) - Constructor for class com.mongodb.client.model.geojson.MultiPoint
Construct an instance with the given coordinates.
MultiPointCodec - Class in com.mongodb.client.model.geojson.codecs
A Codec for a GeoJSON MultiPoint.
MultiPointCodec(CodecRegistry) - Constructor for class com.mongodb.client.model.geojson.codecs.MultiPointCodec
Constructs an instance.
MultiPolygon - Class in com.mongodb.client.model.geojson
A representation of a GeoJSON MultiPolygon.
MultiPolygon(CoordinateReferenceSystem, List<PolygonCoordinates>) - Constructor for class com.mongodb.client.model.geojson.MultiPolygon
Construct an instance.
MultiPolygon(List<PolygonCoordinates>) - Constructor for class com.mongodb.client.model.geojson.MultiPolygon
Construct an instance.
MultiPolygonCodec - Class in com.mongodb.client.model.geojson.codecs
A Codec for a GeoJSON MultiPolygon.
MultiPolygonCodec(CodecRegistry) - Constructor for class com.mongodb.client.model.geojson.codecs.MultiPolygonCodec
Constructs an instance.
must(Iterable<? extends SearchOperator>) - Method in interface com.mongodb.client.model.search.CompoundSearchOperatorBase
Creates a new CompoundSearchOperator by adding to it clauses that must all be satisfied.
MustCompoundSearchOperator - Interface in com.mongodb.client.model.search
A representation of a CompoundSearchOperator that allows changing must-specific options, if any.
mustNot(Iterable<? extends SearchOperator>) - Method in interface com.mongodb.client.model.search.CompoundSearchOperatorBase
Creates a new CompoundSearchOperator by adding to it clauses that must all not be satisfied.
MustNotCompoundSearchOperator - Interface in com.mongodb.client.model.search
A representation of a CompoundSearchOperator that allows changing mustNot-specific options, if any.

N

name(String) - Method in class com.mongodb.client.model.ClusteredIndexOptions
Sets the index name
name(String) - Method in class com.mongodb.client.model.IndexOptions
Sets the name of the index.
NAME - Enum constant in enum class com.mongodb.client.model.geojson.CoordinateReferenceSystemType
A coordinate reference system that is specifed by name
NamedCoordinateReferenceSystem - Class in com.mongodb.client.model.geojson
A GeoJSON named Coordinate Reference System.
NamedCoordinateReferenceSystem(String) - Constructor for class com.mongodb.client.model.geojson.NamedCoordinateReferenceSystem
Construct an instance
NamedCoordinateReferenceSystemCodec - Class in com.mongodb.client.model.geojson.codecs
Codec for a GeoJson Coordinate Reference System of type name.
NamedCoordinateReferenceSystemCodec() - Constructor for class com.mongodb.client.model.geojson.codecs.NamedCoordinateReferenceSystemCodec
 
ne(MqlValue) - Method in interface com.mongodb.client.model.mql.MqlValue
Whether this value is not equal to the other value.
ne(String, TItem) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of the field name does not equal the specified value.
near(Point, Number, FieldSearchPath, FieldSearchPath...) - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a SearchOperator that allows finding results that are near the specified origin.
near(Point, Number, Iterable<? extends FieldSearchPath>) - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a SearchOperator that allows finding results that are near the specified origin.
near(Number, Number, FieldSearchPath, FieldSearchPath...) - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a SearchOperator that allows finding results that are near the specified origin.
near(Number, Number, Iterable<? extends FieldSearchPath>) - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a SearchOperator that allows finding results that are near the specified origin.
near(String, double, double, Double, Double) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with geospatial data that is near the specified point.
near(String, Point, Double, Double) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with geospatial data that is near the specified GeoJSON point.
near(String, Bson, Double, Double) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with geospatial data that is near the specified GeoJSON point.
near(Instant, Duration, FieldSearchPath, FieldSearchPath...) - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a SearchOperator that allows finding results that are near the specified origin.
near(Instant, Duration, Iterable<? extends FieldSearchPath>) - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a SearchOperator that allows finding results that are near the specified origin.
nearest() - Static method in class com.mongodb.ReadPreference
Gets a read preference that forces reads to a primary or a secondary.
nearest(long, TimeUnit) - Static method in class com.mongodb.ReadPreference
Gets a read preference that forces reads to a primary or a secondary that is less stale than the given maximum.
nearest(TagSet) - Static method in class com.mongodb.ReadPreference
Gets a read preference that forces reads to the primary or a secondary with the given set of tags.
nearest(TagSet, long, TimeUnit) - Static method in class com.mongodb.ReadPreference
Gets a read preference that forces reads to the primary or a secondary with the given set of tags that is less stale than the given maximum.
nearest(List<TagSet>) - Static method in class com.mongodb.ReadPreference
Gets a read preference that forces reads to the primary or a secondary with one of the given sets of tags.
nearest(List<TagSet>, long, TimeUnit) - Static method in class com.mongodb.ReadPreference
Gets a read preference that forces reads to the primary or a secondary with one of the given sets of tags that is less stale than the given maximum.
nearSphere(String, double, double, Double, Double) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with geospatial data that is near the specified point using spherical geometry.
nearSphere(String, Point, Double, Double) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with geospatial data that is near the specified GeoJSON point using spherical geometry.
nearSphere(String, Bson, Double, Double) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents containing a field with geospatial data that is near the specified GeoJSON point using spherical geometry.
nettyBuilder() - Static method in class com.mongodb.connection.TransportSettings
A builder for NettyTransportSettings.
NettyTransportSettings - Class in com.mongodb.connection
TransportSettings for a Netty-based transport implementation.
NettyTransportSettings.Builder - Class in com.mongodb.connection
A builder for an instance of NettyTransportSettings.
nin(String, Iterable<TItem>) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of a field does not equal any of the specified values or does not exist.
nin(String, TItem...) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of a field does not equal any of the specified values or does not exist.
NON_IGNORABLE - Enum constant in enum class com.mongodb.client.model.CollationAlternate
Non-ignorable
NonNull - Annotation Interface in com.mongodb.lang
A common annotation to declare that annotated elements cannot be null.
NonNullApi - Annotation Interface in com.mongodb.lang
A common annotation to declare that parameters and return values are to be considered as non-nullable by default for a given package.
NonTailable - Enum constant in enum class com.mongodb.CursorType
A non-tailable cursor.
nor(Iterable<Bson>) - Static method in class com.mongodb.client.model.Filters
Creates a filter that performs a logical NOR operation on all the specified filters.
nor(Bson...) - Static method in class com.mongodb.client.model.Filters
Creates a filter that performs a logical NOR operation on all the specified filters.
normalization(Boolean) - Method in class com.mongodb.client.model.Collation.Builder
Sets the normalization value
not() - Method in interface com.mongodb.client.model.mql.MqlBoolean
The logical negation of this value.
not(Bson) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents that do not match the passed in filter.
NotThreadSafe - Annotation Interface in com.mongodb.annotations
The class to which this annotation is applied is not thread-safe.
Nullable - Annotation Interface in com.mongodb.lang
A common annotation to declare that annotated elements can be null under some circumstance.
NumberDensifyRange - Interface in com.mongodb.client.model.densify
 
numberFacet(String, FieldSearchPath, Iterable<? extends Number>) - Static method in interface com.mongodb.client.model.search.SearchFacet
Returns a SearchFacet that allows determining the frequency of BSON 32-bit integer / 64-bit integer / Double values in the search results by breaking the results into separate ranges.
NumberNearSearchOperator - Interface in com.mongodb.client.model.search
 
numberRange(FieldSearchPath, FieldSearchPath...) - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a base for a SearchOperator that tests if the BSON 32-bit integer / 64-bit integer / Double values of the specified fields are within an interval.
numberRange(Iterable<? extends FieldSearchPath>) - Static method in interface com.mongodb.client.model.search.SearchOperator
Returns a base for a SearchOperator that tests if the BSON 32-bit integer / 64-bit integer / Double values of the specified fields are within an interval.
NumberRangeSearchOperator - Interface in com.mongodb.client.model.search
 
NumberRangeSearchOperatorBase - Interface in com.mongodb.client.model.search
A base for a NumberRangeSearchOperator which allows creating instances of this operator.
NumberSearchFacet - Interface in com.mongodb.client.model.search
 
numBuckets(int) - Method in interface com.mongodb.client.model.search.StringSearchFacet
Creates a new StringSearchFacet that explicitly limits the number of facet categories.
numericOrdering(Boolean) - Method in class com.mongodb.client.model.Collation.Builder
Sets the numeric ordering

O

of(boolean) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns a boolean value corresponding to the provided boolean primitive.
of(double) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns a number value corresponding to the provided double primitive.
of(int) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns an integer value corresponding to the provided int primitive.
of(long) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns an integer value corresponding to the provided long primitive.
of(BsonField) - Static method in class com.mongodb.client.model.WindowOutputFields
Creates a windowed output field from a document field in situations when there is no builder method that better satisfies your needs.
of(String) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns an string value corresponding to the provided String.
of(Instant) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns a date and time value corresponding to the provided Instant.
of(BsonValue) - Static method in interface com.mongodb.client.model.QuantileMethod
Creates a QuantileMethod from a BsonValue in situations when there is no builder method that better satisfies your needs.
of(BsonValue) - Static method in interface com.mongodb.client.model.SearchIndexType
Creates a SearchIndexType from a BsonValue in situations when there is no builder method that better satisfies your needs.
of(Bson) - Static method in interface com.mongodb.client.model.densify.DensifyRange
Creates a DensifyRange from a Bson in situations when there is no builder method that better satisfies your needs.
of(Bson) - Static method in interface com.mongodb.client.model.fill.FillOutputField
Creates a FillOutputField from a Bson in situations when there is no builder method that better satisfies your needs.
of(Bson) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns a document value corresponding to the provided Bson document.
of(Bson) - Static method in interface com.mongodb.client.model.search.SearchCollector
Creates a SearchCollector from a Bson in situations when there is no builder method that better satisfies your needs.
of(Bson) - Static method in interface com.mongodb.client.model.search.SearchCount
Creates a SearchCount from a Bson in situations when there is no builder method that better satisfies your needs.
of(Bson) - Static method in interface com.mongodb.client.model.search.SearchFacet
Creates a SearchFacet from a Bson in situations when there is no builder method that better satisfies your needs.
of(Bson) - Static method in interface com.mongodb.client.model.search.SearchHighlight
Creates a SearchHighlight from a Bson in situations when there is no builder method that better satisfies your needs.
of(Bson) - Static method in interface com.mongodb.client.model.search.SearchOperator
Creates a SearchOperator from a Bson in situations when there is no builder method that better satisfies your needs.
of(Bson) - Static method in interface com.mongodb.client.model.search.SearchScore
Creates a SearchScore from a Bson in situations when there is no builder method that better satisfies your needs.
of(Bson) - Static method in interface com.mongodb.client.model.search.SearchScoreExpression
Creates a SearchScoreExpression from a Bson in situations when there is no builder method that better satisfies your needs.
of(Bson) - Static method in class com.mongodb.client.model.Windows
Creates a window from Bson in situations when there is no builder method that better satisfies your needs.
of(Decimal128) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns a number value corresponding to the provided Decimal128.
ofArray(T...) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns an array value, containing the values provided.
ofBooleanArray(boolean...) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns an array of booleans corresponding to the provided boolean primitives.
ofDateArray(Instant...) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns an array of dates corresponding to the provided Instants.
ofEntry(MqlString, T) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns an entry value.
OFF - Enum constant in enum class com.mongodb.client.model.changestream.FullDocumentBeforeChange
Configures the change stream to not include the pre-image of the modified document.
OFF - Enum constant in enum class com.mongodb.client.model.CollationCaseFirst
Off
OFF - Enum constant in enum class com.mongodb.client.model.ValidationLevel
No validation for inserts or updates.
offset(double) - Method in interface com.mongodb.client.model.search.GaussSearchScoreExpression
Creates a new GaussSearchScoreExpression which does not decay, i.e., its output stays 1, if the value of the path expression is within the interval [origin - offset; origin + offset].
ofIntegerArray(int...) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns an array of integers corresponding to the provided int primitives.
ofIntegerArray(long...) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns an array of integers corresponding to the provided long primitives.
ofMap() - Static method in class com.mongodb.client.model.mql.MqlValues
Returns an empty map value.
ofMap(Bson) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns a map value corresponding to the provided Bson document.
ofNull() - Static method in class com.mongodb.client.model.mql.MqlValues
The null value in the context of the MongoDB Query Language (MQL).
ofNumberArray(double...) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns an array of numbers corresponding to the provided double primitives.
ofNumberArray(Decimal128...) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns an array of numbers corresponding to the provided Decimal128s.
ofStringArray(String...) - Static method in class com.mongodb.client.model.mql.MqlValues
Returns an array of strings corresponding to the provided Strings.
OIDC_CALLBACK_KEY - Static variable in class com.mongodb.MongoCredential
Mechanism property key for the OIDC callback.
OIDC_HUMAN_CALLBACK_KEY - Static variable in class com.mongodb.MongoCredential
Mechanism property key for the OIDC human callback.
OidcCallbackResult(String) - Constructor for class com.mongodb.MongoCredential.OidcCallbackResult
An access token that does not expire.
OidcCallbackResult(String, Duration) - Constructor for class com.mongodb.MongoCredential.OidcCallbackResult
 
OidcCallbackResult(String, Duration, String) - Constructor for class com.mongodb.MongoCredential.OidcCallbackResult
 
ok(boolean) - Method in class com.mongodb.connection.ServerDescription.Builder
The isOK() result from requesting this information from MongoDB
onRequest(MongoCredential.OidcCallbackContext) - Method in interface com.mongodb.MongoCredential.OidcCallback
 
OperationType - Enum Class in com.mongodb.client.model.changestream
The $changeStream operation type.
option(String, Object) - Method in interface com.mongodb.client.model.densify.DensifyOptions
Creates a new DensifyOptions with the specified option in situations when there is no builder method that better satisfies your needs.
option(String, Object) - Method in interface com.mongodb.client.model.fill.FillOptions
Creates a new FillOptions with the specified option in situations when there is no builder method that better satisfies your needs.
option(String, Object) - Method in interface com.mongodb.client.model.search.FuzzySearchOptions
Creates a new FuzzySearchOptions with the specified option in situations when there is no builder method that better satisfies your needs.
option(String, Object) - Method in interface com.mongodb.client.model.search.SearchOptions
Creates a new SearchOptions with the specified option in situations when there is no builder method that better satisfies your needs.
option(String, Object) - Method in interface com.mongodb.client.model.search.VectorSearchOptions
Creates a new VectorSearchOptions with the specified option in situations when there is no builder method that better satisfies your needs.
or(MqlBoolean) - Method in interface com.mongodb.client.model.mql.MqlBoolean
The logical conjunction of this and the other value.
or(Iterable<Bson>) - Static method in class com.mongodb.client.model.Filters
Creates a filter that preforms a logical OR of the provided list of filters.
or(Bson...) - Static method in class com.mongodb.client.model.Filters
Creates a filter that preforms a logical OR of the provided list of filters.
orderBy(List<? extends Bson>) - Static method in class com.mongodb.client.model.Sorts
Combine multiple sort specifications.
orderBy(Bson...) - Static method in class com.mongodb.client.model.Sorts
Combine multiple sort specifications.
ordered(boolean) - Method in class com.mongodb.client.model.BulkWriteOptions
If true, then when a write fails, return without performing the remaining writes.
ordered(boolean) - Method in class com.mongodb.client.model.InsertManyOptions
Sets whether the server should insert the documents in the order provided.
OTHER - Enum constant in enum class com.mongodb.client.model.changestream.OperationType
The other operation type.
out(String) - Static method in class com.mongodb.client.model.Aggregates
Creates a $out pipeline stage that writes into the specified collection
out(String, String) - Static method in class com.mongodb.client.model.Aggregates
Creates a $out pipeline stage that supports outputting to a different database.
out(Bson) - Static method in class com.mongodb.client.model.Aggregates
Creates a $out pipeline stage that writes out to the specified destination
output(BsonField...) - Method in class com.mongodb.client.model.BucketAutoOptions
The definition of the output document in each bucket
output(BsonField...) - Method in class com.mongodb.client.model.BucketOptions
The definition of the output document in each bucket
output(List<BsonField>) - Method in class com.mongodb.client.model.BucketAutoOptions
The definition of the output document in each bucket
output(List<BsonField>) - Method in class com.mongodb.client.model.BucketOptions
The definition of the output document in each bucket

P

parse(String) - Static method in class com.mongodb.BasicDBObject
Parses a string in MongoDB Extended JSON format to a BasicDBObject.
parse(String, Decoder<BasicDBObject>) - Static method in class com.mongodb.BasicDBObject
Parses a string in MongoDB Extended JSON format to a BasicDBObject.
parseDate() - Method in interface com.mongodb.client.model.mql.MqlString
Converts this string to a date.
parseDate(MqlString) - Method in interface com.mongodb.client.model.mql.MqlString
Converts this string to a date, using the specified format.
parseDate(MqlString, MqlString) - Method in interface com.mongodb.client.model.mql.MqlString
Converts this string to a date, using the specified timezone and format.
parseInteger() - Method in interface com.mongodb.client.model.mql.MqlString
Converts this string to an integer.
partialFilterExpression(Bson) - Method in class com.mongodb.client.model.IndexOptions
Sets the filter expression for the documents to be included in the index
partitionBy(TExpression) - Method in interface com.mongodb.client.model.fill.FillOptions
Creates a new FillOptions with the specified partitioning.
partitionByFields(Iterable<String>) - Method in interface com.mongodb.client.model.densify.DensifyOptions
Creates a new DensifyOptions with the specified fields to partition by.
partitionByFields(Iterable<String>) - Method in interface com.mongodb.client.model.fill.FillOptions
Creates a new FillOptions with the specified partitioning.
partitionByFields(String...) - Method in interface com.mongodb.client.model.densify.DensifyOptions
Creates a new DensifyOptions with the specified fields to partition by.
partitionByFields(String...) - Method in interface com.mongodb.client.model.fill.FillOptions
Creates a new FillOptions with the specified partitioning.
partitionRangeWithStep(long, MongoTimeUnit) - Static method in interface com.mongodb.client.model.densify.DensifyRange
Returns a DensifyRange that represents an interval with the smallest BSON Date value of the field in the partition of documents being its lower bound, and the largest value being the upper bound.
partitionRangeWithStep(Number) - Static method in interface com.mongodb.client.model.densify.DensifyRange
Returns a DensifyRange that represents an interval with the smallest BSON 32-bit integer / 64-bit integer / Double / Decimal128 value of the field in the partition of documents being its lower bound, and the largest value being the upper bound.
passArrayTo(Function<? super MqlArray<T>, ? extends R>) - Method in interface com.mongodb.client.model.mql.MqlArray
The result of passing this value to the provided function.
passBooleanTo(Function<? super MqlBoolean, ? extends R>) - Method in interface com.mongodb.client.model.mql.MqlBoolean
The result of passing this value to the provided function.
passDateTo(Function<? super MqlDate, ? extends R>) - Method in interface com.mongodb.client.model.mql.MqlDate
The result of passing this value to the provided function.
passDocumentTo(Function<? super MqlDocument, ? extends R>) - Method in interface com.mongodb.client.model.mql.MqlDocument
The result of passing this value to the provided function.
passIntegerTo(Function<? super MqlInteger, ? extends R>) - Method in interface com.mongodb.client.model.mql.MqlInteger
The result of passing this value to the provided function.
passives(Set<String>) - Method in class com.mongodb.connection.ServerDescription.Builder
Sets the passive members of the replica set.
passMapTo(Function<? super MqlMap<T>, ? extends R>) - Method in interface com.mongodb.client.model.mql.MqlMap
The result of passing this value to the provided function.
passNumberTo(Function<? super MqlNumber, ? extends R>) - Method in interface com.mongodb.client.model.mql.MqlNumber
The result of passing this value to the provided function.
passStringTo(Function<? super MqlString, ? extends R>) - Method in interface com.mongodb.client.model.mql.MqlString
The result of passing this value to the provided function.
passTo(Function<? super MqlValue, ? extends R>) - Method in interface com.mongodb.client.model.mql.MqlValue
The result of passing this value to the provided function.
password(String) - Method in class com.mongodb.connection.ProxySettings.Builder
Sets the password for authenticating with the SOCKS5 proxy server.
PathBoostSearchScore - Interface in com.mongodb.client.model.search
 
pathExpression(FieldSearchPath) - Static method in interface com.mongodb.client.model.search.SearchScoreExpression
Returns a SearchScoreExpression that evaluates into the value of the specified field.
paths(SearchPath, SearchPath...) - Static method in interface com.mongodb.client.model.search.SearchHighlight
Returns a SearchHighlight for the given paths.
paths(Iterable<? extends SearchPath>) - Static method in interface com.mongodb.client.model.search.SearchHighlight
Returns a SearchHighlight for the given paths.
PathSearchScoreExpression - Interface in com.mongodb.client.model.search
 
percentile(String, InExpression, PExpression, QuantileMethod) - Static method in class com.mongodb.client.model.Accumulators
Returns a combination of a computed field and an accumulator that generates a BSON Array containing computed values from the given inExpression based on the provided pExpression, which represents an array of percentiles of interest within a group, where each element is a numeric value between 0.0 and 1.0 (inclusive).
percentile(String, InExpression, PExpression, QuantileMethod, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of percentiles of the evaluation results of the inExpression over documents in the specified window.
PIPELINE - Enum constant in enum class com.mongodb.client.model.MergeOptions.WhenMatched
An aggregation pipeline to update the document in the collection.
PLAIN - Enum constant in enum class com.mongodb.AuthenticationMechanism
The PLAIN mechanism.
PLAIN_MECHANISM - Static variable in class com.mongodb.MongoCredential
The PLAIN mechanism.
Point - Class in com.mongodb.client.model.geojson
A representation of a GeoJSON Point.
Point(CoordinateReferenceSystem, Position) - Constructor for class com.mongodb.client.model.geojson.Point
Construct an instance with the given coordinate and coordinate reference system.
Point(Position) - Constructor for class com.mongodb.client.model.geojson.Point
Construct an instance with the given coordinate.
POINT - Enum constant in enum class com.mongodb.client.model.geojson.GeoJsonObjectType
A Point
PointCodec - Class in com.mongodb.client.model.geojson.codecs
A Codec for a GeoJSON point.
PointCodec(CodecRegistry) - Constructor for class com.mongodb.client.model.geojson.codecs.PointCodec
Constructs an instance.
POLL - Enum constant in enum class com.mongodb.connection.ServerMonitoringMode
Use the polling protocol.
Polygon - Class in com.mongodb.client.model.geojson
A representation of a GeoJSON Polygon.
Polygon(CoordinateReferenceSystem, PolygonCoordinates) - Constructor for class com.mongodb.client.model.geojson.Polygon
Construct an instance with the given coordinates and coordinate reference system.
Polygon(PolygonCoordinates) - Constructor for class com.mongodb.client.model.geojson.Polygon
Construct an instance with the given coordinates.
Polygon(List<Position>, List<Position>...) - Constructor for class com.mongodb.client.model.geojson.Polygon
Construct an instance with the given coordinates.
Polygon(List<Position>, List<List<Position>>) - Constructor for class com.mongodb.client.model.geojson.Polygon
Construct an instance with the given coordinates.
POLYGON - Enum constant in enum class com.mongodb.client.model.geojson.GeoJsonObjectType
A Polygon
PolygonCodec - Class in com.mongodb.client.model.geojson.codecs
A Codec for a GeoJSON polygon.
PolygonCodec(CodecRegistry) - Constructor for class com.mongodb.client.model.geojson.codecs.PolygonCodec
Constructs an instance.
PolygonCoordinates - Class in com.mongodb.client.model.geojson
Coordinates for a GeoJSON Polygon.
PolygonCoordinates(List<Position>, List<Position>...) - Constructor for class com.mongodb.client.model.geojson.PolygonCoordinates
Construct an instance.
PolygonCoordinates(List<Position>, List<List<Position>>) - Constructor for class com.mongodb.client.model.geojson.PolygonCoordinates
Construct an instance.
POOL_CLOSED - Enum constant in enum class com.mongodb.event.ConnectionCheckOutFailedEvent.Reason
The pool was previously closed and cannot provide new connections
POOL_CLOSED - Enum constant in enum class com.mongodb.event.ConnectionClosedEvent.Reason
The pool was closed, making the connection no longer valid
pop() - Method in class com.mongodb.BasicDBObjectBuilder
Pops the active object, which means that the parent object becomes active
popFirst(String) - Static method in class com.mongodb.client.model.Updates
Creates an update that pops the first element of an array that is the value of the field with the given name.
popLast(String) - Static method in class com.mongodb.client.model.Updates
Creates an update that pops the last element of an array that is the value of the field with the given name.
port(int) - Method in class com.mongodb.connection.ProxySettings.Builder
Sets the port number for the SOCKS5 proxy server.
position(Integer) - Method in class com.mongodb.client.model.PushOptions
Sets the position at which to add the pushed values in the array.
Position - Class in com.mongodb.client.model.geojson
A representation of a GeoJSON Position.
Position(double, double, double...) - Constructor for class com.mongodb.client.model.geojson.Position
Construct an instance.
Position(List<Double>) - Constructor for class com.mongodb.client.model.geojson.Position
Construct an instance.
POWERSOF2 - Enum constant in enum class com.mongodb.client.model.BucketGranularity
POWERSOF2
precision(Integer) - Method in class com.mongodb.client.model.vault.RangeOptions
Set the precision of double or decimal128 values in the encryptedFields of the destination collection.
prefixLength(int) - Method in interface com.mongodb.client.model.search.FuzzySearchOptions
Creates a new FuzzySearchOptions with the number of characters at the beginning of a search term that must exactly match.
PRESENT - Enum constant in enum class com.mongodb.client.model.mql.MqlUnchecked.Unchecked
The presence of the specified value is not checked by the API.
preserveNullAndEmptyArrays(Boolean) - Method in class com.mongodb.client.model.UnwindOptions
Sets true if the unwind stage should include documents that have null values or empty arrays
primary() - Static method in class com.mongodb.ReadPreference
Gets a read preference that forces read to the primary.
primary(String) - Method in class com.mongodb.connection.ServerDescription.Builder
Sets the address of the current primary in the replica set
PRIMARY - Enum constant in enum class com.mongodb.client.model.CollationStrength
Strongest level, denote difference between base characters
primaryPreferred() - Static method in class com.mongodb.ReadPreference
Gets a read preference that forces reads to the primary if available, otherwise to a secondary.
primaryPreferred(long, TimeUnit) - Static method in class com.mongodb.ReadPreference
Gets a read preference that forces reads to the primary if available, otherwise to a secondary.
primaryPreferred(TagSet) - Static method in class com.mongodb.ReadPreference
Gets a read preference that forces reads to the primary if available, otherwise to a secondary with the given set of tags.
primaryPreferred(TagSet, long, TimeUnit) - Static method in class com.mongodb.ReadPreference
Gets a read preference that forces reads to the primary if available, otherwise to a secondary with the given set of tags that is less stale than the given maximum.
primaryPreferred(List<TagSet>) - Static method in class com.mongodb.ReadPreference
Gets a read preference that forces reads to the primary if available, otherwise to a secondary with one of the given sets of tags.
primaryPreferred(List<TagSet>, long, TimeUnit) - Static method in class com.mongodb.ReadPreference
Gets a read preference that forces reads to the primary if available, otherwise to a secondary with one of the given sets of tags that is less stale than the given maximum.
project(Bson) - Static method in class com.mongodb.client.model.Aggregates
Creates a $project pipeline stage for the specified projection
projection(Bson) - Method in class com.mongodb.client.model.FindOneAndDeleteOptions
Sets a document describing the fields to return for all matching documents.
projection(Bson) - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Sets a document describing the fields to return for all matching documents.
projection(Bson) - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Sets a document describing the fields to return for all matching documents.
Projections - Class in com.mongodb.client.model
A factory for projections.
provider(String) - Method in class com.mongodb.client.model.vault.RewrapManyDataKeyOptions
Sets the provider name
ProxySettings - Class in com.mongodb.connection
This setting is only applicable when communicating with a MongoDB server using the synchronous variant of MongoClient.
ProxySettings.Builder - Class in com.mongodb.connection
A builder for an instance of ProxySettings.
pull(String, TItem) - Static method in class com.mongodb.client.model.Updates
Creates an update that removes all instances of the given value from the array value of the field with the given name.
pullAll(String, List<TItem>) - Static method in class com.mongodb.client.model.Updates
Creates an update that removes all instances of the given values from the array value of the field with the given name.
pullByFilter(Bson) - Static method in class com.mongodb.client.model.Updates
Creates an update that removes from an array all elements that match the given filter.
PUNCT - Enum constant in enum class com.mongodb.client.model.CollationMaxVariable
Punct
push(String) - Method in class com.mongodb.BasicDBObjectBuilder
Creates a new empty object and inserts it into the current object with the given key.
push(String, TExpression) - Static method in class com.mongodb.client.model.Accumulators
Gets a field name for a $group operation representing an array of all values that results from applying an expression to each document in a group of documents that share the same group by key.
push(String, TExpression, Window) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field that adds the evaluation results of the expression over the window to a BSON Array.
push(String, TItem) - Static method in class com.mongodb.client.model.Updates
Creates an update that adds the given value to the array value of the field with the given name.
pushEach(String, List<TItem>) - Static method in class com.mongodb.client.model.Updates
Creates an update that adds each of the given values to the array value of the field with the given name.
pushEach(String, List<TItem>, PushOptions) - Static method in class com.mongodb.client.model.Updates
Creates an update that adds each of the given values to the array value of the field with the given name, applying the given options for positioning the pushed values, and then slicing and/or sorting the array.
PushOptions - Class in com.mongodb.client.model
The options to apply to a $push update operator.
PushOptions() - Constructor for class com.mongodb.client.model.PushOptions
 
put(Object, Object) - Method in interface com.mongodb.RequestContext
Modifies this instance with the given key and value.
putNonNull(Object, Object) - Method in interface com.mongodb.RequestContext
Modifies this instance with the given key and value only if the value is not null.

Q

QuantileMethod - Interface in com.mongodb.client.model
This interface represents a quantile method used in quantile accumulators of the $group and $setWindowFields stages.
QUARTER - Enum constant in enum class com.mongodb.client.model.MongoTimeUnit
QUATERNARY - Enum constant in enum class com.mongodb.client.model.CollationStrength
When punctuation is ignored at level 1-3, an additional level can be used to distinguish words with and without punctuation.
query(Document) - Method in interface com.mongodb.client.model.GeoNearOptions
Limits the results to the documents that match the query.
QUERY_PLANNER - Enum constant in enum class com.mongodb.ExplainVerbosity
Runs the query planner and chooses the winning plan, but does not actually execute it.
queryType(String) - Method in class com.mongodb.client.model.vault.EncryptOptions
The QueryType.

R

R10 - Enum constant in enum class com.mongodb.client.model.BucketGranularity
R10
R20 - Enum constant in enum class com.mongodb.client.model.BucketGranularity
R20
R40 - Enum constant in enum class com.mongodb.client.model.BucketGranularity
R40
R5 - Enum constant in enum class com.mongodb.client.model.BucketGranularity
R5
R80 - Enum constant in enum class com.mongodb.client.model.BucketGranularity
R80
range(double, double) - Static method in class com.mongodb.client.model.Windows
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
range(double, Windows.Bound) - Static method in class com.mongodb.client.model.Windows
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
range(long, long) - Static method in class com.mongodb.client.model.Windows
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
range(long, Windows.Bound) - Static method in class com.mongodb.client.model.Windows
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
range(Windows.Bound, double) - Static method in class com.mongodb.client.model.Windows
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
range(Windows.Bound, long) - Static method in class com.mongodb.client.model.Windows
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
range(Windows.Bound, Decimal128) - Static method in class com.mongodb.client.model.Windows
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
range(Decimal128, Windows.Bound) - Static method in class com.mongodb.client.model.Windows
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
range(Decimal128, Decimal128) - Static method in class com.mongodb.client.model.Windows
Creates a dynamically-sized range window whose bounds are determined by a range of possible values around the value of the sortBy field in the current document.
rangeOptions(RangeOptions) - Method in class com.mongodb.client.model.vault.EncryptOptions
The RangeOptions
RangeOptions - Class in com.mongodb.client.model.vault
Range options specifies index options for a Queryable Encryption field supporting "range" queries.
RangeOptions() - Constructor for class com.mongodb.client.model.vault.RangeOptions
Construct a new instance
rangeWithStep(Number, Number, Number) - Static method in interface com.mongodb.client.model.densify.DensifyRange
Returns a DensifyRange that represents a single interval [l, u).
rangeWithStep(Instant, Instant, long, MongoTimeUnit) - Static method in interface com.mongodb.client.model.densify.DensifyRange
Returns a DensifyRange that represents a single interval [l, u).
rank(String) - Static method in class com.mongodb.client.model.WindowOutputFields
Builds a window output field of the rank of each document in its partition.
readConcern(ReadConcern) - Method in class com.mongodb.MongoClientSettings.Builder
Sets the read concern.
readConcern(ReadConcern) - Method in class com.mongodb.TransactionOptions.Builder
Sets the read concern.
ReadConcern - Class in com.mongodb
A read concern allows clients to choose a level of isolation for their reads.
ReadConcern(ReadConcernLevel) - Constructor for class com.mongodb.ReadConcern
Construct a new read concern
ReadConcernLevel - Enum Class in com.mongodb
A read concern level allows clients to choose a level of isolation for their reads.
readPreference(ReadPreference) - Method in class com.mongodb.MongoClientSettings.Builder
Sets the read preference.
readPreference(ReadPreference) - Method in class com.mongodb.TransactionOptions.Builder
Sets the read preference.
ReadPreference - Class in com.mongodb
A class that represents preferred replica set members to which a query or command can be sent.
ReadPreferenceHedgeOptions - Class in com.mongodb
Options to apply to hedged reads in the server.
ReadPreferenceHedgeOptions.Builder - Class in com.mongodb
The builder for read preference hedge options
readTimeout(long, TimeUnit) - Method in class com.mongodb.connection.SocketSettings.Builder
Sets the socket read timeout.
Reason - Enum Class in com.mongodb.annotations
Enumerates the reasons an API element might be marked with annotations like Alpha or Beta.
receiveBufferSize(int) - Method in class com.mongodb.connection.SocketSettings.Builder
Sets the receive buffer size.
REDUCE - Enum constant in enum class com.mongodb.client.model.MapReduceAction
Deprecated.
Merge the new result with the existing result if the output collection already exists.
regex(String, String) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of the field matches the given regular expression pattern.
regex(String, String, String) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of the field matches the given regular expression pattern with the given options applied.
regex(String, Pattern) - Static method in class com.mongodb.client.model.Filters
Creates a filter that matches all documents where the value of the field matches the given regular expression pattern.
relevanceExpression() - Static method in interface com.mongodb.client.model.search.SearchScoreExpression
Returns a SearchScoreExpression that evaluates into the relevance score of a document.
RelevanceSearchScoreExpression - Interface in com.mongodb.client.model.search
 
removeLabel(String) - Method in exception com.mongodb.MongoException
Removes the given error label from the exception.
rename(String, String) - Static method in class com.mongodb.client.model.Updates
Creates an update that renames a field.
RENAME - Enum constant in enum class com.mongodb.client.model.changestream.OperationType
The rename operation type for renaming collections
RenameCollectionOptions - Class in com.mongodb.client.model
The options to apply when renaming a collection.
RenameCollectionOptions() - Constructor for class com.mongodb.client.model.RenameCollectionOptions
 
REPLACE - Enum constant in enum class com.mongodb.client.model.changestream.OperationType
The replace operation type
REPLACE - Enum constant in enum class com.mongodb.client.model.MapReduceAction
Deprecated.
Replace the contents of the collectionName if the collection with the collectionName exists.
REPLACE - Enum constant in enum class com.mongodb.client.model.MergeOptions.WhenMatched
Replace the existing document in the output collection with the matching results document.
ReplaceOneModel<T> - Class in com.mongodb.client.model
A model describing the replacement of at most one document that matches the query filter.
ReplaceOneModel(Bson, T) - Constructor for class com.mongodb.client.model.ReplaceOneModel
Construct a new instance.
ReplaceOneModel(Bson, T, ReplaceOptions) - Constructor for class com.mongodb.client.model.ReplaceOneModel
Construct a new instance.
ReplaceOptions - Class in com.mongodb.client.model
The options to apply when replacing documents.
ReplaceOptions() - Constructor for class com.mongodb.client.model.ReplaceOptions
 
replaceRoot(TExpression) - Static method in class com.mongodb.client.model.Aggregates
Creates a $replaceRoot pipeline stage
replaceWith(TExpression) - Static method in class com.mongodb.client.model.Aggregates
Creates a $replaceRoot pipeline stage
REPLICA_SET - Enum constant in enum class com.mongodb.connection.ClusterType
A replicas set cluster.
REPLICA_SET_ARBITER - Enum constant in enum class com.mongodb.connection.ServerType
A replica set arbiter.
REPLICA_SET_GHOST - Enum constant in enum class com.mongodb.connection.ServerType
A replica set member that does not report a set name or a hosts list
REPLICA_SET_OTHER - Enum constant in enum class com.mongodb.connection.ServerType
A replica set member that is none of the other types (a passive, for example).
REPLICA_SET_PRIMARY - Enum constant in enum class com.mongodb.connection.ServerType
A replica set primary.
REPLICA_SET_SECONDARY - Enum constant in enum class com.mongodb.connection.ServerType
A replica set secondary.
RequestContext - Interface in com.mongodb
The request context, useful for implementing distributed tracing.
REQUIRED - Enum constant in enum class com.mongodb.client.model.changestream.FullDocument
The same behavior as FullDocument.WHEN_AVAILABLE except that an error is raised if the post-image is not available.
REQUIRED - Enum constant in enum class com.mongodb.client.model.changestream.FullDocumentBeforeChange
The same behavior as FullDocumentBeforeChange.WHEN_AVAILABLE except that an error is raised by the server if the pre-image is not available.
requiredClusterType(ClusterType) - Method in class com.mongodb.connection.ClusterSettings.Builder
Sets the required cluster type for the cluster.
requiredReplicaSetName(String) - Method in class com.mongodb.connection.ClusterSettings.Builder
Sets the required replica set name for the cluster.
restrictSearchWithMatch(Bson) - Method in class com.mongodb.client.model.GraphLookupOptions
A document specifying additional conditions for the recursive search
retryReads(boolean) - Method in class com.mongodb.MongoClientSettings.Builder
Sets whether reads should be retried if they fail due to a network error.
retryWrites(boolean) - Method in class com.mongodb.MongoClientSettings.Builder
Sets whether writes should be retried if they fail due to a network error.
returnDocument(ReturnDocument) - Method in class com.mongodb.client.model.FindOneAndReplaceOptions
Set whether to return the document before it was replaced or after
returnDocument(ReturnDocument) - Method in class com.mongodb.client.model.FindOneAndUpdateOptions
Set whether to return the document before it was updated / inserted or after
ReturnDocument - Enum Class in com.mongodb.client.model
Indicates which document to return, the original document before change or the document after the change
returnStoredSource(boolean) - Method in interface com.mongodb.client.model.search.SearchOptions
Creates a new SearchOptions that instruct to return only stored source fields.
revision(int) - Method in class com.mongodb.client.gridfs.model.GridFSDownloadOptions
Set the revision of the file to retrieve.
RewrapManyDataKeyOptions - Class in com.mongodb.client.model.vault
The rewrap many data key options
RewrapManyDataKeyOptions() - Constructor for class com.mongodb.client.model.vault.RewrapManyDataKeyOptions
 
RewrapManyDataKeyResult - Class in com.mongodb.client.model.vault
The result of the rewrapping of data keys
RewrapManyDataKeyResult() - Constructor for class com.mongodb.client.model.vault.RewrapManyDataKeyResult
Construct a new instance with no bulk write result
RewrapManyDataKeyResult(BulkWriteResult) - Constructor for class com.mongodb.client.model.vault.RewrapManyDataKeyResult
Construct a new instance
round() - Method in interface com.mongodb.client.model.mql.MqlNumber
The integer result of rounding this to the nearest even value.
round(MqlInteger) - Method in interface com.mongodb.client.model.mql.MqlNumber
The result of rounding this to place decimal places using the "half to even" approach.
roundTripTime(long, TimeUnit) - Method in class com.mongodb.connection.ServerDescription.Builder
Set the weighted average time it took to make the round trip for requesting this information from the server

S

sample(int) - Static method in class com.mongodb.client.model.Aggregates
Creates a $sample pipeline stage with the specified sample size
schemaMap(Map<String, BsonDocument>) - Method in class com.mongodb.AutoEncryptionSettings.Builder
Sets the map from namespace to local schema document
score(SearchScore) - Method in interface com.mongodb.client.model.search.AutocompleteSearchOperator
 
score(SearchScore) - Method in interface com.mongodb.client.model.search.CompoundSearchOperator
 
score(SearchScore) - Method in interface com.mongodb.client.model.search.DateNearSearchOperator
 
score(SearchScore) - Method in interface com.mongodb.client.model.search.DateRangeSearchOperator
 
score(SearchScore) - Method in interface com.mongodb.client.model.search.ExistsSearchOperator
 
score(SearchScore) - Method in interface com.mongodb.client.model.search.FilterCompoundSearchOperator
 
score(SearchScore) - Method in interface com.mongodb.client.model.search.GeoNearSearchOperator
 
score(SearchScore) - Method in interface com.mongodb.client.model.search.MustCompoundSearchOperator
 
score(SearchScore) - Method in interface com.mongodb.client.model.search.MustNotCompoundSearchOperator
 
score(SearchScore) - Method in interface com.mongodb.client.model.search.NumberNearSearchOperator
 
score(SearchScore) - Method in interface com.mongodb.client.model.search.NumberRangeSearchOperator
 
score(SearchScore) - Method in interface com.mongodb.client.model.search.SearchOperator
Creates a new SearchOperator with the scoring modifier specified.
score(SearchScore) - Method in interface com.mongodb.client.model.search.ShouldCompoundSearchOperator
 
score(SearchScore) - Method in interface com.mongodb.client.model.search.TextSearchOperator
 
SCRAM_SHA_1 - Enum constant in enum class com.mongodb.AuthenticationMechanism
The SCRAM-SHA-1 mechanism.
SCRAM_SHA_1_MECHANISM - Static variable in class com.mongodb.MongoCredential
The SCRAM-SHA-1 Mechanism.
SCRAM_SHA_256 - Enum constant in enum class com.mongodb.AuthenticationMechanism
The SCRAM-SHA-256 mechanism.
SCRAM_SHA_256_MECHANISM - Static variable in class com.mongodb.MongoCredential
The SCRAM-SHA-256 Mechanism.
Sealed - Annotation Interface in com.mongodb.annotations
Signifies that the annotated class or interface should be treated as sealed: it must not be extended or implemented by consumers of the library.
search() - Static method in interface com.mongodb.client.model.SearchIndexType
Returns a SearchIndexType instance representing the "search" index type.
search(SearchCollector) - Static method in class com.mongodb.client.model.Aggregates
Creates a $search pipeline stage supported by MongoDB Atlas.
search(SearchCollector, SearchOptions) - Static method in class com.mongodb.client.model.Aggregates
Creates a $search pipeline stage supported by MongoDB Atlas.
search(SearchOperator) - Static method in class com.mongodb.client.model.Aggregates
Creates a $search pipeline stage supported by MongoDB Atlas.
search(SearchOperator, SearchOptions) - Static method in class com.mongodb.client.model.Aggregates
Creates a $search pipeline stage supported by MongoDB Atlas.
SearchCollector - Interface in com.mongodb.client.model.search
The core part of the $search pipeline stage of an aggregation pipeline.
SearchCount - Interface in com.mongodb.client.model.search
Counting options.
SearchFacet - Interface in com.mongodb.client.model.search
A facet definition for FacetSearchCollector.
SearchHighlight - Interface in com.mongodb.client.model.search
Highlighting options.
SearchIndexModel - Class in com.mongodb.client.model
A model describing the creation of a single Atlas Search index.
SearchIndexModel(String, Bson) - Constructor for class com.mongodb.client.model.SearchIndexModel
Construct an instance with the given Atlas Search name and index definition.
SearchIndexModel(String, Bson, SearchIndexType) - Constructor for class com.mongodb.client.model.SearchIndexModel
Construct an instance with the given Atlas Search name, index definition, and type.
SearchIndexModel(Bson) - Constructor for class com.mongodb.client.model.SearchIndexModel
Construct an instance with the given Atlas Search index mapping definition.
SearchIndexType - Interface in com.mongodb.client.model
This interface represents an Atlas Search Index type, which is utilized for creating specific types of indexes.
searchMeta(SearchCollector) - Static method in class com.mongodb.client.model.Aggregates
Creates a $searchMeta pipeline stage supported by MongoDB Atlas.
searchMeta(SearchCollector, SearchOptions) - Static method in class com.mongodb.client.model.Aggregates
Creates a $searchMeta pipeline stage supported by MongoDB Atlas.
searchMeta(SearchOperator) - Static method in class com.mongodb.client.model.Aggregates
Creates a $searchMeta pipeline stage supported by MongoDB Atlas.
searchMeta(SearchOperator, SearchOptions) - Static method in class com.mongodb.client.model.Aggregates
Creates a $searchMeta pipeline stage supported by MongoDB Atlas.
SearchOperator - Interface in com.mongodb.client.model.search
The core part of the $search pipeline stage of an aggregation pipeline.
searchOptions() - Static method in interface com.mongodb.client.model.search.SearchOptions
Returns SearchOptions that represents server defaults.
SearchOptions - Interface in com.mongodb.client.model.search
Represents optional fields of the $search pipeline stage of an aggregation pipeline.
SearchPath - Interface in com.mongodb.client.model.search
A specification of fields to be searched.
SearchScore - Interface in com.mongodb.client.model.search
A modifier of the relevance score.
SearchScoreExpression - Interface in com.mongodb.client.model.search
 
second(MqlString) - Method in interface com.mongodb.client.model.mql.MqlDate
The second of this date as determined by the provided timezone, as an integer between 0 and 59, and 60 in the case of a leap second.
SECOND - Enum constant in enum class com.mongodb.client.model.MongoTimeUnit
secondary() - Static meth