Serverless Migrate Plugin

homepage icon https://github.com/EliuX/serverless-migrate-plugin
Follow @EliuX

Tracked

NPM Downloads Last Month
386
Issues
0
Stars
0
Forks
0
Watchers
0
Watch Star Fork Issue Download License NPM Build Status Coverage Status Contributors

Repo README Contents:

Serverless plugin for migrate

serverless npm version

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.

Features

With this plugin you can

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.

Quick start

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:

  1. Install serverless-migrate-plugin in your project:
npm i serverless-migrate-plugin
  1. Add it to your serverless.yml to the plugins section:
plugins: 
  - serverless-migrate-plugin
  1. Create your first migration:
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.

Built With

Author

License

This project is licensed under the MIT License - see the LICENSE.md file for details.