com.mongodb
Class Mongo

java.lang.Object
  com.mongodb.Mongo

public class Mongo
extends Object

A database connection with internal pooling. The following are equivalent, and all connect to the local database running on the default port:

 Mongo mongo1 = new Mongo( "127.0.0.1" );
 Mongo mongo2 = new Mongo( "127.0.0.1", 27017 );
 Mongo mongo3 = new Mongo( new DBAddress( "127.0.0.1:27017", "test" ) )
 

Mongo instances have connection pooling built in - see the requestStart and requestDone methods for more information. http://www.mongodb.org/display/DOCS/Java+Driver+Concurrency

Connecting to a Replica Pair

You can connect to a replica pair using the Java driver by passing two DBAddresses to the Mongo constructor. For example:

 DBAddress left = new DBAddress("localhost:27017/test");
 DBAddress right = new DBAddress("localhost:27018/test");

 Mongo mongo = new Mongo(left, right);
 

If the master of a replica pair goes down, there will be a brief lag before the slave becomes master. Thus, your application should be prepared to catch the exceptions that might be thrown in such a case: IllegalArgumentException, MongoException, and MongoException.Network (depending on when the connection drops).

Once the slave becomes master, the driver will begin using that connection as the master connection and the exceptions will stop being thrown.

Field Summary

static int	MAJOR_VERSION
static int	MINOR_VERSION

Constructor Summary

Mongo()

Mongo(ServerAddress addr)
Connects to Mongo using a given DBAddress

Mongo(ServerAddress addr, MongoOptions options)
Connects to Mongo using a given DBAddress

Mongo(ServerAddress left, ServerAddress right)
creates a Mongo connection in paired mode

Mongo(ServerAddress left, ServerAddress right, MongoOptions options)
creates a Mongo connection in paired mode

Mongo(String host)
Connects to the local mongo instance on default port.

Mongo(String host, int port)
Connects to Mongo using a given host, port, and database.

Mongo(String host, MongoOptions options)
Connects to the local mongo instance on default port.

Method Summary

void	close() closes all open connections this Mongo instance can be re-used however
static DB	connect(DBAddress addr)
String	debugString()
void	dropDatabase(String dbName) Drops the database if it exists.
ServerAddress	getAddress() Gets the address of this database.
List<ServerAddress>	getAllAddress()
String	getConnectPoint()
List<String>	getDatabaseNames()
DB	getDB(String dbname)
String	getVersion()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

MAJOR_VERSION

public static final int MAJOR_VERSION

See Also:

Constant Field Values

MINOR_VERSION

public static final int MINOR_VERSION

See Also:

Constant Field Values

Constructor Detail

Mongo

public Mongo()
      throws UnknownHostException,
             MongoException

Throws:

UnknownHostException

MongoException

Mongo

public Mongo(String host)
      throws UnknownHostException,
             MongoException

Connects to the local mongo instance on default port.

Parameters:

host - server to connect to

Throws:

UnknownHostException - if the database host cannot be resolved

MongoException

Mongo

public Mongo(String host,
             MongoOptions options)
      throws UnknownHostException,
             MongoException

Connects to the local mongo instance on default port.

Parameters:

host - server to connect to

options - options to use

Throws:

UnknownHostException - if the database host cannot be resolved

MongoException

Mongo

public Mongo(String host,
             int port)
      throws UnknownHostException,
             MongoException

Connects to Mongo using a given host, port, and database.

Parameters:

host - the database's host address

port - the port on which the database is running

Throws:

UnknownHostException - if the database host cannot be resolved

MongoException

Mongo

public Mongo(ServerAddress addr)
      throws MongoException

Connects to Mongo using a given DBAddress

Parameters:

addr - the database address

Throws:

MongoException

See Also:

DBAddress

Mongo

public Mongo(ServerAddress addr,
             MongoOptions options)
      throws MongoException

Connects to Mongo using a given DBAddress

Parameters:

addr - the database address

Throws:

MongoException

See Also:

DBAddress

Mongo

public Mongo(ServerAddress left,
             ServerAddress right)
      throws MongoException

creates a Mongo connection in paired mode

Parameters:

left - left side of the pair

right - right side of the pair

Throws:

MongoException

Mongo

public Mongo(ServerAddress left,
             ServerAddress right,
             MongoOptions options)
      throws MongoException

creates a Mongo connection in paired mode

Parameters:

left - left side of the pair

right - right side of the pair

Throws:

MongoException

Method Detail

connect

public static DB connect(DBAddress addr)

getDB

public DB getDB(String dbname)

getDatabaseNames

public List<String> getDatabaseNames()
                              throws MongoException

Throws:

MongoException

dropDatabase

public void dropDatabase(String dbName)
                  throws MongoException

Drops the database if it exists.

Parameters:

dbName - name of database to drop

Throws:

MongoException

getVersion

public String getVersion()

debugString

public String debugString()

getConnectPoint

public String getConnectPoint()

getAddress

public ServerAddress getAddress()

Gets the address of this database.

Returns:

the address

getAllAddress

public List<ServerAddress> getAllAddress()

close

public void close()

closes all open connections this Mongo instance can be re-used however