me.lucko.helper.mongo

Interface HelperMongo

All Superinterfaces:

AutoCloseable, Terminable

All Known Implementing Classes:

MongoWrapper

public interface HelperMongo
extends Terminable

Represents an individual Mongo datasource, created by the library.

Field Summary

Fields inherited from interface me.lucko.helper.terminable.Terminable

EMPTY

Method Summary

Modifier and Type	Method and Description
com.mongodb.MongoClient	getClient() Gets the client instance backing the datasource
com.mongodb.client.MongoDatabase	getDatabase() Gets the main database in use by the instance.
com.mongodb.client.MongoDatabase	getDatabase(String name) Gets a specific database instance
org.mongodb.morphia.Morphia	getMorphia() Gets the Morphia instance for this datasource
org.mongodb.morphia.Datastore	getMorphiaDatastore() Gets the main Morphia datastore in use by the instance
org.mongodb.morphia.Datastore	getMorphiaDatastore(String name) Gets a specific Morphia datastore instance
static HelperMongo	usingMongoDb(MongoDatabaseCredentials credentials)

Methods inherited from interface me.lucko.helper.terminable.Terminable

bindWith, close, hasTerminated, of, terminate

Method Detail

usingMongoDb

@Nonnull
static HelperMongo usingMongoDb(@Nonnull
                                          MongoDatabaseCredentials credentials)

getClient

@Nonnull
com.mongodb.MongoClient getClient()

Gets the client instance backing the datasource

Returns:

the client instance

getDatabase

@Nonnull
com.mongodb.client.MongoDatabase getDatabase()

Gets the main database in use by the instance.

Returns:

the main database

getDatabase

com.mongodb.client.MongoDatabase getDatabase(String name)

Gets a specific database instance

Parameters:

name - the name of the database

Returns:

the database

getMorphia

org.mongodb.morphia.Morphia getMorphia()

Gets the Morphia instance for this datasource

Returns:

the morphia instance

getMorphiaDatastore

org.mongodb.morphia.Datastore getMorphiaDatastore()

Gets the main Morphia datastore in use by the instance

Returns:

the main datastore

getMorphiaDatastore

org.mongodb.morphia.Datastore getMorphiaDatastore(String name)

Gets a specific Morphia datastore instance

Parameters:

name - the name of the database

Returns:

the datastore