mongo-migrate's Introduction

mongo-migrate

mongo-migrate Maven plugin provides goals to perform mongo DB migrations.

Pre-Alpha

I wanted to try my hand at writing maven plugin to support some of my various mongo hack-fun-projects. So, please note that mongo-migrate is incredibly raw and pre-alpha. Any and all feedback is welcome.

Installation

Commandline:

$ git clone https://github.com/wmluke/mongo-migrate.git
$ cd mongo-migrate
$ mvn install

Project POM:

<project>
    ...
    <dependencies>
        ...
        <dependency>
            <groupId>net.bunselmeyer</groupId>
            <artifactId>mongo-migrate</artifactId>
            <version>0.1-SNAPSHOT</version>
        </dependency>
        ...
    </dependencies>

    <build>
        <plugins>
            ...
            <plugin>
                <groupId>net.bunselmeyer</groupId>
                <artifactId>mongo-maven-plugin</artifactId>
                <version>0.1-SNAPSHOT</version>
                <configuration>
                    <!-- Package to find Migrations -->
                    <package>com.foo.migrations</package>
                </configuration>
            </plugin>
            ...
        </plugins>
    </build>
</project>

Java Usage

@Connection

host: (Optional) Mongo DB host. Defaults to "localhost"
db: Mongo database name.
version: Migration version as an ISO timestamp.

Migration

Abstract class used to define migrations.

Example

@Connection(db = "blog", version = "2012-09-11T00:14:00-0800")
public class RenameUserEmailFieldMigration extends Migration {

    @Override
    public void up(DB db) {
        renameField(db, "User", "emailAddress", "email");
    }

    @Override
    public void down(DB db) {
        renameField(db, "User", "email", "emailAddress");
    }
}

Maven Goals

mongo:migrate

Migrate a mongo DB upwards. This goal will create a collection called MigrationVersionDetails that contains...

{
    "_id": ObjectId( "505d6c18c2202768f668d4eb" ),
    "version" : 1347351240000,
    "migrationName" : "com.foo.migrations.RenameUserEmailFieldMigration",
    "run" : 1348299800474
}