io.toro.martini.database

Interface MongoDbDataSource

All Superinterfaces:

DataSource

public interface MongoDbDataSource
extends DataSource

Contains metadata of a MongoDB database

Method Summary

Modifier and Type	Method and Description
void	createCollection(String databaseName, String collectionName, CreateCollectionOptions createOptions) Creates a new collection or view.
void	dropCollection(String databaseName, String collectionName) Removes a collection or view from the database.
void	dropDatabase(String databaseName) Removes the database, deleting the associated data files.
MongoClient	getClient()
MongoDbDatabase	getConfig()
void	getSampleDocument(String databaseName, String collectionName, int sampleSize, OutputStream outputStream) Randomly select a specified number of documents from a collection.
MongoDbQueryResults	query(String databaseName, String collectionName, Pageable pageable, QueryConfiguration queryConfiguration) Execute a query against a MongoDB instance.

Methods inherited from interface io.toro.martini.database.DataSource

getDatabaseConnection, getJNDIObject, getStatus

Method Detail

getConfig

MongoDbDatabase getConfig()

Specified by:

getConfig in interface DataSource

Returns:

the configuration used to create this data source

getClient

MongoClient getClient()

Returns:

a client connection to one or more MongoDB servers

query

MongoDbQueryResults query(String databaseName,
                          String collectionName,
                          Pageable pageable,
                          QueryConfiguration queryConfiguration)

Execute a query against a MongoDB instance.

Parameters:

databaseName - the name of the MongoDB database where the collection to query belongs

collectionName - the name of the MongoDB collection to query

pageable - pagination settings

queryConfiguration - the query to execute

Returns:

query results

getSampleDocument

void getSampleDocument(String databaseName,
                       String collectionName,
                       int sampleSize,
                       OutputStream outputStream)
                throws IOException

Randomly select a specified number of documents from a collection.

Parameters:

databaseName - the name of the MongoDB database where the collection belongs

collectionName - the name of the MongoDB collection where documents will be retrieved from

sampleSize - the number of random documents to obtain

outputStream - where found documents will be written to

Throws:

IOException - if an I/O error occurs while writing to the OutputStream

dropDatabase

void dropDatabase(String databaseName)

Removes the database, deleting the associated data files.

Parameters:

databaseName - the name of the database to remove

createCollection

void createCollection(String databaseName,
                      String collectionName,
                      CreateCollectionOptions createOptions)

Creates a new collection or view. It creates the database if it doesn't exist.

Parameters:

databaseName - the name of the database to associate the collection from

collectionName - the name of the collection

createOptions - the options to create the collection

dropCollection

void dropCollection(String databaseName,
                    String collectionName)

Removes a collection or view from the database. The method also removes any indexes associated with the dropped collection.

Parameters:

databaseName - the name of the database that has the collection

collectionName - the name of the collection to remove