A command line Database migrations tool
Java JavaScript Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.


MYBATIS Migrations

Build Status Coverage Status Dependency Status Maven central License



MyBatis Migrations is a Java tool, so you must have Java installed in order to proceed. Users need at least the Java Runtime Environment (JRE), the Java Development Kit (JDK) is a plus.

See the reference documentation


Bundle Locations
Releases - https://oss.sonatype.org/content/repositories/releases/org/mybatis/mybatis-migrations
Snapshots - https://oss.sonatype.org/content/repositories/snapshots/org/mybatis/mybatis-migrations


  1. Unzip the distribution archive, i.e. mybatis-${project.version}-migrations.zip to the directory you wish to install MyBatis Migrations. These instructions assume you chose C:\Program Files\mybatis. The subdirectory mybatis-migrations-${project.version} will be created from the archive.
  2. Add the MIGRATIONS_HOME environment variable by opening up the system properties (WinKey + Pause), selecting the Advanced tab, and the Environment Variables button, then adding the MIGRATIONS_HOME variable in the user variables with the value C:\Program Files\mybatis\mybatis-migrations-${project.version}. Be sure to omit any quotation marks around the path even if it contains spaces.
  3. In the same dialog, add the MIGRATIONS environment variable in the user variables with the value %MIGRATIONS_HOME%\bin.
  4. In the same dialog, update/create the Path environment variable in the user variables and prepend the value %MIGRATIONS% to add MyBatis Migrations available in the command line.

Unix-based Operating Systems (Linux, Solaris and Mac OS X)

Download and extract migrations to any directory.

cd $HOME/opt
wget https://oss.sonatype.org/content/repositories/releases/org/mybatis/mybatis-migrations/3.3.1/mybatis-migrations-3.3.1-bundle.zip
unzip mybatis-migrations-3.3.1-bundle.zip

In your ~/.bashrc or ~/.zshrc or equivalent add

export MIGRATIONS=$HOME/opt/mybatis-migrations-3.3.1 # replace with path you extracted to

Quick setup

mkdir $HOME/my-migrations
cd $HOME/my-migrations
migrate init

After that read the ./drivers and ./environments section of Migrations init


Migrations is Apache Licensed