Deprecated API

Contents

• Deprecated Interfaces
• Deprecated Classes
• Deprecated Enums
• Deprecated Exceptions
• Deprecated Fields
• Deprecated Methods
• Deprecated Constructors

Deprecated Interfaces

Interface	Description
com.mongodb.util.ObjectSerializer	there is no replacement for this interface

Deprecated Classes

Class	Description
com.mongodb.AggregationOutput	Replace with use of aggregate methods in DBCollection that return instances of Cursor.
com.mongodb.Bytes	there is no replacement for this class
com.mongodb.gridfs.CLI	there is no replacement for this class
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.GroupCommand	the group command was deprecated in MongoDB 3.4
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.Mongo	Replaced by MongoClient. Any non-deprecated methods will be moved to MongoClient. The rest will be removed along with this class.
com.mongodb.Mongo.Holder
com.mongodb.MongoOptions	Please use MongoClientOptions instead.
com.mongodb.MongoURI	Replaced by MongoClientURI
com.mongodb.ParallelScanOptions	the parallelCollectionScan command will be removed in MongoDB 4.2
com.mongodb.ReflectionDBObject	Replaced by PojoCodecProvider
com.mongodb.ReplicaSetStatus	Prefer MongoClientOptions.Builder.addClusterListener(ClusterListener)
com.mongodb.util.Util	there is no replacement for this class

Deprecated Enums

Enum	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 Exceptions

Exceptions	Description
com.mongodb.util.JSONParseException	there is no replacement for this class

Deprecated Fields

Field	Description
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).

Deprecated Methods

Method	Description
com.mongodb.DB.addOption(int)	Replaced with DBCursor.addOption(int)
com.mongodb.DBCollection.addOption(int)	Replaced with DBCursor.addOption(int)
com.mongodb.DBCursor.addOption(int)	Prefer per-option methods, e.g. DBCursor.cursorType(CursorType), DBCursor.noCursorTimeout(boolean), etc.
com.mongodb.Mongo.addOption(int)	Add options instead on instances of DBCursor
com.mongodb.DBCursor.addSpecial(String, Object)	Prefer per-operator methods, e.g. DBCursor.comment(String), DBCursor.explain(), etc.
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.MongoClientOptions.Builder.alwaysUseMBeans(boolean)	there is no replacement for this property
com.mongodb.Mongo.Holder.connect(MongoURI)	Please use Mongo.Holder.connect(MongoClientURI) instead.
com.mongodb.gridfs.GridFSFile.containsKey(String)
com.mongodb.ReflectionDBObject.JavaWrapper.containsKey(String)
com.mongodb.client.MongoCollection.count()	use MongoCollection.countDocuments() or MongoCollection.estimatedDocumentCount() instead
com.mongodb.client.MongoCollection.count(ClientSession)	use MongoCollection.countDocuments(ClientSession) instead
com.mongodb.client.MongoCollection.count(ClientSession, Bson)	use MongoCollection.countDocuments(ClientSession, Bson) instead
com.mongodb.client.MongoCollection.count(ClientSession, Bson, CountOptions)	use MongoCollection.countDocuments(ClientSession, Bson, CountOptions) instead
com.mongodb.client.MongoCollection.count(Bson)	use MongoCollection.countDocuments(Bson) instead
com.mongodb.client.MongoCollection.count(Bson, CountOptions)	use MongoCollection.countDocuments(Bson, CountOptions) instead
com.mongodb.MongoClientOptions.Builder.description(String)	Prefer MongoClientOptions.Builder.applicationName(String)
com.mongodb.DB.doEval(String, Object...)	The eval command was deprecated in MongoDB 3.0
com.mongodb.DB.doGetCollection(String)	there is no replacement for this method
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.DB.eval(String, Object...)	The eval command was deprecated in MongoDB 3.0
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.client.MongoIterable.forEach(Block<? super TResult>)	Prefer Iterable.forEach(Consumer), which was added in Java 8
com.mongodb.Mongo.fsync(boolean)
com.mongodb.Mongo.fsyncAndLock()
com.mongodb.Mongo.getAddress()
com.mongodb.Mongo.getAllAddress()
com.mongodb.DB.getCollectionFromString(String)	Prefer DB.getCollection(String)
com.mongodb.Mongo.getConnectPoint()
com.mongodb.DBCollection.getCount(DBObject, DBObject)	Prefer DBCollection.count(DBObject, DBCollectionCountOptions)
com.mongodb.DBCollection.getCount(DBObject, DBObject, long, long)	Prefer DBCollection.count(DBObject, DBCollectionCountOptions)
com.mongodb.DBCollection.getCount(DBObject, DBObject, long, long, ReadPreference)	Prefer DBCollection.count(DBObject, DBCollectionCountOptions)
com.mongodb.DBCollection.getCount(DBObject, DBObject, ReadPreference)	Prefer DBCollection.count(DBObject, DBCollectionCountOptions)
com.mongodb.MongoClient.getCredentialsList()	Prefer MongoClient.getCredential()
com.mongodb.Mongo.getDatabaseNames()	Replaced with MongoClient.listDatabaseNames()
com.mongodb.Mongo.getDB(String)	This method is not currently scheduled for removal, but prefer MongoClient.getDatabase(String) for new code. Note that DB and MongoDatabase can be used together in the same application, whith the same MongoClient instance.
com.mongodb.MongoClientOptions.getDescription()	Prefer MongoClientOptions.getApplicationName()
com.mongodb.client.gridfs.GridFSUploadStream.getFileId()	use GridFSUploadStream.getObjectId() instead.
com.mongodb.DBCollection.getHintFields()	Prefer DBCursor.hint(DBObject)
com.mongodb.client.model.DBCollectionCountOptions.getHintString()	Prefer DBCollectionCountOptions.getHint()
com.mongodb.Mongo.getMaxBsonObjectSize()
com.mongodb.gridfs.GridFSFile.getMD5()	there is no replacement for this method
com.mongodb.client.model.DBCollectionFindOptions.getModifiers()	use the individual setters instead
com.mongodb.DB.getMongo()	Use DB.getMongoClient() instead
com.mongodb.Mongo.getMongoOptions()	Please use MongoClient class to connect to server and corresponding MongoClient.getMongoClientOptions()
com.mongodb.DB.getOptions()	Replaced with DBCursor.getOptions()
com.mongodb.DBCollection.getOptions()	Replaced with DBCursor.getOptions()
com.mongodb.DBCursor.getOptions()
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.Mongo.getReplicaSetStatus()
com.mongodb.Mongo.getServerAddressList()
com.mongodb.MongoClientOptions.getSocketFactory()	Prefer MongoClientOptions.isSslEnabled() and MongoClientOptions.getSslContext()
com.mongodb.DB.getStats()	Prefer DB.command(DBObject) to run the dbStats command
com.mongodb.Mongo.getUsedDatabases()
com.mongodb.DBCollection.group(DBObject, DBObject, DBObject, String)	The group command was deprecated in MongoDB 3.4
com.mongodb.DBCollection.group(DBObject, DBObject, DBObject, String, String)	The group command was deprecated in MongoDB 3.4
com.mongodb.DBCollection.group(DBObject, DBObject, DBObject, String, String, ReadPreference)	The group command was deprecated in MongoDB 3.4
com.mongodb.DBCollection.group(GroupCommand)	The group command was deprecated in MongoDB 3.4
com.mongodb.DBCollection.group(GroupCommand, ReadPreference)	The group command was deprecated in MongoDB 3.4
com.mongodb.DBCursor.hint(String)	Prefer DBCursor.hint(DBObject)
com.mongodb.client.model.DBCollectionCountOptions.hintString(String)	Prefer DBCollectionCountOptions.hint(DBObject)
com.mongodb.MongoClientOptions.isAlwaysUseMBeans()	there is no replacement for this property
com.mongodb.Mongo.isLocked()
com.mongodb.MongoClientOptions.isSocketKeepAlive()	configuring keep-alive has been deprecated. It now defaults to true and disabling it is not recommended.
com.mongodb.MongoClientOptions.Builder.legacyDefaults()	there is no replacement for this method
com.mongodb.client.FindIterable.maxScan(long)	Deprecated as of MongoDB 4.0 release
com.mongodb.DBCursor.maxScan(int)	Deprecated as of MongoDB 4.0 release
com.mongodb.client.FindIterable.modifiers(Bson)	use the individual setters instead
com.mongodb.client.model.DBCollectionFindOptions.modifiers(DBObject)	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.DBCollection.parallelScan(ParallelScanOptions)	the parallelCollectionScan command will be removed in MongoDB 4.2
com.mongodb.DB.removeUser(String)	Use DB.command to call the dropUser command
com.mongodb.client.MongoCollection.replaceOne(ClientSession, Bson, TDocument, UpdateOptions)	use MongoCollection.replaceOne(ClientSession, Bson, Object, ReplaceOptions) instead
com.mongodb.client.MongoCollection.replaceOne(Bson, TDocument, UpdateOptions)	use MongoCollection.replaceOne(Bson, Object, ReplaceOptions) instead
com.mongodb.DB.resetOptions()	Replaced with DBCursor.resetOptions()
com.mongodb.DBCollection.resetOptions()	Replaced with DBCursor.resetOptions()
com.mongodb.DBCursor.resetOptions()
com.mongodb.Mongo.resetOptions()	Reset options instead on instances of DBCursor
com.mongodb.DBCollection.setHintFields(List<? extends DBObject>)	Prefer DBCursor.hint(DBObject)
com.mongodb.DB.setOptions(int)	Replaced with DBCursor.setOptions(int)
com.mongodb.DBCollection.setOptions(int)	Replaced with DBCursor.setOptions(int)
com.mongodb.DBCursor.setOptions(int)
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.DBCursor.showDiskLoc()	showDiskLoc has been deprecated in the MongoDB server. There is no replacement for it.
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.client.FindIterable.snapshot(boolean)	Deprecated in MongoDB 3.6 release and removed in MongoDB 4.0 release
com.mongodb.DBCursor.snapshot()	Deprecated in MongoDB 3.6 release and removed in MongoDB 4.0 release
com.mongodb.MongoClientOptions.Builder.socketFactory(SocketFactory)	Prefer MongoClientOptions.Builder.sslEnabled(boolean) and MongoClientOptions.Builder.sslContext(SSLContext)
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.Mongo.unlock()
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.gridfs.GridFSFile.validate()	there is no replacement for this method

Deprecated Constructors

Constructor	Description
com.mongodb.DB(Mongo, String)	Prefer Mongo.getDB(String)
com.mongodb.Mongo()	Replaced by MongoClient())
com.mongodb.Mongo(MongoURI)	Replaced by MongoClient(MongoClientURI)
com.mongodb.Mongo(ServerAddress)	Replaced by MongoClient(ServerAddress)
com.mongodb.Mongo(ServerAddress, MongoOptions)	Replaced by MongoClient(ServerAddress, MongoClientOptions)
com.mongodb.Mongo(ServerAddress, ServerAddress)	Please use MongoClient(java.util.List) instead.
com.mongodb.Mongo(ServerAddress, ServerAddress, MongoOptions)	Please use MongoClient(java.util.List, MongoClientOptions) instead.
com.mongodb.Mongo(String)	Replaced by MongoClient(String)
com.mongodb.Mongo(String, int)	Replaced by MongoClient(String, int)
com.mongodb.Mongo(String, MongoOptions)	Replaced by MongoClient(String, MongoClientOptions)
com.mongodb.Mongo(List<ServerAddress>)	Replaced by MongoClient(java.util.List)
com.mongodb.Mongo(List<ServerAddress>, MongoOptions)	Replaced by MongoClient(java.util.List, MongoClientOptions)
com.mongodb.MongoClient(ServerAddress, List<MongoCredential>)	Prefer MongoClient(ServerAddress, MongoCredential, MongoClientOptions)
com.mongodb.MongoClient(ServerAddress, List<MongoCredential>, MongoClientOptions)	Prefer MongoClient(ServerAddress, MongoCredential, MongoClientOptions)
com.mongodb.MongoClient(ServerAddress, List<MongoCredential>, MongoClientOptions, MongoDriverInformation)	Prefer MongoClient(ServerAddress, MongoCredential, MongoClientOptions, MongoDriverInformation)
com.mongodb.MongoClient(List<ServerAddress>, List<MongoCredential>)	Prefer MongoClient(List, MongoCredential, MongoClientOptions)
com.mongodb.MongoClient(List<ServerAddress>, List<MongoCredential>, MongoClientOptions)	Prefer MongoClient(List, MongoCredential, MongoClientOptions)
com.mongodb.MongoClient(List<ServerAddress>, List<MongoCredential>, MongoClientOptions, MongoDriverInformation)	Prefer MongoClient(List, MongoCredential, MongoClientOptions, MongoDriverInformation)
com.mongodb.MongoOptions()	use MongoClientOptions
com.mongodb.MongoOptions(MongoClientOptions)	use MongoClientOptions
com.mongodb.MongoURI(MongoClientURI)
com.mongodb.MongoURI(String)	Replaced by MongoClientURI(String)