Skip to content

Latest commit

 

History

History
138 lines (112 loc) · 4.35 KB

README.md

File metadata and controls

138 lines (112 loc) · 4.35 KB

Migration Master

Migration Master - is a tool for managing database migrations.

Table of Contents

Get Started

Clone source code or download jar file from here: https://drive.google.com/drive/folders/1cvns1Oh32IDYkP2e7Ao01braNKxW5C6M?usp=sharing

when download jar file:

  1. Add migration.jar to your project dependencies

  2. Don't forget to add environment variables like this key:

       MIGRATION_DATABASE_URL
   MIGRATION_DATABASE_NAME
   MIGRATION_DATABASE_PASSWORD

  3. Create application.properties in your resources:

    migration.database.driver=org.postgresql.Driver
migration.database.rollbackAll=true
migration.database.retryTime=1000
migration.database.rateLimiter=3

  4. If you want to start migrations from console:

    1. Add to your MainClass class MigrationClient.read(args)
    import org.example.command.*;
public class MainClass {
   public static void main(String[] args) {
       MigrationClient.read(args);
   }
}
    1. execute this command in your build project:
    java -jar -cp yourProject.jar com.example.MainClass migrate/rollback/status

  5. if your need to start migrations from your own, try this:

    import org.example.command.*;
public class Main {
   public static void main(String[] args) {
        MasterMigration.migrate("your path to changelog folder");
   }
}

Feature

This simple migrations tool has some features that directed to your best migrations experience. At first you can use CLI, carried out using this:

  import org.example.command.*;
  public class Main {
     public static void main(String[] args) {
         MigrationClient.read(args);
     }
  }

After building your jar file, in terminal use this command:

To start migration

 migrate

To check status and import result in json:

 status

To rollback migrations records:

 rollback

In other hand, you can realize optimistic or pessimistic lock by adding this property in application.properties:

migration.database.rollbackAll=true

If you do this, then if at least one migration is unsuccessful, then all are rolled back. In this case, throughout the entire migration process, one user takes over the database To avoid blocking the entire database and rolling back even successful ones, try this:

 migration.database.rollbackAll=false

To prevent other applications from constantly requesting access to the database and to avoid downtime, try playing with these values ​​(default limiter=0, and retryTime=3000 (3 seconds)

   migration.database.retryTime=1000
   migration.database.rateLimiter=3

Currently the tool supports the following databases: PostgresSQL, MySQL. To indicate the database driver use this property:

  migration.database.driver=org.postgresql.Driver

or

  migration.database.driver=com.mysql.cj.jdbc.Driver

You don't need to specify the location of application.properties. This tool will do it for you.

How to use

Create a "сhangelogs" folder in your resources. This is where you can put your migration scripts. The library will apply migrations defined as SQL files The user must be able to control the sequence of migrations by using the correct naming:

 V1__name.sql

Through proper naming, the library is able to understand the current version of the database and maintain a history of migrations. This is also used for reporting purposes.

You can get the report like this:

  MasterMigration.status()

To delete migration records after a unsuccessful migration, use this

  MasterMigration.rollback()

Attention! Any changelog changes are analyzed by the library. Otherwise there will be exceptions. Attention! The contents of migration files must not be changed under any circumstances. Even if the migration was unsuccessful, just create a new migration file and add it to the changelog folder. The contents of the files are recorded by a checksum, which is checked when migrations are called.

Contact

For suggestions and comments сontact me:

e.shostak05@gmail.com