logologo
Get Started
Guide
Development
Plugins
API
English
简体中文
Get Started
Guide
Development
Plugins
API
English
简体中文
logologo
Migration Manager

#Migration Manager

#Introduction

The Migration Manager helps you transfer application configurations from one environment to another. Its main focus is on migrating “application configurations.” If you need a complete data migration, we recommend using the “Backup Manager” to back up and restore your entire application.

#Installation

The Migration Manager depends on the Backup Manager. Make sure that the Backup Manager plugin is already installed and activated.

#Process and Principles

The Migration Manager transfers tables and data from the primary database based on specified migration rules, moving them from one application instance to another. Note that it does not migrate data from external databases or sub-applications.

20250102202546

#Migration Rules

#Built-in Rules

Migration Manager can migrate all tables in the primary database and supports five built-in rules:

  1. Schema-only
    Only migrates the structure (schema) of tables—no data is inserted or updated.

  2. Overwrite (clear and re-insert)
    Deletes all existing records from the target database table, then inserts the new data.

  3. Upsert (Insert or update)
    Checks whether each record exists (by primary key). If it does, it updates that record; if not, it inserts it.

  4. Insert-ignore
    Inserts new records, but if a record already exists (by primary key), the insertion is ignored (no updates occur).

  5. Skip
    Skips processing for the table entirely (no structure changes, no data migration).

Additional notes:

  • "Overwrite," "Upsert," and "Insert-ignore" all synchronize table structure changes as well.
  • If a table uses an auto-increment ID as its primary key, or if it has no primary key, neither "Upsert" nor "Insert-ignore" can be applied.
  • "Upsert" and "Insert-ignore" rely on the primary key to determine whether the record already exists.

#Detailed Design

20250102204909

#Configuration Interface

Configure migration rules

20250102205450

Enable independent rules

20250107105005

Select independent rules and the tables to be processed by the current independent rules

20250107104644

#Migration Files

20250102205844

#Creating a New Migration

20250102205857

#Executing a Migration

20250102205915

Application environment variable check (learn more about Environment Variables)

20250102212311

If any are missing, a pop-up will prompt the user to enter the required new environment variables here, and then continue

20250102210009

#Migration Logs

20250102205738

#Rollback

Before any migration runs, the current application is automatically backed up. If the migration fails or the results are not as expected, you can roll back using the Backup Manager.

20250105195029