Loader Plugins

Loader plugins are used to transform any file type into a JavaScript function that will be called when the migration file is executed.

Out of the box, Emigrate supports the following file extensions: .js, .cjs, .mjs, .ts, .cts and .mts. And both CommonJS and ES Modules are supported. See the Default Loader for more information.

Using a loader plugin

You can specify a loader plugin via the --plugin (or -p for short) option:

npx emigrate up --plugin mysql

Or set it up in your configuration file, see Plugin configuration for more information.

Did you know?

You can specify multiple loader plugins at the same time, which is needed when you mix file types in your migrations folder. For example, you can use the postgres or mysql loader for .sql files and a yaml loader for .yml files. The default loader will be used for all other file types, and doesn’t need to be specified.

Available Loader Plugins

Default Loader The loader responsible for loading .js, .cjs, .mjs, .ts, .cts and .mts files

PostgreSQL Loader Can load and execute .sql files against a PostgreSQL database

MySQL Loader Can load and execute .sql files against a MySQL database