|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.mongodb.Mongo
public class Mongo
A database connection with internal connection pooling. For most applications, you should have one Mongo instance for the entire JVM.
The following are equivalent, and all connect to the local database running on the default port:
Mongo mongo1 = new Mongo(); Mongo mongo1 = new Mongo("localhost"); Mongo mongo2 = new Mongo("localhost", 27017); Mongo mongo4 = new Mongo(new ServerAddress("localhost"));
You can connect to a replica set using the Java driver by passing a ServerAddress list to the Mongo constructor. For example:
Mongo mongo = new Mongo(Arrays.asList( new ServerAddress("localhost", 27017), new ServerAddress("localhost", 27018), new ServerAddress("localhost", 27019)));You can connect to a sharded cluster using the same constructor. Mongo will auto-detect whether the servers are a list of replica set members or a list of mongos servers.
By default, all read and write operations will be made on the primary, but it's possible to read from secondaries by changing the read preference:
mongo.setReadPreference(ReadPreference.secondary());By default, write operations will not throw exceptions on failure, but that is easily changed too:
mongo.setWriteConcern(WriteConcern.SAFE);Note: This class has been superseded by
MongoClient
, and may be deprecated in a future release.
MongoClient
,
ReadPreference
,
WriteConcern
Nested Class Summary | |
---|---|
static class |
Mongo.Holder
Mongo.Holder can be used as a static place to hold several instances of Mongo. |
Field Summary | |
---|---|
static int |
MAJOR_VERSION
Deprecated. Replaced by Mongo.getMajorVersion() |
static int |
MINOR_VERSION
Deprecated. Replaced by Mongo.getMinorVersion() |
Method Summary | |
---|---|
void |
addOption(int option)
adds a default query option |
void |
close()
closes the underlying connector, which in turn closes all open connections. |
static DB |
connect(DBAddress addr)
returns a database object |
String |
debugString()
returns a string representing the hosts used in this Mongo instance |
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 |
DBTCPConnector |
getConnector()
Gets the underlying TCP connector |
String |
getConnectPoint()
Gets the current master's hostname |
List<String> |
getDatabaseNames()
gets a list of all database names present on the server |
DB |
getDB(String dbname)
gets a database object |
static int |
getMajorVersion()
Gets the major version of this library |
int |
getMaxBsonObjectSize()
Gets the maximum size for a BSON object supported by the current master server. |
static int |
getMinorVersion()
Gets the minor version of this library |
MongoOptions |
getMongoOptions()
Returns the mongo options. |
int |
getOptions()
gets the default query options |
ReadPreference |
getReadPreference()
Gets the default read preference |
ReplicaSetStatus |
getReplicaSetStatus()
Gets the replica set status object |
List<ServerAddress> |
getServerAddressList()
Gets the list of server addresses currently seen by the connector. |
Collection<DB> |
getUsedDatabases()
gets a collection of DBs used by the driver since this Mongo instance was created. |
String |
getVersion()
gets this driver version |
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)
sets the default query options |
void |
setReadPreference(ReadPreference preference)
Sets the read preference for this database. |
void |
setWriteConcern(WriteConcern concern)
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 |
Field Detail |
---|
@Deprecated public static final int MAJOR_VERSION
Mongo.getMajorVersion()
@Deprecated public static final int MINOR_VERSION
Mongo.getMinorVersion()
Constructor Detail |
---|
@Deprecated public Mongo() throws UnknownHostException
MongoClient.MongoClient()
)
UnknownHostException
MongoException
@Deprecated public Mongo(String host) throws UnknownHostException
MongoClient.MongoClient(String)
host
- server to connect to
UnknownHostException
- if the database host cannot be resolved
MongoException
@Deprecated public Mongo(String host, MongoOptions options) throws UnknownHostException
MongoClient.MongoClient(String, MongoClientOptions)
host
- server to connect tooptions
- default query options
UnknownHostException
- if the database host cannot be resolved
MongoException
@Deprecated public Mongo(String host, int port) throws UnknownHostException
MongoClient.MongoClient(String, int)
host
- the database's host addressport
- the port on which the database is running
UnknownHostException
- if the database host cannot be resolved
MongoException
@Deprecated public Mongo(ServerAddress addr)
MongoClient.MongoClient(ServerAddress)
addr
- the database address
MongoException
ServerAddress
@Deprecated public Mongo(ServerAddress addr, MongoOptions options)
MongoClient.MongoClient(ServerAddress, MongoClientOptions)
addr
- the database addressoptions
- default query options
MongoException
ServerAddress
@Deprecated public Mongo(ServerAddress left, ServerAddress right)
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).
left
- left side of the pairright
- right side of the pair
MongoException
ServerAddress
@Deprecated public Mongo(ServerAddress left, ServerAddress right, MongoOptions options)
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).
left
- left side of the pairright
- right side of the pairoptions
-
MongoException
ServerAddress
@Deprecated public Mongo(List<ServerAddress> seeds)
MongoClient.MongoClient(java.util.List)
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.
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.
MongoException
ServerAddress
@Deprecated public Mongo(List<ServerAddress> seeds, MongoOptions options)
MongoClient.MongoClient(java.util.List, MongoClientOptions)
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.
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
MongoException
ServerAddress
@Deprecated public Mongo(MongoURI uri) throws UnknownHostException
MongoClient.MongoClient(MongoClientURI)
uri
-
MongoException
UnknownHostException
examples:
- mongodb://localhost
- mongodb://fred:foobar@localhost/
Method Detail |
---|
public static int getMajorVersion()
public static int getMinorVersion()
public static DB connect(DBAddress addr)
addr
- the database address
MongoException
public DB getDB(String dbname)
dbname
- the database name
public Collection<DB> getUsedDatabases()
public List<String> getDatabaseNames()
MongoException
public void dropDatabase(String dbName)
dbName
- name of database to drop
MongoException
public String getVersion()
public String debugString()
public String getConnectPoint()
public DBTCPConnector getConnector()
public ReplicaSetStatus getReplicaSetStatus()
public ServerAddress getAddress()
public List<ServerAddress> getAllAddress()
public List<ServerAddress> getServerAddressList()
MongoException
public void close()
public void setWriteConcern(WriteConcern concern)
WriteConcern
for more information.
concern
- write concern to usepublic WriteConcern getWriteConcern()
public void setReadPreference(ReadPreference preference)
ReadPreference
for more information.
preference
- Read Preference to usepublic ReadPreference getReadPreference()
@Deprecated public void slaveOk()
ReadPreference.secondaryPreferred()
ReadPreference.secondaryPreferred()
public void addOption(int option)
option
- public void setOptions(int options)
options
- public void resetOptions()
public int getOptions()
public MongoOptions getMongoOptions()
public int getMaxBsonObjectSize()
MongoException
public CommandResult fsync(boolean async)
async
- if true, the fsync will be done asynchronously on the server.
MongoException
public CommandResult fsyncAndLock()
MongoException
public DBObject unlock()
MongoException
public boolean isLocked()
MongoException
public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |