com.mongodb.client

Interface MongoDatabase

@ThreadSafe
public interface MongoDatabase

The MongoDatabase interface.

Note: Additions to this interface will not be considered to break binary compatibility.

Since:

3.0

Method Summary

Methods

Modifier and Type	Method and Description
void	createCollection(String collectionName) Create a new collection with the given name.
void	createCollection(String collectionName, CreateCollectionOptions createCollectionOptions) Create a new collection with the selected options
void	dropDatabase() Drops this database.
Document	executeCommand(Object command) Executes command in the context of the current database.
<T> T	executeCommand(Object command, Class<T> clazz) Executes command in the context of the current database.
Document	executeCommand(Object command, ReadPreference readPreference) Executes command in the context of the current database.
<T> T	executeCommand(Object command, ReadPreference readPreference, Class<T> clazz) Executes command in the context of the current database.
CodecRegistry	getCodecRegistry() Get the codec registry for the MongoDatabase.
MongoCollection<Document>	getCollection(String collectionName) Gets a collection.
<T> MongoCollection<T>	getCollection(String collectionName, Class<T> clazz) Gets a collection, with a specific default document class.
String	getName() Gets the name of the database.
ReadPreference	getReadPreference() Get the read preference for the MongoDatabase.
WriteConcern	getWriteConcern() Get the write concern for the MongoDatabase.
MongoIterable<String>	listCollectionNames() Gets the names of all the collections in this database.
ListCollectionsFluent<Document>	listCollections() Finds all the collections in this database.
<C> ListCollectionsFluent<C>	listCollections(Class<C> clazz) Finds all the collections in this database.
MongoDatabase	withCodecRegistry(CodecRegistry codecRegistry) Create a new MongoDatabase instance with a different codec registry.
MongoDatabase	withReadPreference(ReadPreference readPreference) Create a new MongoDatabase instance with a different read preference.
MongoDatabase	withWriteConcern(WriteConcern writeConcern) Create a new MongoDatabase instance with a different write concern.

Method Detail

getName

String getName()

Gets the name of the database.

Returns:

the database name

getCodecRegistry

CodecRegistry getCodecRegistry()

Get the codec registry for the MongoDatabase.

Returns:

the CodecRegistry

getReadPreference

ReadPreference getReadPreference()

Get the read preference for the MongoDatabase.

Returns:

the ReadPreference

getWriteConcern

WriteConcern getWriteConcern()

Get the write concern for the MongoDatabase.

Returns:

the WriteConcern

withCodecRegistry

MongoDatabase withCodecRegistry(CodecRegistry codecRegistry)

Create a new MongoDatabase instance with a different codec registry.

Parameters:

codecRegistry - the new CodecRegistry for the database

Returns:

a new MongoCollection instance with the different codec registry

withReadPreference

MongoDatabase withReadPreference(ReadPreference readPreference)

Create a new MongoDatabase instance with a different read preference.

Parameters:

readPreference - the new ReadPreference for the database

Returns:

a new MongoDatabase instance with the different readPreference

withWriteConcern

MongoDatabase withWriteConcern(WriteConcern writeConcern)

Create a new MongoDatabase instance with a different write concern.

Parameters:

writeConcern - the new WriteConcern for the database

Returns:

a new MongoCollection instance with the different writeConcern

getCollection

MongoCollection<Document> getCollection(String collectionName)

Gets a collection.

Parameters:

collectionName - the name of the collection to return

Returns:

the collection

getCollection

<T> MongoCollection<T> getCollection(String collectionName,
                                   Class<T> clazz)

Gets a collection, with a specific default document class.

Type Parameters:

T - the type of the class to use instead of Document.

Parameters:

collectionName - the name of the collection to return

clazz - the default class to cast any documents returned from the database into.

Returns:

the collection

executeCommand

Document executeCommand(Object command)

Executes command in the context of the current database.

Parameters:

command - the command to be run

Returns:

the command result

executeCommand

Document executeCommand(Object command,
                      ReadPreference readPreference)

Executes command in the context of the current database.

Parameters:

command - the command to be run

readPreference - the ReadPreference to be used when executing the command

Returns:

the command result

executeCommand

<T> T executeCommand(Object command,
                   Class<T> clazz)

Executes command in the context of the current database.

Type Parameters:

T - the type of the class to use instead of Document.

Parameters:

command - the command to be run

clazz - the default class to cast any documents returned from the database into.

Returns:

the command result

executeCommand

<T> T executeCommand(Object command,
                   ReadPreference readPreference,
                   Class<T> clazz)

Executes command in the context of the current database.

Type Parameters:

T - the type of the class to use instead of Document.

Parameters:

command - the command to be run

readPreference - the ReadPreference to be used when executing the command

clazz - the default class to cast any documents returned from the database into.

Returns:

the command result

dropDatabase

void dropDatabase()

Drops this database.

MongoDB documentation

Drop database

listCollectionNames

MongoIterable<String> listCollectionNames()

Gets the names of all the collections in this database.

Returns:

an iterable containing all the names of all the collections in this database

listCollections

ListCollectionsFluent<Document> listCollections()

Finds all the collections in this database.

Returns:

the fluent list collections interface

MongoDB documentation

listCollections

listCollections

<C> ListCollectionsFluent<C> listCollections(Class<C> clazz)

Finds all the collections in this database.

Type Parameters:

C - the target document type of the iterable.

Parameters:

clazz - the class to decode each document into

Returns:

the fluent list collections interface

MongoDB documentation

listCollections

createCollection

void createCollection(String collectionName)

Create a new collection with the given name.

Parameters:

collectionName - the name for the new collection to create

MongoDB documentation

Create Command

createCollection

void createCollection(String collectionName,
                    CreateCollectionOptions createCollectionOptions)

Create a new collection with the selected options

Parameters:

collectionName - the name for the new collection to create

createCollectionOptions - various options for creating the collection

MongoDB documentation

Create Command