Mongo (mongo-java-driver 3.0.0-beta2 API)

java.lang.Object
- com.mongodb.Mongo

Direct Known Subclasses:

MongoClient
```
@ThreadSafe
public class Mongo
extends Object
```
A database connection with internal connection pooling. For most applications, you should have one Mongo instance for the entire JVM.

Note: This class has been superseded by MongoClient, and may be deprecated in a future release.

See Also:

MongoClient, ReadPreference, WriteConcern

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Mongo.Holder
Mongo.Holder can be used as a static place to hold several instances of Mongo.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Mongo.Holder` Mongo.Holder can be used as a static place to hold several instances of Mongo.

Constructor Summary

Constructors
Constructor and Description
`Mongo()` Deprecated. Replaced by `MongoClient.MongoClient()`)
`Mongo(List<ServerAddress> seeds)` Deprecated. Replaced by `MongoClient.MongoClient(java.util.List)`
`Mongo(List<ServerAddress> seeds, MongoOptions options)` Deprecated. Replaced by `MongoClient.MongoClient(java.util.List, MongoClientOptions)`
`Mongo(MongoURI uri)` Deprecated. Replaced by `MongoClient.MongoClient(MongoClientURI)`
`Mongo(ServerAddress address)` Deprecated. Replaced by `MongoClient.MongoClient(ServerAddress)`
`Mongo(ServerAddress address, MongoOptions options)` Deprecated. Replaced by `MongoClient.MongoClient(ServerAddress, MongoClientOptions)`
`Mongo(ServerAddress left, ServerAddress right)` Deprecated. Please use `MongoClient.MongoClient(java.util.List)` instead.
`Mongo(ServerAddress left, ServerAddress right, MongoOptions options)` Deprecated. Please use `MongoClient.MongoClient(java.util.List, MongoClientOptions)` instead.
`Mongo(String host)` Deprecated. Replaced by `MongoClient.MongoClient(String)`
`Mongo(String host, int port)` Deprecated. Replaced by `MongoClient.MongoClient(String, int)`
`Mongo(String host, MongoOptions options)` Deprecated. Replaced by `MongoClient.MongoClient(String, MongoClientOptions)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addOption(int option)` Add the default query option.
`void`	`close()` Closes all resources associated with this instance, in particular any open network connections.
`void`	`dropDatabase(String dbName)` Drops the database if it exists.
`CommandResult`	`fsync(boolean async)` Forces the master server to fsync the RAM data to disk This is done automatically by the server at intervals, but can be forced for better reliability.
`CommandResult`	`fsyncAndLock()` Forces the master server to fsync the RAM data to disk, then lock all writes.
`ServerAddress`	`getAddress()` Gets the address of the current master
`List<ServerAddress>`	`getAllAddress()` Gets a list of all server addresses used when this Mongo was created
`String`	`getConnectPoint()` Gets a `String` representation of current connection point, i.e.
`List<String>`	`getDatabaseNames()` Gets a list of the names of all databases on the connected server.
`DB`	`getDB(String dbName)` Deprecated. use `MongoClient.getDatabase(String)`
`int`	`getMaxBsonObjectSize()` Gets the maximum size for a BSON object supported by the current master server.
`MongoOptions`	`getMongoOptions()` Deprecated. Please use `MongoClient` class to connect to server and corresponding `MongoClient.getMongoClientOptions()`
`int`	`getOptions()` Gets the default query options
`ReadPreference`	`getReadPreference()` Gets the default read preference
`ReplicaSetStatus`	`getReplicaSetStatus()` Get the status of the replica set cluster.
`List<ServerAddress>`	`getServerAddressList()` Gets the list of server addresses currently seen by this client.
`Collection<DB>`	`getUsedDatabases()` Returns the list of databases used by the driver since this Mongo instance was created.
`WriteConcern`	`getWriteConcern()` Gets the default write concern
`boolean`	`isLocked()` Returns true if the database is locked (read-only), false otherwise.
`void`	`resetOptions()` Reset the default query options.
`void`	`setOptions(int options)` Set the default query options.
`void`	`setReadPreference(ReadPreference readPreference)` Sets the read preference for this database.
`void`	`setWriteConcern(WriteConcern writeConcern)` Sets the write concern for this database.
`void`	`slaveOk()` Deprecated. Replaced with `ReadPreference.secondaryPreferred()`
`String`	`toString()`
`DBObject`	`unlock()` Unlocks the database, allowing the write operations to go through.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Mongo
```
@Deprecated
public Mongo()
```
    Deprecated. Replaced by MongoClient.MongoClient())
    
    Creates a Mongo instance based on a (single) mongodb node (localhost, default port)
    
    Throws:
    
    MongoException - if there's a failure
  - Mongo
```
@Deprecated
public Mongo(String host)
```
    Deprecated. Replaced by MongoClient.MongoClient(String)
    
    Creates a Mongo instance based on a (single) mongodb node (default port)
    
    Parameters:
    
    host - server to connect to
  - Mongo
```
@Deprecated
public Mongo(String host,
                         MongoOptions options)
```
    Deprecated. Replaced by MongoClient.MongoClient(String, MongoClientOptions)
    
    Creates a Mongo instance based on a (single) mongodb node (default port)
    
    Parameters:
    
    host - server to connect to
    
    options - default query options
  - Mongo
```
@Deprecated
public Mongo(String host,
                         int port)
```
    Deprecated. Replaced by MongoClient.MongoClient(String, int)
    
    Creates a Mongo instance based on a (single) mongodb node
    
    Parameters:
    
    host - the host address of the database
    
    port - the port on which the database is running
  - Mongo
```
@Deprecated
public Mongo(ServerAddress address)
```
    Deprecated. Replaced by MongoClient.MongoClient(ServerAddress)
    
    Creates a Mongo instance based on a (single) mongodb node
    
    Parameters:
    
    address - the database address
    
    See Also:
    
    ServerAddress
  - Mongo
```
@Deprecated
public Mongo(ServerAddress address,
                         MongoOptions options)
```
    Deprecated. Replaced by MongoClient.MongoClient(ServerAddress, MongoClientOptions)
    
    Creates a Mongo instance based on a (single) mongo node using a given ServerAddress
    
    Parameters:
    
    address - the database address
    
    options - default query options
    
    See Also:
    
    ServerAddress
  - Mongo
```
@Deprecated
public Mongo(ServerAddress left,
                         ServerAddress right)
```
    Deprecated. Please use MongoClient.MongoClient(java.util.List) instead.
    
    Creates a Mongo in paired mode.
    
    This will also work for a replica set and will find all members (the master will be used by default).
    
    Parameters:
    
    left - left side of the pair
    
    right - right side of the pair
    
    See Also:
    
    ServerAddress
  - Mongo
```
@Deprecated
public Mongo(ServerAddress left,
                         ServerAddress right,
                         MongoOptions options)
```
    Deprecated. Please use MongoClient.MongoClient(java.util.List, MongoClientOptions) instead.
    
    Creates a Mongo connection in paired mode.
    
    This will also work for a replica set and will find all members (the master will be used by default).
    
    Parameters:
    
    left - left side of the pair
    
    right - right side of the pair
    
    options - the optional settings for the Mongo instance
    
    See Also:
    
    ServerAddress
  - Mongo
```
@Deprecated
public Mongo(List<ServerAddress> seeds)
```
    Deprecated. Replaced by MongoClient.MongoClient(java.util.List)
    
    Creates a Mongo based on a list of replica set members or a list of mongos. It will find all members (the master will be used by default). If you pass in a single server in the list, the driver will still function as if it is a replica set. If you have a standalone server, use the Mongo(ServerAddress) constructor.
    
    If this is a list of mongos servers, it will pick the closest (lowest ping time) one to send all requests to, and automatically fail over to the next server if the closest is down.
    
    Parameters:
    
    seeds - Put as many servers as you can in the list and the system will figure out the rest. This can either be a list of mongod servers in the same replica set or a list of mongos servers in the same sharded cluster.
    
    See Also:
    
    ServerAddress
  - Mongo
```
@Deprecated
public Mongo(List<ServerAddress> seeds,
                         MongoOptions options)
```
    Deprecated. Replaced by MongoClient.MongoClient(java.util.List, MongoClientOptions)
    
    Creates a Mongo based on a list of replica set members or a list of mongos. It will find all members (the master will be used by default). If you pass in a single server in the list, the driver will still function as if it is a replica set. If you have a standalone server, use the Mongo(ServerAddress) constructor.
    
    If this is a list of mongos servers, it will pick the closest (lowest ping time) one to send all requests to, and automatically fail over to the next server if the closest is down.
    
    Parameters:
    
    seeds - Put as many servers as you can in the list and the system will figure out the rest. This can either be a list of mongod servers in the same replica set or a list of mongos servers in the same sharded cluster.
    
    options - for configuring this Mongo instance
    
    See Also:
    
    ServerAddress
  - Mongo
```
@Deprecated
public Mongo(MongoURI uri)
```
    Deprecated. Replaced by MongoClient.MongoClient(MongoClientURI)
    Creates a Mongo described by a URI. If only one address is used it will only connect to that node, otherwise it will discover all nodes. If the URI contains database credentials, the database will be authenticated lazily on first use with those credentials.
    
    Examples:
    - mongodb://localhost
    - mongodb://fred:foobar@localhost/
    Parameters:
    
    uri - URI to connect to, optionally containing additional information like credentials
    
    Throws:
    
    MongoException - if there's a failure
    
    See Also:
    
    MongoURI
    
    MongoDB documentation
    
    Connection String URI Format
- Method Detail
  - setWriteConcern
```
public void setWriteConcern(WriteConcern writeConcern)
```
    Sets the write concern for this database. Will be used as default for writes to any collection in any database. See the documentation for WriteConcern for more information.
    
    Parameters:
    
    writeConcern - write concern to use
  - getWriteConcern
```
public WriteConcern getWriteConcern()
```
    Gets the default write concern
    
    Returns:
    
    the default write concern
  - setReadPreference
```
public void setReadPreference(ReadPreference readPreference)
```
    Sets the read preference for this database. Will be used as default for reads from any collection in any database. See the documentation for ReadPreference for more information.
    
    Parameters:
    
    readPreference - Read Preference to use
  - getReadPreference
```
public ReadPreference getReadPreference()
```
    Gets the default read preference
    
    Returns:
    
    the default read preference
  - getAllAddress
```
public List<ServerAddress> getAllAddress()
```
    Gets a list of all server addresses used when this Mongo was created
    
    Returns:
    
    list of server addresses
    
    Throws:
    
    MongoException - if there's a failure
  - getServerAddressList
```
public List<ServerAddress> getServerAddressList()
```
    Gets the list of server addresses currently seen by this client. This includes addresses auto-discovered from a replica set.
    
    Returns:
    
    list of server addresses
    
    Throws:
    
    MongoException - if there's a failure
  - getAddress
```
public ServerAddress getAddress()
```
    Gets the address of the current master
    
    Returns:
    
    the address
  - getMongoOptions
```
@Deprecated
public MongoOptions getMongoOptions()
```
    Deprecated. Please use MongoClient class to connect to server and corresponding MongoClient.getMongoClientOptions()
    
    Returns the mongo options.
    
    Changes to MongoOptions that are done after connection are not reflected.
    
    Returns:
    
    the mongo options
  - getReplicaSetStatus
```
public ReplicaSetStatus getReplicaSetStatus()
```
    Get the status of the replica set cluster.
    
    Returns:
    
    replica set status information
  - getDatabaseNames
```
public List<String> getDatabaseNames()
```
    Gets a list of the names of all databases on the connected server.
    
    Returns:
    
    list of database names
    
    Throws:
    
    MongoException - if the operation fails
  - getDB
```
@Deprecated
public DB getDB(String dbName)
```
    Deprecated. use MongoClient.getDatabase(String)
    
    Gets a database object. Users should use MongoClient.getDatabase(String) instead.
    
    Parameters:
    
    dbName - the name of the database to retrieve
    
    Returns:
    
    a DB representing the specified database
  - getUsedDatabases
```
public Collection<DB> getUsedDatabases()
```
    Returns the list of databases used by the driver since this Mongo instance was created. This may include DBs that exist in the client but not yet on the server.
    
    Returns:
    
    a collection of database objects
  - dropDatabase
```
public void dropDatabase(String dbName)
```
    Drops the database if it exists.
    
    Parameters:
    
    dbName - name of database to drop
    
    Throws:
    
    MongoException - if the operation fails
  - close
```
public void close()
```
    Closes all resources associated with this instance, in particular any open network connections. Once called, this instance and any databases obtained from it can no longer be used.
  - slaveOk
```
@Deprecated
public void slaveOk()
```
    Deprecated. Replaced with ReadPreference.secondaryPreferred()
    
    Makes it possible to run read queries on secondary nodes
    
    See Also:
    
    ReadPreference.secondaryPreferred()
  - setOptions
```
public void setOptions(int options)
```
    Set the default query options.
    
    Parameters:
    
    options - value to be set
  - resetOptions
```
public void resetOptions()
```
    Reset the default query options.
  - addOption
```
public void addOption(int option)
```
    Add the default query option.
    
    Parameters:
    
    option - value to be added to current options
  - getOptions
```
public int getOptions()
```
    Gets the default query options
    
    Returns:
    
    an int representing the options to be used by queries
  - fsync
```
public CommandResult fsync(boolean async)
```
    Forces the master server to fsync the RAM data to disk This is done automatically by the server at intervals, but can be forced for better reliability.
    
    Parameters:
    
    async - if true, the fsync will be done asynchronously on the server.
    
    Returns:
    
    result of the command execution
    
    Throws:
    
    MongoException - if there's a failure
    
    MongoDB documentation
    
    fsync command
  - fsyncAndLock
```
public CommandResult fsyncAndLock()
```
    Forces the master server to fsync the RAM data to disk, then lock all writes. The database will be read-only after this command returns.
    
    Returns:
    
    result of the command execution
    
    Throws:
    
    MongoException - if there's a failure
    
    MongoDB documentation
    
    fsync command
  - unlock
```
public DBObject unlock()
```
    Unlocks the database, allowing the write operations to go through. This command may be asynchronous on the server, which means there may be a small delay before the database becomes writable.
    
    Returns:
    
    DBObject in the following form {"ok": 1,"info": "unlock completed"}
    
    Throws:
    
    MongoException - if there's a failure
    
    MongoDB documentation
    
    fsync command
  - isLocked
```
public boolean isLocked()
```
    Returns true if the database is locked (read-only), false otherwise.
    
    Returns:
    
    result of the command execution
    
    Throws:
    
    MongoException - if the operation fails
    
    MongoDB documentation
    
    fsync command
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - getMaxBsonObjectSize
```
public int getMaxBsonObjectSize()
```
    Gets the maximum size for a BSON object supported by the current master server. Note that this value may change over time depending on which server is master.
    
    Returns:
    
    the maximum size, or 0 if not obtained from servers yet.
    
    Throws:
    
    MongoException - if there's a failure
  - getConnectPoint
```
public String getConnectPoint()
```
    Gets a String representation of current connection point, i.e. master.
    
    Returns:
    
    server address in a host:port form

Class Mongo

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Mongo

Mongo

Mongo

Mongo

Mongo

Mongo

Mongo

Mongo

Mongo

Mongo

Mongo

Method Detail

setWriteConcern

getWriteConcern

setReadPreference

getReadPreference

getAllAddress

getServerAddressList

getAddress

getMongoOptions

getReplicaSetStatus

getDatabaseNames

getDB

getUsedDatabases

dropDatabase

close

slaveOk

setOptions

resetOptions

addOption

getOptions

fsync

fsyncAndLock

unlock

isLocked

toString

getMaxBsonObjectSize

getConnectPoint