Ox - MongoDB Database Versioning and Migration Tool

Description

Schemaless doesn't mean no schema!

Control and migrate your MongoDB schema versions with ease, ensuring that indexes are created right and that your data is exactly as you expect.

MongoDB is a NoSQL, Document-based, database but it also need some data migration in some cases, specially when your application uses a multi-instance architecture and you must upgrade or change data in all your databases.

Feel free to contribute and ask changes to this project. Pull Requests are also welcome and will be approved quickly.

Ox is used since 2014 in production environments.

Motivation

When you have to manage a lot of MongoDB databases it may consume a lot of time when you need to keep your indexes and documents in the right version.

This project simplifies that.

Requirements

Compatible with Java 17+ and MongoDB 2.6 to 7.x.

Important

Ox requires a Mongo Client with PRIMARY read preference set. The primary read preference is required to avoid dirty reads when creating indexes and collections.

Docs

Check the Ox's documentation

You can also check the demo project here

Installation

Maven

<dependency>
  <groupId>com.github.fernandonogueira</groupId>
  <artifactId>ox</artifactId>
  <version>x.y.z</version>
</dependency>

<repositories>
  <repository>
    <id>jitpack.io</id>
    <url>https://jitpack.io</url>
  </repository>
</repositories>

Gradle

dependencies {
    implementation 'com.github.fernandonogueira:Ox:x.y.z'
}

dependencyResolutionManagement {
    repositoriesMode.set(RepositoriesMode.FAIL_ON_PROJECT_REPOS)
    repositories {
        mavenCentral()
        maven { url 'https://jitpack.io' }
    }
}

Usage

Creating migrations...

public class V0001__CreateIndexMigrationTest implements Migration {

    @Override
    public void up(MigrationEnvironment env) {

        OxAction
                .createIndex("myIndex")
                .setCollection("myCollection")
                .addAttribute("attr1", OrderType.ASC)
                .execute(env);

        OxAction
                .createIndex("myIndex")
                .setCollection("myCollection")
                .addAttribute("attr2", OrderType.DESC)
                .addAttribute("attr3", OrderType.ASC)
                .execute(env);

    }

    @Override
    public void down(MigrationEnvironment env) {
        ...
    }
}

Executing all migrations... :)

public void myMethod(){
   ...

   MongoClient mongo = new MongoClient("myDatabaseHost");
   Ox.setUp(mongo, "ox.db.migrates", "myDatabaseName").up();

   ...
}

Requirements

• Java 17
• Mongo Java Driver 3.x

LICENSE

MIT License

Copyright (c) 2018 Ox Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.