sirius.db.mongo

Class Mongo

java.lang.Object

sirius.db.mongo.Mongo

All Implemented Interfaces:

sirius.kernel.di.std.Priorized, sirius.kernel.Startable, sirius.kernel.Stoppable

public class Mongo
extends Object
implements sirius.kernel.Startable, sirius.kernel.Stoppable

Provides a thin layer above Mongo DB with fluent APIs for CRUD operations.

Field Summary

Fields

Modifier and Type	Field and Description
protected sirius.kernel.health.Average	callDuration
static sirius.kernel.health.Log	LOG
protected boolean	temporaryDB
protected Map<String,sirius.kernel.commons.Tuple<String,String>>	traceData
protected int	traceLimit
protected boolean	tracing

Fields inherited from interface sirius.kernel.di.std.Priorized

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
Mongo()

Method Summary

Modifier and Type	Method and Description
com.mongodb.client.MongoDatabase	db() Provides direct access to the Mongo DB for non-trivial operations.
Deleter	delete() Returns a fluent query builder to delete one or more documents in the database
Finder	find() Returns a fluent query builder to find one or more documents in the database
int	getPriority()
protected void	initializeClient()
Inserter	insert() Returns a fluent query builder to insert a document into the database
boolean	isConfigured() Determines if access to Mongo DB is configured by checking if a host is given.
void	started()
void	stopped()
Updater	update() Returns a fluent query builder to update one or more documents in the database

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

public static final sirius.kernel.health.Log LOG

temporaryDB

protected boolean temporaryDB

tracing

protected volatile boolean tracing

traceLimit

protected volatile int traceLimit

traceData

protected Map<String,sirius.kernel.commons.Tuple<String,String>> traceData

callDuration

protected sirius.kernel.health.Average callDuration

Constructor Detail

Mongo

public Mongo()

Method Detail

isConfigured

public boolean isConfigured()

Determines if access to Mongo DB is configured by checking if a host is given.

Returns:

true if access to Mongo DB is configured, false otherwise

db

public com.mongodb.client.MongoDatabase db()

Provides direct access to the Mongo DB for non-trivial operations.

Returns:

an initialized client instance to access Mongo DB.

initializeClient

protected void initializeClient()

getPriority

public int getPriority()

Specified by:

getPriority in interface sirius.kernel.di.std.Priorized

Specified by:

getPriority in interface sirius.kernel.Startable

Specified by:

getPriority in interface sirius.kernel.Stoppable

started

public void started()

Specified by:

started in interface sirius.kernel.Startable

stopped

public void stopped()

Specified by:

stopped in interface sirius.kernel.Stoppable

insert

public Inserter insert()

Returns a fluent query builder to insert a document into the database

Returns:

a query builder to create an insert statement

find

public Finder find()

Returns a fluent query builder to find one or more documents in the database

Returns:

a query builder to create a find statement

update

public Updater update()

Returns a fluent query builder to update one or more documents in the database

Returns:

a query builder to create an update statement

delete

public Deleter delete()

Returns a fluent query builder to delete one or more documents in the database

Returns:

a query builder to create a delete statement