sails-db-migrate-generator

A sails-db-migrate-generator generator for use with the Sails command-line interface.

Easily create missing db-migrate migrations by one command. This module checks existing migration files and your model tree, and then automatically creates missing migrations in one file. Module uses async lib to process migrations properly in one file, one after one.

⚠️The result should be checked by a human being ⚠️

Installation

$ npm install sails-db-migrate-generator --save

Then merge the following into your .sailsrc file:

{
  "modules": {
    "migration": "sails-db-migrate-generator"
  }
}

Note that instead of "sails-db-migrate-generator", you can also choose to provide the path to the generator locally (e.g. "./generators/sails-db-migrate-generator"). This is useful if, for example, you have specific best practices for particular projects or teams within your organization, and you want to be able to check in generators to your code repository.

Certain generators are installed by default in Sails, but they can be overridden. Other generators add support for generating entirely new kinds of things. Check out Concepts > Extending Sails > Generators for information on installing generator overrides / custom generators and information on building your own generators.

Usage

$ sails generate migration migration-label --modelsPath="./models" --migrationsPath="./migrations"

• migration-label (optional), default: "migrations-generator-processed"
• migrationsPath (optional), default: "./migrations"
• modelsPath (optional), default: "./api/models"

Using for hooks

$ npm i -g sails-db-migrate-generator

Then you can call sails-migrate with parameters from usage. In this case parameter modelsPath will be ./models by default. You can also use parameters -h or --help to see short usage instruction and -v or --version to see the current version of the product.

Testing

$ npm run test

TODO

• skip creating intermediate table for one-to-many association

Need help?

See Extending Sails > Generators > Custom Generators in the Sails documentation, or check out recommended support options.

Bugs  

To report a bug, click here.

Contributing

Please observe the guidelines and conventions laid out in the Sails project contribution guide when opening issues or submitting pull requests.

License

This sails-db-migrate-generator generator is available under the MIT license.

The Sails framework is free and open-source under the MIT License.

Remember

Strictly follow Sails.js documentation when creating models and connections between them