- NPM Downloads Last Month
This is a plugin for the Serverless framework that allows you to manage and run database-agnostic migrations. To do so, it works on top of migrate.
With this plugin you can
migrateavailable via the
SERVERLESS_ROOT_PATHwhich points to the root directory of your project.
Basically, these migrations can do anything that involves applying I/O changes and undo them. Watch the CHANGELOG to see what has been added to the date.
To get into details, check out the example project of this repository. It contains a README with an explanation about all the valid commands and configuration variables you can use. For starters, this is what you must do to start working right away with migrations:
serverless-migrate-pluginin your project:
npm i serverless-migrate-plugin
plugins: - serverless-migrate-plugin
sls migrate create -n <your-migration-name>
Now you are ready to implement your migrations. Once you have finished, you can run them using
sls migrate upand
sls migrate down. If you want to know more about any commands just run:
sls migrate <command> --help
It is also recommended that you understand how the migrate library works, like how to create migrations.
This project is licensed under the MIT License - see the LICENSE.md file for details.