MongoDB migration

• Gradle plugin
• Java and script migration
• Multi-document transaction (MongoDB 4.0+)

• Integration with Spring MongoTemplate
• Maven plugin
• Validate, info, clean command

Add gradle plugin, dependency and configuration in your build.gradle.

plugins {
    id 'io.github.oun.monjam' version '0.5.0'
}

repositories {
    mavenCentral()
}

dependencies {
    compile 'io.github.oun:monjam-core:0.5.0'
}

monjam {
    url = 'mongodb://localhost:27017/?replicaSet=rs0'
    database = 'monjam'
    collection = 'schema_migrations'
    location = 'db/migration'
}

See the code example for Spring-based application.

Annotated class with @MongoMigration annotation and each methods with @Migrate annotation. Method with annotation parameter type MIGRATE and ROLLBACK will be executed on running migrate and rollback command respectively.

package db.migration;

import com.monjam.core.annotation.Migrate;
import com.monjam.core.annotation.MongoMigration;
import com.monjam.core.api.Context;
import com.monjam.core.api.MigrationType;

@MongoMigration
public class UserMigration {
    @Migrate(type = MigrationType.MIGRATE, version = "1.0.0", description = "Change user prefix type")
    public void changeUserPrefixType(Context context) {
        // Execute on migrate version 1.0.0
    }

    @Migrate(type = MigrationType.ROLLBACK, version = "1.0.0", description = "Revert user prefix type")
    public void revertChangeUserPrefixType(Context context) {
        // Execute on rollback version 1.0.0
    }
}

Create java based migration class implementing Migration interface. The up and down method will be executed upon running migrate and rollback command respectively.

package db.migration;

import com.monjam.core.api.Context;
import com.monjam.core.api.Migration;

public class V1_0_0__Change_user_prefix_type implements Migration {
    @Override
    public void up(Context context) {
        // Execute on migrate
    }

    @Override
    public void down(Context context) {
        // Execute on rollback
    }
}

Create migrate script V1_0_0__Change_user_prefix_type.js

db.users.update({prefix: 'Mr.'}, {$set: {prefix: 1}}, {multi: true});
db.users.update({prefix: 'Mrs.'}, {$set: {prefix: 2}}, {multi: true});

Java class and script file must follow naming pattern {Prefix}{Version}__{Description}

• Prefix: V for migrate, U for rollback (applicable to script migration)
• Version: Sem-ver format separated each part with underscored
• Separator: Two underscores
• Description: Underscores separated words

./gradlew monjamMigrate

As each migration get applied, the schema migration history collection (default to schema_migrations) is updated with each document corresponding to applied migration

Configuration can be defined in build.gradle.

monjam {
    url = 'mongodb://localhost:27017/?replicaSet=rs0'
    database = 'monjam'
    collection = 'schema_migrations'
    location = 'db/migration'
}

or using gradle properties passed directly via command-line. ./gradlew monjamMigrate -Pmonjam.username=admin -Pmonjam.password=secret