https://github.com/mybatis/migrations

A command line Database migrations tool
https://github.com/mybatis/migrations

java migration-tool

Last synced: 10 months ago
JSON representation

A command line Database migrations tool

• Host: GitHub
• URL: https://github.com/mybatis/migrations
• Owner: mybatis
• License: apache-2.0
• Created: 2013-02-10T11:15:02.000Z (almost 13 years ago)
• Default Branch: master
• Last Pushed: 2025-04-11T19:25:33.000Z (10 months ago)
• Last Synced: 2025-04-11T20:30:34.996Z (10 months ago)
• Topics: java, migration-tool
• Language: Java
• Homepage: http://mybatis.github.io/migrations
• Size: 4.79 MB
• Stars: 218
• Watchers: 21
• Forks: 78
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
MYBATIS Migrations

==================

[![build](https://github.com/mybatis/migrations/workflows/Java%20CI/badge.svg)](https://github.com/mybatis/migrations/actions?query=workflow%3A%22Java+CI%22)

[![Coverage Status](https://coveralls.io/repos/mybatis/migrations/badge.svg?branch=master&service=github)](https://coveralls.io/github/mybatis/migrations?branch=master)

[![Maven central](https://maven-badges.herokuapp.com/maven-central/org.mybatis/mybatis-migrations/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.mybatis/mybatis-migrations)

[![Docker pulls](https://img.shields.io/docker/pulls/mybatis/migrations.svg)](https://hub.docker.com/r/mybatis/migrations)

[![Sonatype Nexus (Snapshots)](https://img.shields.io/nexus/s/https/oss.sonatype.org/org.mybatis/mybatis-migrations.svg)](https://oss.sonatype.org/content/repositories/snapshots/org/mybatis/mybatis-migrations/)

[![License](https://img.shields.io/:license-apache-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)

![mybatis-migrations](https://mybatis.org/images/mybatis-logo.png)

## Requirements

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. 

MyBatis Migrations requires Java version 8 or later.

See the [reference documentation](https://mybatis.org/migrations)

## Installation

|Bundle Locations|

|------|

|[Releases - https://oss.sonatype.org/content/repositories/releases/org/mybatis/mybatis-migrations](https://oss.sonatype.org/content/repositories/releases/org/mybatis/mybatis-migrations/)|

|[Snapshots - https://oss.sonatype.org/content/repositories/snapshots/org/mybatis/mybatis-migrations](https://oss.sonatype.org/content/repositories/snapshots/org/mybatis/mybatis-migrations/)|

#### Windows

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.

1. 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.

1. In the same dialog, add the MIGRATIONS environment variable in the user variables with the

      value %MIGRATIONS_HOME%\bin.

1. 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.

```sh

cd $HOME/opt

wget https://oss.sonatype.org/content/repositories/releases/org/mybatis/mybatis-migrations/3.3.5/mybatis-migrations-3.3.5-bundle.zip

unzip mybatis-migrations-3.3.5-bundle.zip

```

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

```

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

export PATH=$MIGRATIONS/bin:$PATH

```

## Quick setup

```sh

mkdir $HOME/my-migrations

cd $HOME/my-migrations

migrate init

```

After that read the ./drivers and ./environments section of [Migrations init](https://mybatis.org/migrations/init.html)

## Docker

Docker users can use https://hub.docker.com/r/mybatis/migrations

## Package Manager ##

*Note*: These are not maintained by the MyBatis team and issues should be reported to the package maintainers.

### SDKMAN ###

[SDKMAN](https://sdkman.io) is a tool to manage multiple installations of JDKs and SDKs. MyBatis Migrations is available as a [candidate in SDKMAN](https://sdkman.io/sdks#mybatis). To install using SKDMAN

```sh

sdk install mybatis

# you can list the available versions

sdk ls mybatis

# install specific version

sdk install mybatis 3.3.5

```

## License

Migrations is [Apache Licensed](LICENSE)