Template Plugins

A template plugin is a plugin that generates the contents of new migration files.

Did you know?

Many of the Loader Plugins usually include a template plugin as well. The template plugin is then responsible for generating migration files in a specific format and the loader is responsible for loading the same format.

Available Template Plugins

JavaScript template A built-in template plugin that can generate JavaScript or TypeScript migration files (in either ESM or CommonJS format)

PostgreSQL template A template plugin that can generate SQL, JavaScript or TypeScript migration files

MySQL template A template plugin that can generate SQL migration files

Note

You can also use the --template option to specify a custom template file for new migrations, instead of using a plugin.