How to auto generate migrations with Sequelize CLI from Sequelize models

Question

I have a set of Sequelize models  I want to use migrations  not DB Sync   Sequelize CLI seems to be able to do this  according to this article   When you use the CLI for the model generation  you will gain the migration scripts for free as well    How to auto generate the migrations with Sequelize CLI from existing Sequelize models

User · Answer

While it doesn t auto generate  one way to generate new migrations on a change to a model is   assuming that you re using the stock sequelize-cli file structure where migrations  and models are on the same level      Same as Manuel Bieh s suggestion  but using a require instead of an import  In your migration file  if you don t have one  you can generate one by doing  sequelize migration create   have the following code    use strict   var models   require     models index js   module exports       up  function queryInterface  Sequelize        return queryInterface createTable models User tableName         models User attributes          down  function queryInterface  Sequelize        return queryInterface dropTable  Users            Make a change to the User model  Delete table from database  Undo all migrations  sequelize db migrate undo all Re-migrate to have changes saved in db  sequelize db migrate

User · Answer

If you want to create model along with migration use this command -  sequelize model create --name regions --attributes name string status boolean --underscored   --underscored it is used to create column having underscore like - created at updated at or any other column having underscore and support user defined columns having underscore

User · Answer

Another solution is to put data definition into a separate file   The idea is to write data common for both model and migration into a separate file  then require it in both the migration and the model  Then in the model we can add validations  while the migration is already good to go   In order to not clutter this post with tons of code i wrote a GitHub gist   See it here  https   gist github com igorvolnyi f7989fc64006941a7d7a1a9d5e61be47

User · Answer

I created a small working  migration file generator   It creates files which are working perfectly fine using sequelize db migrate - even with foreign keys   You can find it here  https   gist github com manuelbieh ae3b028286db10770c81  I tested it in an application with 12 different models covering     STRING  TEXT  ENUM  INTEGER  BOOLEAN  FLOAT as DataTypes Foreign key constraints  even reciprocal  user belongsTo team  team belongsTo user as owner   Indexes with name  method and unique properties

User · Answer

I have recently tried the following approach which seems to work fine  although I am not 100  sure if there might be any side effects    use strict    import   as models from        models    module exports        up  function  queryInterface  Sequelize         return queryInterface createTable models Role tableName  models Role attributes       then      gt  queryInterface createTable models Team tableName  models Team attributes        then      gt  queryInterface createTable models User tableName  models User attributes            down  function  queryInterface  Sequelize                      When running the migration above using sequelize db migrate  my console says   Starting  db migrate     Finished  db migrate  after 91 ms    20160113121833-create-tables  migrating            20160113121833-create-tables  migrated  0 518s    All the tables are there  everything  at least seems to  work as expected  Even all the associations are there if they are defined correctly

User · Answer

It s 2020 and many of these answers no longer apply to the Sequelize v4 v5 v6 ecosystem  The one good answer says to use sequelize-auto-migrations  but probably is not prescriptive enough to use in your project  So here s a bit more color    Setup My team uses a fork of sequelize-auto-migrations because the original repo is has not been merged a few critical PRs   56  57  58  59   yarn add github scimonster sequelize-auto-migrations a063aa6535a3f580623581bf866cef2d609531ba  Edit package json   quot scripts quot              quot db makemigrations quot    quot   node modules sequelize-auto-migrations bin makemigration js quot            Process Note  Make sure you   re using git  or some source control  and database backups so that you can undo these changes if something goes really bad   Delete all old migrations if any exist  Turn off  sync   Create a mega-migration that migrates everything in your current models  yarn db makemigrations --name  quot mega-migration quot    Commit your 01-mega-migration js and the  current json that is generated  if you ve previously run  sync   or hand-written migrations  you need to    Fake    that mega-migration by inserting the name of it into your SequelizeMeta  table  INSERT INTO SequelizeMeta Values   01-mega-migration js    Now you should be able to use this as normal    Make changes to your models  add remove columns  change constraints  Run   yarn db makemigrations --name whatever Commit your 02-whatever js migration and the changes to  current json  and  current bak json  Run your migration through the normal sequelize-cli    yarn sequelize db migrate  Repeat 7-10 as necessary  Known Gotchas  Renaming a column will turn into a pair of removeColumn and addColumn  This will lose data in production  You will need to modify the up and down actions to use renameColumn instead    For those who confused how to use renameColumn  the snippet would look like this   switch  quot column name before quot  and  quot column name after quot  for the rollbackCommands         fn   quot renameColumn quot       params             quot table name quot            quot column name before quot            quot column name after quot                         transaction  transaction                     If you have a lot of migrations  the down action may not perfectly remove items in an order consistent way   The maintainer of this library does not actively check it  So if it doesn t work for you out of the box  you will need to find a different community fork or another solution

User · Answer

You cannot create migration scripts for existing models    Resources    Tutorial video on migrations    If going the classic way  you ll have to recreate the models via the CLI   sequelize model create --name MyUser --attributes first name string last name string bio text   It will generate these files   models myuser js    x000D   x000D   use strict   x000D  module exports   function sequelize  DataTypes    x000D    var MyUser   sequelize define  MyUser     x000D      first name  DataTypes STRING  x000D      last name  DataTypes STRING  x000D      bio  DataTypes TEXT x000D         x000D      classMethods    x000D        associate  function models    x000D             associations can be defined here x000D          x000D        x000D        x000D    return MyUser  x000D     x000D   x000D   x000D    migrations 20150210104840-create-my-user js    x000D   x000D   use strict   x000D  module exports     x000D    up  function migration  DataTypes  done    x000D      migration createTable  MyUsers     x000D        id    x000D          allowNull  false  x000D          autoIncrement  true  x000D          primaryKey  true  x000D          type  DataTypes INTEGER x000D           x000D        first name    x000D          type  DataTypes STRING x000D           x000D        last name    x000D          type  DataTypes STRING x000D           x000D        bio    x000D          type  DataTypes TEXT x000D           x000D        createdAt    x000D          allowNull  false  x000D          type  DataTypes DATE x000D           x000D        updatedAt    x000D          allowNull  false  x000D          type  DataTypes DATE x000D          x000D         done done   x000D       x000D    down  function migration  DataTypes  done    x000D      migration dropTable  MyUsers   done done   x000D      x000D     x000D   x000D   x000D

User · Answer

You can now use the npm package sequelize-auto-migrations to automatically generate a migrations file  https   www npmjs com package sequelize-auto-migrations  Using sequelize-cli  initialize your project with  sequelize init   Create your models and put them in your models folder   Install sequelize-auto-migrations   npm install sequelize-auto-migrations   Create an initial migration file with  node   node modules sequelize-auto-migrations bin makemigration --name  lt initial migration name gt    Run your migration   node   node modules sequelize-auto-migrations bin runmigration   You can also automatically generate your models from an existing database  but that is beyond the scope of the question

User · Answer

If you don t want to recreate your model from scratch  you can manually generate a migration file using the following CLI command    sequelize migration generate --name  name of your migration   This will generate a blank skeleton migration file  While it doesn t copy your model structure over to the file  I do find it easier and cleaner than regenerating everything  Note  make sure to run the command from the containing directory of your migrations directory  otherwise the CLI will generate a new migration dir for you

User · Answer

As of 16 9 2020 most of these answers are not too much consistent any way  Try this new npm package Sequelize-mig  It completed most known problems in sequelize-auto-migrations and its forks and its maintained and documented  Its used in a way similar to the known one Install  npm install sequelize-mig -g   yarn global add sequelize-mig  then use it like this sequelize-mig migration make -n  lt migration name gt

[mysql] How to auto generate migrations with Sequelize CLI from Sequelize models?

Examples related to mysql

Examples related to node.js

Examples related to orm

Examples related to sequelize.js