migrations.module.md

module

The migrations module. Contains the Migrations class.

• module
  • ~Migrations
    • new Migrations()
    • .config : object
    • .schema : string
    • .moduleConfig : object
    • .sequelize : object
    • .dbComponents : Object.<string, object>
    • .seedingOrder : Array.<string>

module~Migrations

Kind: inner class of module

• ~Migrations
  • new Migrations()
  • .config : object
  • .schema : string
  • .moduleConfig : object
  • .sequelize : object
  • .dbComponents : Object.<string, object>
  • .seedingOrder : Array.<string>

new Migrations()

The Migrations class. It takes care of synchronizing the actual database tables with the current state of the code models, generating backups and inserting various sets of data. It also starts an api server, if configured, which can be used as an interface for running sync, generateSeed, generateBackup, seed and insertStaticData.

migrations.config : object

The project config object.

Kind: instance property of Migrations

migrations.schema : string

The project config object's db.schema property.

Kind: instance property of Migrations

migrations.moduleConfig : object

The project config object's migrations property.

Kind: instance property of Migrations

migrations.sequelize : object

A sequelize instance.

Kind: instance property of Migrations

migrations.dbComponents : Object.<string, object>

An object, containing the db components by name, taken from the db module's components property.

Kind: instance property of Migrations

migrations.seedingOrder : Array.<string>

An array of dbComponent names, in order of which tables will be inserted in the database.

Kind: instance property of Migrations