com.github.mongobee

Class Mongobee

java.lang.Object

com.github.mongobee.Mongobee

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean

public class Mongobee
extends Object
implements org.springframework.beans.factory.InitializingBean

Mongobee runner

Since:

26/07/2014

Author:

lstolowski

Constructor Summary

Constructors

Constructor and Description
Mongobee() Simple constructor with default configuration of host (localhost) and port (27017).
Mongobee(com.mongodb.Mongo mongo) Constructor takes db.mongodb.Mongo object as a parameter.
Mongobee(com.mongodb.MongoClientURI mongoClientURI) Constructor takes db.mongodb.MongoClientURI object as a parameter.
Mongobee(String mongoURI) Mongobee runner.

Method Summary

Modifier and Type	Method and Description
void	afterPropertiesSet() For Spring users: executing mongobee after bean is created in the Spring context
void	execute() Executing migration
boolean	isEnabled()
Mongobee	setChangeLogsScanPackage(String changeLogsScanPackage) Package name where @ChangeLog-annotated classes are kept.
Mongobee	setDbName(String dbName) Used DB name should be set here or via MongoDB URI (in a constructor)
Mongobee	setEnabled(boolean enabled) Feature which enables/disables Mongobee runner execution
Mongobee	setMongoClientURI(com.mongodb.MongoClientURI mongoClientURI) Sets uri to MongoDB
Mongobee	setSpringEnvironment(org.springframework.core.env.Environment environment) Set Environment object for Spring Profiles (@Profile) integration

Methods inherited from class java.lang.Object

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

Constructor Detail

Mongobee

public Mongobee()

Simple constructor with default configuration of host (localhost) and port (27017). Although the database name need to be provided using setDbName(String) setter.

It is recommended to use constructors with MongoURI

Mongobee

public Mongobee(com.mongodb.MongoClientURI mongoClientURI)

Constructor takes db.mongodb.MongoClientURI object as a parameter.

For more details about MongoClientURI please see com.mongodb.MongoClientURI docs

Parameters:

mongoClientURI - uri to your db

See Also:

MongoClientURI

Mongobee

public Mongobee(com.mongodb.Mongo mongo)

Constructor takes db.mongodb.Mongo object as a parameter.

For more details about Mongo please see com.mongodb.Mongo docs

Parameters:

mongo - database connection

See Also:

Mongo

Mongobee

public Mongobee(String mongoURI)

Mongobee runner. Correct MongoDB URI should be provided.

The format of the URI is:

   mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database[.collection]][?options]]
 

• mongodb:// Required prefix
• username:password@ are optional. If given, the driver will attempt to login to a database after connecting to a database server. For some authentication mechanisms, only the username is specified and the password is not, in which case the ":" after the username is left off as well.
• host1 Required. It identifies a server address to connect to. More than one host can be provided.
• :portX is optional and defaults to :27017 if not provided.
• /database the name of the database to login to and thus is only relevant if the username:password@ syntax is used. If not specified the "admin" database will be used by default. Mongobee will operate on the database provided here or on the database overriden by setter setDbName(String).
• ?options are connection options. For list of options please see com.mongodb.MongoClientURI docs

For details, please see com.mongodb.MongoClientURI

Parameters:

mongoURI - with correct format

See Also:

MongoClientURI

Method Detail

afterPropertiesSet

public void afterPropertiesSet()
                        throws Exception

For Spring users: executing mongobee after bean is created in the Spring context

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

Throws:

Exception - exception

execute

public void execute()
             throws MongobeeException

Executing migration

Throws:

MongobeeException - exception

setDbName

public Mongobee setDbName(String dbName)

Used DB name should be set here or via MongoDB URI (in a constructor)

Parameters:

dbName - database name

Returns:

Mongobee object for fluent interface

setMongoClientURI

public Mongobee setMongoClientURI(com.mongodb.MongoClientURI mongoClientURI)

Sets uri to MongoDB

Parameters:

mongoClientURI - object with defined mongo uri

Returns:

Mongobee object for fluent interface

setChangeLogsScanPackage

public Mongobee setChangeLogsScanPackage(String changeLogsScanPackage)

Package name where @ChangeLog-annotated classes are kept.

Parameters:

changeLogsScanPackage - package where your changelogs are

Returns:

Mongobee object for fluent interface

isEnabled

public boolean isEnabled()

Returns:

true if Mongobee runner is enabled and able to run, otherwise false

setEnabled

public Mongobee setEnabled(boolean enabled)

Feature which enables/disables Mongobee runner execution

Parameters:

enabled - MOngobee will run only if this option is set to true

Returns:

Mongobee object for fluent interface

setSpringEnvironment

public Mongobee setSpringEnvironment(org.springframework.core.env.Environment environment)

Set Environment object for Spring Profiles (@Profile) integration

Parameters:

environment - org.springframework.core.env.Environment object to inject

Returns:

Mongobee object for fluent interface