com.allanbank.mongodb

Interface MongoDatabase

All Known Implementing Classes:

MongoDatabaseImpl

public interface MongoDatabase

Interface for interacting with a MongoDB database. Primarily used to get a MongoCollection .

API Notice:

This interface is part of the driver's API. Public and protected members will be deprecated for at least 1 non-bugfix release (version numbers are <major>.<minor>.<bugfix>) before being removed or modified.

Copyright ©:

2011-2013, Allanbank Consulting, Inc., All Rights Reserved

Field Summary

Fields

Modifier and Type	Field and Description
static String	ADMIN_NAME The name of the administration database.
static String	CONFIG_NAME The name of the configuration database for a sharded configuration.
static String	LOCAL_NAME The name of the local database.
static String	TEST_NAME The name of the test database.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	createCappedCollection(String name, long size) Creates the capped collection with the specified name and size on the server.
boolean	createCollection(String name, DocumentAssignable options) Creates the collection with the specified name on the server.
boolean	drop() Drops the database.
boolean	exists() Returns true if this database already exists on the server.
MongoCollection	getCollection(String name) Returns the MongoCollection with the specified name.
Durability	getDurability() Returns the durability for write operations sent to the server from this MongoDatabase instance.
String	getName() Returns the name of the database.
ProfilingStatus	getProfilingStatus() Retrieves the profiling level for the database.
ReadPreference	getReadPreference() Returns the read preference for queries from this MongoDatabase instance.
List<String>	listCollectionNames() Returns the list of the collections contained within the database.
List<String>	listCollections() Deprecated. Use the listCollectionNames() method instead.
Document	runAdminCommand(String command) Runs an administrative command against the 'admin' database.
Document	runAdminCommand(String command, DocumentAssignable options) Runs an administrative command against the 'admin' database.
Document	runAdminCommand(String commandName, String commandValue, DocumentAssignable options) Runs an administrative command against the 'admin' database.
Document	runCommand(DocumentAssignable command) Runs a command against the database.
Document	runCommand(String command) Runs a command against the database.
Document	runCommand(String command, DocumentAssignable options) Runs a command against the database.
Document	runCommand(String commandName, int commandValue, DocumentAssignable options) Runs a command against the database.
Document	runCommand(String commandName, String commandValue, DocumentAssignable options) Runs a command against the database.
void	runCommandAsync(Callback<Document> reply, DocumentAssignable command) Runs a command against the database.
void	runCommandAsync(Callback<Document> reply, DocumentAssignable command, Version requiredServerVersion) Runs a command against the database.
void	runCommandAsync(Callback<Document> reply, String command) Runs a command against the database.
void	runCommandAsync(Callback<Document> reply, String command, DocumentAssignable options) Runs a command against the database.
void	runCommandAsync(Callback<Document> reply, String commandName, int commandValue, DocumentAssignable options) Runs a command against the database.
void	runCommandAsync(Callback<Document> reply, String commandName, String commandValue, DocumentAssignable options) Runs a command against the database.
ListenableFuture<Document>	runCommandAsync(DocumentAssignable command) Runs a command against the database.
void	runCommandAsync(LambdaCallback<Document> reply, DocumentAssignable command) Runs a command against the database.
void	runCommandAsync(LambdaCallback<Document> reply, DocumentAssignable command, Version requiredServerVersion) Runs a command against the database.
void	runCommandAsync(LambdaCallback<Document> reply, String command) Runs a command against the database.
void	runCommandAsync(LambdaCallback<Document> reply, String command, DocumentAssignable options) Runs a command against the database.
void	runCommandAsync(LambdaCallback<Document> reply, String commandName, int commandValue, DocumentAssignable options) Runs a command against the database.
void	runCommandAsync(LambdaCallback<Document> reply, String commandName, String commandValue, DocumentAssignable options) Runs a command against the database.
ListenableFuture<Document>	runCommandAsync(String command) Runs a command against the database.
ListenableFuture<Document>	runCommandAsync(String command, DocumentAssignable options) Runs a command against the database.
ListenableFuture<Document>	runCommandAsync(String commandName, int commandValue, DocumentAssignable options) Runs a command against the database.
ListenableFuture<Document>	runCommandAsync(String commandName, String commandValue, DocumentAssignable options) Runs a command against the database.
void	setDurability(Durability durability) Sets the durability for write operations from this MongoDatabase instance.
boolean	setProfilingStatus(ProfilingStatus profileLevel) Sets the profiling level for the database.
void	setReadPreference(ReadPreference readPreference) Sets the value of the read preference for a queries from this MongoDatabase instance.
Document	stats() Returns the statistics for the database.

Field Detail

ADMIN_NAME

static final String ADMIN_NAME

The name of the administration database.

See Also:

Constant Field Values

CONFIG_NAME

static final String CONFIG_NAME

The name of the configuration database for a sharded configuration.

See Also:

Constant Field Values

LOCAL_NAME

static final String LOCAL_NAME

The name of the local database.

See Also:

Constant Field Values

TEST_NAME

static final String TEST_NAME

The name of the test database.

See Also:

Constant Field Values

Method Detail

createCappedCollection

boolean createCappedCollection(String name,
                             long size)
                               throws MongoDbException

Creates the capped collection with the specified name and size on the server.

Parameters:

name - The name of the collection.

size - The size of the collection in bytes.

Returns:

True if the collection was created, false otherwise (including it already exists).

Throws:

MongoDbException - On a failure to create the collection.

createCollection

boolean createCollection(String name,
                       DocumentAssignable options)
                         throws MongoDbException

Creates the collection with the specified name on the server.

Parameters:

name - The name of the collection.

options - The options for the collection being created.

Returns:

True if the collection was created, false otherwise (including it already exists).

Throws:

MongoDbException - On a failure to create the collection.

drop

boolean drop()
             throws MongoDbException

Drops the database.

Returns:

True if the database was successfully dropped, false otherwise.

Throws:

MongoDbException - On an error issuing the drop command or in running the command

exists

boolean exists()
               throws MongoDbException

Returns true if this database already exists on the server.

This method is simply a helper name to check if this database's name appears in the parent client's list of databases.

Returns:

True if the parent client's returns this database's name in its list of database's names.

Throws:

MongoDbException - On an error retrieving the list of database's.

getCollection

MongoCollection getCollection(String name)

Returns the MongoCollection with the specified name. This method does not validate that the collection already exists in the MongoDB database.

Parameters:

name - The name of the collection.

Returns:

The MongoCollection.

getDurability

Durability getDurability()

Returns the durability for write operations sent to the server from this MongoDatabase instance.

Defaults to the Durability from the Mongo's configuration.

Returns:

The durability for write operations on the server.

See Also:

MongoClientConfiguration.getDefaultDurability()

getName

String getName()

Returns the name of the database.

Returns:

The name of the database.

getProfilingStatus

ProfilingStatus getProfilingStatus()
                                   throws MongoDbException

Retrieves the profiling level for the database.

Returns:

The current profiling level.

Throws:

MongoDbException - On a failure to create the collection.

See Also:

profile Command Reference

getReadPreference

ReadPreference getReadPreference()

Returns the read preference for queries from this MongoDatabase instance.

Defaults to ReadPreference from the Mongo's configuration.

Returns:

The default read preference for a query.

See Also:

MongoClientConfiguration.getDefaultReadPreference()

listCollectionNames

List<String> listCollectionNames()
                                 throws MongoDbException

Returns the list of the collections contained within the database.

Returns:

The list of the collections contained within the database.

Throws:

MongoDbException - On an error listing the collections.

listCollections

@Deprecated
List<String> listCollections()
                             throws MongoDbException

Deprecated. Use the listCollectionNames() method instead.

Returns the list of the collections contained within the database.

Returns:

The list of the collections contained within the database.

Throws:

MongoDbException - On an error listing the collections.

runAdminCommand

Document runAdminCommand(String command)
                         throws MongoDbException

Runs an administrative command against the 'admin' database.

Parameters:

command - The name of the command to run.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runAdminCommand

Document runAdminCommand(String command,
                       DocumentAssignable options)
                         throws MongoDbException

Runs an administrative command against the 'admin' database.

Parameters:

command - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runAdminCommand

Document runAdminCommand(String commandName,
                       String commandValue,
                       DocumentAssignable options)
                         throws MongoDbException

Runs an administrative command against the 'admin' database.

Parameters:

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommand

Document runCommand(DocumentAssignable command)
                    throws MongoDbException

Runs a command against the database.

Parameters:

command - The command document to run.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommand

Document runCommand(String command)
                    throws MongoDbException

Runs a command against the database.

Parameters:

command - The name of the command to run.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommand

Document runCommand(String command,
                  DocumentAssignable options)
                    throws MongoDbException

Runs a command against the database.

Parameters:

command - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommand

Document runCommand(String commandName,
                  int commandValue,
                  DocumentAssignable options)
                    throws MongoDbException

Runs a command against the database.

Parameters:

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommand

Document runCommand(String commandName,
                  String commandValue,
                  DocumentAssignable options)
                    throws MongoDbException

Runs a command against the database.

Parameters:

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

void runCommandAsync(Callback<Document> reply,
                   DocumentAssignable command)
                     throws MongoDbException

Runs a command against the database.

Parameters:

reply - Callback that will be notified of the command results.

command - The command document to run.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

void runCommandAsync(Callback<Document> reply,
                   DocumentAssignable command,
                   Version requiredServerVersion)
                     throws MongoDbException

Runs a command against the database.

Parameters:

reply - Callback that will be notified of the command results.

command - The command document to run.

requiredServerVersion - The minimum required server version to support the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

void runCommandAsync(Callback<Document> reply,
                   String command)
                     throws MongoDbException

Runs a command against the database.

Parameters:

reply - Callback that will be notified of the command results.

command - The name of the command to run.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

void runCommandAsync(Callback<Document> reply,
                   String command,
                   DocumentAssignable options)
                     throws MongoDbException

Runs a command against the database.

Parameters:

reply - Callback that will be notified of the command results.

command - The name of the command to run.

options - Optional (may be null) options for the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

void runCommandAsync(Callback<Document> reply,
                   String commandName,
                   int commandValue,
                   DocumentAssignable options)
                     throws MongoDbException

Runs a command against the database.

Parameters:

reply - Callback that will be notified of the command results.

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

void runCommandAsync(Callback<Document> reply,
                   String commandName,
                   String commandValue,
                   DocumentAssignable options)
                     throws MongoDbException

Runs a command against the database.

Parameters:

reply - Callback that will be notified of the command results.

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

ListenableFuture<Document> runCommandAsync(DocumentAssignable command)
                                           throws MongoDbException

Runs a command against the database.

Parameters:

command - The command document to run.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

void runCommandAsync(LambdaCallback<Document> reply,
                   DocumentAssignable command)
                     throws MongoDbException

Runs a command against the database.

Parameters:

reply - LambdaCallback that will be notified of the command results.

command - The command document to run.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

void runCommandAsync(LambdaCallback<Document> reply,
                   DocumentAssignable command,
                   Version requiredServerVersion)
                     throws MongoDbException

Runs a command against the database.

Parameters:

reply - LambdaCallback that will be notified of the command results.

command - The command document to run.

requiredServerVersion - The minimum required server version to support the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

void runCommandAsync(LambdaCallback<Document> reply,
                   String command)
                     throws MongoDbException

Runs a command against the database.

Parameters:

reply - LambdaCallback that will be notified of the command results.

command - The name of the command to run.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

void runCommandAsync(LambdaCallback<Document> reply,
                   String command,
                   DocumentAssignable options)
                     throws MongoDbException

Runs a command against the database.

Parameters:

reply - LambdaCallback that will be notified of the command results.

command - The name of the command to run.

options - Optional (may be null) options for the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

void runCommandAsync(LambdaCallback<Document> reply,
                   String commandName,
                   int commandValue,
                   DocumentAssignable options)
                     throws MongoDbException

Runs a command against the database.

Parameters:

reply - LambdaCallback that will be notified of the command results.

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

void runCommandAsync(LambdaCallback<Document> reply,
                   String commandName,
                   String commandValue,
                   DocumentAssignable options)
                     throws MongoDbException

Runs a command against the database.

Parameters:

reply - LambdaCallback that will be notified of the command results.

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

ListenableFuture<Document> runCommandAsync(String command)
                                           throws MongoDbException

Runs a command against the database.

Parameters:

command - The name of the command to run.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

ListenableFuture<Document> runCommandAsync(String command,
                                         DocumentAssignable options)
                                           throws MongoDbException

Runs a command against the database.

Parameters:

command - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

ListenableFuture<Document> runCommandAsync(String commandName,
                                         int commandValue,
                                         DocumentAssignable options)
                                           throws MongoDbException

Runs a command against the database.

Parameters:

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

runCommandAsync

ListenableFuture<Document> runCommandAsync(String commandName,
                                         String commandValue,
                                         DocumentAssignable options)
                                           throws MongoDbException

Runs a command against the database.

Parameters:

commandName - The name of the command to run.

commandValue - The name of the command to run.

options - Optional (may be null) options for the command.

Returns:

The result of the command.

Throws:

MongoDbException - On an error issuing the command or in running the command

setDurability

void setDurability(Durability durability)

Sets the durability for write operations from this MongoDatabase instance.

Defaults to the Durability from the Mongo's configuration if set to null.

Parameters:

durability - The durability for write operations on the server.

See Also:

MongoClientConfiguration.getDefaultDurability()

setProfilingStatus

boolean setProfilingStatus(ProfilingStatus profileLevel)
                           throws MongoDbException

Sets the profiling level for the database.

Parameters:

profileLevel - The desired profiling level

Returns:

True if the profiling level was changed. Note if the level provided matches the profiling level already set then this method returns false.

Throws:

MongoDbException - On a failure to create the collection.

See Also:

profile Command Reference

setReadPreference

void setReadPreference(ReadPreference readPreference)

Sets the value of the read preference for a queries from this MongoDatabase instance.

Defaults to the ReadPreference from the Mongo's configuration if set to null.

Parameters:

readPreference - The read preference for a query.

See Also:

MongoClientConfiguration.getDefaultReadPreference()

stats

Document stats()
               throws MongoDbException

Returns the statistics for the database.

Returns:

The results document with the database statistics.

Throws:

MongoDbException - On an error collecting the database statistics.

See Also:

dbStats Command Reference