Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Enums
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors
• Deprecated Enum Constants

Deprecated Interfaces

Interface and Description
com.mongodb.event.ConnectionListener - No longer used

Deprecated Classes

Class and Description
com.mongodb.AggregationOutput Replace with use of aggregate methods in DBCollection that return instances of Cursor.
com.mongodb.event.ClusterEventMulticaster register multiple cluster listeners instead
com.mongodb.event.CommandEventMulticaster register multiple command listeners instead
com.mongodb.event.CommandListenerMulticaster register multiple command listeners in the settings
com.mongodb.event.ConnectionMessageReceivedEvent - No longer used
com.mongodb.event.ConnectionMessagesSentEvent - No longer used
com.mongodb.event.ConnectionPoolEventMulticaster register multiple command listeners instead
com.mongodb.DBAddress This class is no longer needed, as the driver does not rely on it for anything anymore. Use ServerAddress instead.
com.mongodb.client.gridfs.model.GridFSDownloadByNameOptions use GridFSDownloadOptions instead.
com.mongodb.util.JSON This class has been superseded by to toJson and parse methods on BasicDBObject
com.mongodb.util.JSONCallback This class has been superseded by to toJson and parse methods on BasicDBObject
com.mongodb.util.JSONSerializers This class has been superseded by to toJson and parse methods on BasicDBObject
com.mongodb.MongoOptions Please use MongoClientOptions instead.
com.mongodb.MongoURI Replaced by MongoClientURI
com.mongodb.client.model.ParallelCollectionScanOptions this is an unused class and there should be no reason to use it
com.mongodb.selector.PrimaryServerSelector Use either ReadPreferenceServerSelector or WritableServerSelector, depending on your requirements
com.mongodb.event.ServerEventMulticaster register multiple server listeners instead
com.mongodb.event.ServerMonitorEventMulticaster register multiple server monitor listeners instead
com.mongodb.WriteConcern.Majority Prefer WriteConcern.MAJORITY, WriteConcern.withWTimeout(long, TimeUnit), WriteConcern.withJournal(Boolean)

Deprecated Enums

Enum and Description
com.mongodb.AggregationOptions.OutputMode There is no replacement for this. Applications can assume that the driver will use a cursor for server versions that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate command.

Deprecated Fields

Field and Description
com.mongodb.WriteConcern.FSYNC_SAFE Prefer WriteConcern.JOURNALED
com.mongodb.WriteConcern.FSYNCED Prefer WriteConcern.JOURNALED
com.mongodb.WriteConcern.JOURNAL_SAFE Prefer WriteConcern.JOURNALED
com.mongodb.gridfs.GridFS.MAX_CHUNKSIZE You can calculate max chunkSize with a similar formula Mongo.getMaxBsonObjectSize() - 500*1000. Please ensure that you left enough space for metadata (500kb is enough).
com.mongodb.WriteConcern.NORMAL Prefer WriteConcern.UNACKNOWLEDGED
com.mongodb.WriteConcern.REPLICA_ACKNOWLEDGED Prefer WriteConcern#W2
com.mongodb.WriteConcern.REPLICAS_SAFE Prefer WriteConcern.W2
com.mongodb.WriteConcern.SAFE Prefer WriteConcern.ACKNOWLEDGED

Deprecated Methods

Method and Description
com.mongodb.Mongo.addOption(int) Add options instead on instances of DBCursor
com.mongodb.DB.addUser(String, char[]) Use DB.command to call either the createUser or updateUser command
com.mongodb.DB.addUser(String, char[], boolean) Use DB.command to call either the createUser or updateUser command
com.mongodb.DBCollection.aggregate(DBObject, DBObject...) Use DBCollection.aggregate(List, AggregationOptions) instead
com.mongodb.DBCollection.aggregate(List<? extends DBObject>) Use DBCollection.aggregate(List, AggregationOptions) instead
com.mongodb.DBCollection.aggregate(List<? extends DBObject>, ReadPreference) Use DBCollection.aggregate(List, AggregationOptions, ReadPreference) )} instead
com.mongodb.WriteConcern.callGetLastError() Prefer WriteConcern.isAcknowledged()
com.mongodb.Mongo.Holder.connect(MongoURI) Please use Mongo.Holder.connect(MongoClientURI) instead.
com.mongodb.gridfs.GridFSFile.containsKey(String)
com.mongodb.ReflectionDBObject.containsKey(String)
com.mongodb.ReflectionDBObject.JavaWrapper.containsKey(String)
org.bson.BasicBSONObject.containsKey(String)
org.bson.BSONObject.containsKey(String) Please use BSONObject.containsField(String) instead
org.bson.LazyBSONObject.containsKey(String)
org.bson.types.BasicBSONList.containsKey(String)
com.mongodb.connection.DefaultClusterFactory.create(ClusterSettings, ServerSettings, ConnectionPoolSettings, StreamFactory, StreamFactory, List<MongoCredential>, ClusterListener, ConnectionPoolListener, ConnectionListener, CommandListener) use DefaultClusterFactory.createCluster(ClusterSettings, ServerSettings, ConnectionPoolSettings, StreamFactory, StreamFactory, List, CommandListener, String, MongoDriverInformation) instead
com.mongodb.connection.DefaultClusterFactory.create(ClusterSettings, ServerSettings, ConnectionPoolSettings, StreamFactory, StreamFactory, List<MongoCredential>, ClusterListener, ConnectionPoolListener, ConnectionListener, CommandListener, String, MongoDriverInformation) use DefaultClusterFactory.createCluster(ClusterSettings, ServerSettings, ConnectionPoolSettings, StreamFactory, StreamFactory, List, CommandListener, String, MongoDriverInformation) instead
com.mongodb.client.gridfs.GridFSBucket.downloadToStreamByName(String, OutputStream) use GridFSBucket.downloadToStream(String, OutputStream) instead.
com.mongodb.client.gridfs.GridFSBucket.downloadToStreamByName(String, OutputStream, GridFSDownloadByNameOptions) use GridFSBucket.downloadToStream(String, OutputStream, GridFSDownloadOptions) instead.
com.mongodb.operation.FsyncUnlockOperation.execute(WriteBinding) use FsyncUnlockOperation.execute(ReadBinding) instead.
com.mongodb.DBCollection.find(DBObject, DBObject, int, int) use DBCursor.skip(int) and DBCursor.batchSize(int) on the DBCursor returned from DBCollection.find(DBObject, DBObject)
com.mongodb.DBCollection.find(DBObject, DBObject, int, int, int) use DBCursor.skip(int), DBCursor.batchSize(int) and DBCursor.setOptions(int) on the DBCursor returned from DBCollection.find(DBObject, DBObject)
com.mongodb.WriteConcern.fsync() Prefer WriteConcern.getJournal()
com.mongodb.client.gridfs.model.GridFSFile.getAliases() any aliases should be stored in the metadata document instead.
com.mongodb.connection.ClusterDescription.getAll() Use ClusterDescription.getServerDescriptions() instead
com.mongodb.connection.ClusterDescription.getAny() Replace with a filter on ServerDescription in the caller
com.mongodb.connection.ClusterDescription.getAnyPrimaryOrSecondary() Replace with a filter on ServerDescription in the caller
com.mongodb.connection.ClusterDescription.getAnyPrimaryOrSecondary(TagSet) Replace with a filter on ServerDescription in the caller
com.mongodb.connection.ClusterDescription.getByServerAddress(ServerAddress) Replace with a filter on ServerDescription in the caller
com.mongodb.client.gridfs.model.GridFSFile.getContentType() content type information should be stored the metadata document instead.
com.mongodb.Mongo.getDatabaseNames() Replaced with MongoClient.listDatabaseNames()
com.mongodb.Mongo.getDB(String) use MongoClient.getDatabase(String)
com.mongodb.client.gridfs.model.GridFSFile.getExtraElements() any extra information should be stored in the metadata document instead.
com.mongodb.client.gridfs.GridFSUploadStream.getFileId() use GridFSUploadStream.getObjectId() instead.
com.mongodb.WriteConcern.getFsync() Prefer WriteConcern.getJournal()
com.mongodb.WriteConcern.getJ() Prefer WriteConcern.getJournal()
com.mongodb.client.model.FindOptions.getModifiers() use the individual modifier methods instead.
com.mongodb.Mongo.getMongoOptions() Please use MongoClient class to connect to server and corresponding MongoClient.getMongoClientOptions()
com.mongodb.Mongo.getOptions() Get options instead from instances of DBCursor
com.mongodb.AggregationOptions.getOutputMode() There is no replacement for this. Applications can assume that the driver will use a cursor for server versions that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate command.
com.mongodb.connection.ClusterDescription.getPrimaries() Replace with a filter on ServerDescription in the caller
com.mongodb.connection.ClusterDescription.getSecondaries() Replace with a filter on ServerDescription in the caller
com.mongodb.connection.ClusterDescription.getSecondaries(TagSet) Replace with a filter on ServerDescription in the caller
org.bson.types.ObjectId.getTime() Use #getDate instead
org.bson.types.ObjectId.getTimeSecond() Use #getTimestamp instead
com.mongodb.ConnectionString.getURI()
com.mongodb.operation.AggregateOperation.getUseCursor() There is no replacement for this. Applications can assume that the driver will use a cursor for server versions that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate command.
com.mongodb.WriteConcern.getWtimeout() Prefer WriteConcern.getWTimeout(TimeUnit)
org.bson.BasicBSONCallback.gotBinaryArray(String, byte[])
org.bson.BSONCallback.gotBinaryArray(String, byte[])
org.bson.EmptyBSONCallback.gotBinaryArray(String, byte[])
com.mongodb.connection.Connection.insertCommand(MongoNamespace, boolean, WriteConcern, List<InsertRequest>) Replaced by Connection.insertCommand(MongoNamespace, boolean, WriteConcern, Boolean, List)
com.mongodb.connection.AsyncConnection.insertCommandAsync(MongoNamespace, boolean, WriteConcern, List<InsertRequest>, SingleResultCallback<BulkWriteResult>) Replaced by AsyncConnection.insertCommandAsync(MongoNamespace, boolean, WriteConcern, Boolean, List, SingleResultCallback)
com.mongodb.connection.SocketSettings.isKeepAlive() configuring keep-alive has been deprecated. It now defaults to true and disabling it is not recommended.
com.mongodb.MongoClientOptions.isSocketKeepAlive() configuring keep-alive has been deprecated. It now defaults to true and disabling it is not recommended.
com.mongodb.client.model.CreateCollectionOptions.isUsePowerOf2Sizes() As of MongoDB 3.0, power of 2 sizes is ignored by the MongoDB server
com.mongodb.operation.CreateCollectionOperation.isUsePowerOf2Sizes() As of MongoDB 3.0, power of 2 sizes is ignored by the MongoDB server
com.mongodb.connection.SocketSettings.Builder.keepAlive(boolean) configuring keep-alive has been deprecated. It now defaults to true and disabling it is not recommended.
com.mongodb.connection.Connection.killCursor(List<Long>) Replaced by Connection.killCursor(MongoNamespace, List)
com.mongodb.connection.AsyncConnection.killCursorAsync(List<Long>, SingleResultCallback<Void>) Replaced by AsyncConnection.killCursorAsync(MongoNamespace, List, SingleResultCallback)
com.mongodb.WriteConcern.majorityWriteConcern(int, boolean, boolean) Prefer WriteConcern.MAJORITY, WriteConcern.withWTimeout(long, TimeUnit), WriteConcern.withJournal(Boolean)
org.bson.BsonBinaryReader.mark()
org.bson.BsonDocumentReader.mark()
org.bson.BsonReader.mark() Use BsonReader.getMark() instead
org.bson.json.JsonReader.mark()
com.mongodb.client.FindIterable.modifiers(Bson) use the individual setters instead
com.mongodb.async.client.FindIterable.modifiers(Bson) use the individual setters instead
com.mongodb.client.model.FindOptions.modifiers(Bson) use the individual modifier methods instead.
com.mongodb.operation.FindOperation.modifiers(BsonDocument) use the individual setters instead
com.mongodb.client.gridfs.GridFSBucket.openDownloadStreamByName(String) use GridFSBucket.openDownloadStream(String) instead.
com.mongodb.client.gridfs.GridFSBucket.openDownloadStreamByName(String, GridFSDownloadByNameOptions) use GridFSBucket.openDownloadStream(String, GridFSDownloadOptions) instead.
com.mongodb.AggregationOptions.Builder.outputMode(AggregationOptions.OutputMode) There is no replacement for this. Applications can assume that the driver will use a cursor for server versions that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate command.
com.mongodb.connection.Connection.query(MongoNamespace, BsonDocument, BsonDocument, int, int, boolean, boolean, boolean, boolean, boolean, boolean, Decoder<T>) Replaced by Connection.query(MongoNamespace, BsonDocument, BsonDocument, int, int, int, boolean, boolean, boolean, boolean, boolean, boolean, Decoder)
com.mongodb.connection.AsyncConnection.queryAsync(MongoNamespace, BsonDocument, BsonDocument, int, int, boolean, boolean, boolean, boolean, boolean, boolean, Decoder<T>, SingleResultCallback<QueryResult<T>>) Replaced by AsyncConnection.queryAsync(MongoNamespace, BsonDocument, BsonDocument, int, int, int, boolean, boolean, boolean, boolean, boolean, boolean, Decoder, SingleResultCallback)
com.mongodb.DB.removeUser(String) Use DB.command to call the dropUser command
com.mongodb.Mongo.resetOptions() Reset options instead on instances of DBCursor
com.mongodb.Mongo.setOptions(int) Set options on instances of DBCursor
com.mongodb.Mongo.setReadPreference(ReadPreference) Set the default read preference with either MongoClientURI or MongoClientOptions
com.mongodb.Mongo.setWriteConcern(WriteConcern) Set the default write concern with either MongoClientURI or MongoClientOptions
com.mongodb.DB.slaveOk() Replaced with ReadPreference.secondaryPreferred()
com.mongodb.DBCollection.slaveOk() Replaced with ReadPreference.secondaryPreferred()
com.mongodb.DBCursor.slaveOk() Replaced with ReadPreference.secondaryPreferred()
com.mongodb.Mongo.slaveOk() Replaced with ReadPreference.secondaryPreferred()
com.mongodb.MongoClientOptions.Builder.socketKeepAlive(boolean) configuring keep-alive has been deprecated. It now defaults to true and disabling it is not recommended.
com.mongodb.client.model.Filters.text(String, String) use Filters.text(String, TextSearchOptions)
org.bson.types.ObjectId.toStringMongod() use ObjectId.toHexString()
com.mongodb.connection.Connection.updateCommand(MongoNamespace, boolean, WriteConcern, List<UpdateRequest>) Replaced by Connection.updateCommand(MongoNamespace, boolean, WriteConcern, Boolean, List)}
com.mongodb.connection.AsyncConnection.updateCommandAsync(MongoNamespace, boolean, WriteConcern, List<UpdateRequest>, SingleResultCallback<BulkWriteResult>) Replaced by AsyncConnection.updateCommandAsync(MongoNamespace, boolean, WriteConcern, Boolean, List, SingleResultCallback)
com.mongodb.client.AggregateIterable.useCursor(Boolean) There is no replacement for this. Applications can assume that the driver will use a cursor for server versions that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate command.
com.mongodb.async.client.AggregateIterable.useCursor(Boolean) There is no replacement for this. Applications can assume that the driver will use a cursor for server versions that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate command.
com.mongodb.operation.AggregateOperation.useCursor(Boolean) There is no replacement for this. Applications can assume that the driver will use a cursor for server versions that support it (>= 2.6). The driver will ignore this as of MongoDB 3.6, which does not support inline results for the aggregate command.
com.mongodb.client.model.CreateCollectionOptions.usePowerOf2Sizes(Boolean) As of MongoDB 3.0, power of 2 sizes is ignored by the MongoDB server
com.mongodb.operation.CreateCollectionOperation.usePowerOf2Sizes(Boolean) As of MongoDB 3.0, power of 2 sizes is ignored by the MongoDB server
com.mongodb.WriteConcern.withFsync(boolean) Prefer WriteConcern.withJournal(Boolean)
com.mongodb.WriteConcern.withJ(boolean) Prefer WriteConcern.withJournal(Boolean)

Deprecated Constructors

Constructor and Description
com.mongodb.operation.AggregateToCollectionOperation(MongoNamespace, List<BsonDocument>) Prefer AggregateToCollectionOperation.AggregateToCollectionOperation(MongoNamespace, List, WriteConcern)
org.bson.json.JsonWriter.Context(JsonWriter.Context, BsonContextType, String)
com.mongodb.operation.CreateIndexesOperation(MongoNamespace, List<IndexRequest>) Prefer CreateIndexesOperation.CreateIndexesOperation(MongoNamespace, List, WriteConcern)
com.mongodb.operation.CreateUserOperation(MongoCredential, boolean) Prefer CreateUserOperation.CreateUserOperation(MongoCredential, boolean, WriteConcern)
com.mongodb.operation.DropCollectionOperation(MongoNamespace) Prefer DropCollectionOperation.DropCollectionOperation(MongoNamespace, WriteConcern)
com.mongodb.operation.DropDatabaseOperation(String)
com.mongodb.operation.DropIndexOperation(MongoNamespace, BsonDocument) Prefer DropIndexOperation.DropIndexOperation(MongoNamespace, BsonDocument, WriteConcern)
com.mongodb.operation.DropIndexOperation(MongoNamespace, String) Prefer DropIndexOperation.DropIndexOperation(MongoNamespace, String, WriteConcern)
com.mongodb.operation.DropUserOperation(String, String) Prefer DropUserOperation.DropUserOperation(String, String, WriteConcern)
com.mongodb.operation.FindAndDeleteOperation(MongoNamespace, Decoder<T>) use FindAndDeleteOperation.FindAndDeleteOperation(MongoNamespace, WriteConcern, Decoder) instead
com.mongodb.operation.FindAndReplaceOperation(MongoNamespace, Decoder<T>, BsonDocument) use FindAndReplaceOperation.FindAndReplaceOperation(MongoNamespace, WriteConcern, Decoder, BsonDocument) instead
com.mongodb.operation.FindAndUpdateOperation(MongoNamespace, Decoder<T>, BsonDocument) use FindAndUpdateOperation.FindAndUpdateOperation(MongoNamespace, WriteConcern, Decoder, BsonDocument) instead
org.bson.json.JsonWriterSettings() Prefer JsonWriterSettings.builder(), but note that the default output mode is different for that method
org.bson.json.JsonWriterSettings(boolean) Use the JsonWriterSettings.Builder instead
org.bson.json.JsonWriterSettings(JsonMode) Use the JsonWriterSettings.Builder instead
org.bson.json.JsonWriterSettings(JsonMode, boolean) Use the JsonWriterSettings.Builder instead
org.bson.json.JsonWriterSettings(JsonMode, String) Use the JsonWriterSettings.Builder instead
org.bson.json.JsonWriterSettings(JsonMode, String, String) Use the JsonWriterSettings.Builder instead
com.mongodb.Mongo() Replaced by MongoClient.MongoClient())
com.mongodb.Mongo(List<ServerAddress>) Replaced by MongoClient.MongoClient(java.util.List)
com.mongodb.Mongo(List<ServerAddress>, MongoOptions) Replaced by MongoClient.MongoClient(java.util.List, MongoClientOptions)
com.mongodb.Mongo(MongoURI) Replaced by MongoClient.MongoClient(MongoClientURI)
com.mongodb.Mongo(ServerAddress) Replaced by MongoClient.MongoClient(ServerAddress)
com.mongodb.Mongo(ServerAddress, MongoOptions) Replaced by MongoClient.MongoClient(ServerAddress, MongoClientOptions)
com.mongodb.Mongo(ServerAddress, ServerAddress) Please use MongoClient.MongoClient(java.util.List) instead.
com.mongodb.Mongo(ServerAddress, ServerAddress, MongoOptions) Please use MongoClient.MongoClient(java.util.List, MongoClientOptions) instead.
com.mongodb.Mongo(String) Replaced by MongoClient.MongoClient(String)
com.mongodb.Mongo(String, int) Replaced by MongoClient.MongoClient(String, int)
com.mongodb.Mongo(String, MongoOptions) Replaced by MongoClient.MongoClient(String, MongoClientOptions)
com.mongodb.MongoOptions() use MongoClientOptions
com.mongodb.MongoOptions(MongoClientOptions) use MongoClientOptions
com.mongodb.MongoURI(MongoClientURI)
com.mongodb.MongoURI(String) Replaced by MongoClientURI.MongoClientURI(String)
com.mongodb.connection.netty.NettyStreamFactoryFactory() Use NettyStreamFactoryFactory.builder() instead to construct the NettyStreamFactoryFactory.
com.mongodb.connection.netty.NettyStreamFactoryFactory(EventLoopGroup, ByteBufAllocator) Use NettyStreamFactoryFactory.builder() instead to construct the NettyStreamFactoryFactory.
com.mongodb.operation.RenameCollectionOperation(MongoNamespace, MongoNamespace) Prefer RenameCollectionOperation.RenameCollectionOperation(MongoNamespace, MongoNamespace, WriteConcern)
com.mongodb.operation.UpdateUserOperation(MongoCredential, boolean) Prefer UpdateUserOperation.UpdateUserOperation(MongoCredential, boolean, WriteConcern)
com.mongodb.WriteConcern() Prefer WriteConcern.UNACKNOWLEDGED
com.mongodb.WriteConcern(boolean) prefer WriteConcern.JOURNALED or WriteConcern.withJournal(Boolean)
com.mongodb.WriteConcern(int, int, boolean) Prefer WriteConcern.withW(int), WriteConcern.withWTimeout(long, TimeUnit), WriteConcern.withJournal(Boolean)
com.mongodb.WriteConcern(int, int, boolean, boolean) Prefer WriteConcern.withW(int), WriteConcern.withWTimeout(long, TimeUnit), WriteConcern.withJournal(Boolean)
com.mongodb.WriteConcern(String, int, boolean, boolean) Prefer WriteConcern.withW(String), WriteConcern.withWTimeout(long, TimeUnit), WriteConcern.withJournal(Boolean)

Deprecated Enum Constants

Enum Constant and Description
org.bson.json.JsonMode.STRICT The format generated with this mode is no longer considered standard for MongoDB tools.