Database Migration

Database schema migration, or database migration for short, is a process of updating the database schema in accordance with changes of your application data model.

Jmix uses Liquibase as a database migration tool.


Jmix Studio creates migration scripts in the Liquibase changelog format by comparing the current state of your JPA entities with the current database schema of the corresponding data store. It happens automatically when you start the application using a Run/Debug Configuration. The changelog is saved in the source code of the application and is built into the binary artifact.

When the application starts, it automatically runs Liquibase with the generated changelogs to update the connected database.

You can also create a changelog at any time using the Generate Diff Changelog action and execute it using the Update action on a data store in the Studio Jmix tool window.

Modules that your application depends on can also contain Liquibase changelog files. Changelogs from dependencies are executed on your database before the ones of the application.

Changelog Files Structure

Studio generates changelog files in the src/main/resources/<base_package>/liquibase directory of the application project. In this directory, Studio creates the changelog directory for the main data store, and <store>-changelog directories for additional data stores. Changelog files are created in subdirectories corresponding to the year and month of the current date. Name of each file includes a current day, a sequence number within the day, and a random character sequence to avoid conflicts if multiple developers work on the same project.

For each data store, there is a master changelog file located in the src/main/resources/<base_package>/liquibase directory. It contains a directive to include all generated changelog files under the changelog subdirectory. The master changelog file is passed to Liquibase when the application or Studio runs the database migration.

├── liquibase/ (1)
│   ├── changelog/ (2)
│   │   ├── 010-init-user.xml (3)
│   │   └── 2020/
│   │       ├── 11/
│   │       │   ├── 12-010-fe2b82e6.xml (4)
│   │       │   └── 27-010-fe2b82e6.xml
│   │       └── 12/
│   │           └── 17-010-fe2b82e6.xml
│   ├── changelog.xml (5)
│   ├── locations-changelog/ (6)
│   │   └── 2020/
│   │       └── 11/
│   │           ├── 25-010-fe2b82e6.xml
│   │           └── 28-010-fe2b82e6.xml
│   └── locations-changelog.xml (7)
1 The root of Liquibase changelog files structure.
2 Changelogs directory of the main data store.
3 Changelog file provided in the new project. It creates a table for the User entity.
4 Changelog files generated by Studio.
5 Master changelog file of the main data store.
6 Changelogs directory of the locations data store.
7 Master changelog file of the locations data store.

You can write Liquibase changelog files manually and put them into the structure described above. Liquibase executes included changelogs in the alphabetical order considering the whole path, so give your files appropriate names.

Configuring Liquibase

You can specify Liquibase properties for the main data store in in the same way as described in the Spring Boot documentation (see spring.liquibase.* properties), but replacing the spring.liquibase prefix with jmix.liquibase, for example:

jmix.liquibase.enabled = false
You cannot change the change-log property because it is always set to the master changelog by the framework.

If you want to externalize Liquibase properties of an additional data store, change its configuration as in the following example:

@ConfigurationProperties(prefix = "locations.liquibase")
public LiquibaseProperties locationsLiquibaseProperties() {
    return new LiquibaseProperties();

public SpringLiquibase locationsLiquibase(LiquibaseChangeLogProcessor processor) {
    return JmixLiquibaseCreator.create(locationsDataSource(),
            locationsLiquibaseProperties(), processor, "locations");

As a result, you will be able to set Liqubase properties of the locations data store in with the locations.liquibase prefix.