npm install ship-hold-migration [--save|--save-dev]
const sh = require('ship-hold')(/* your connection options */);
const mig=require('ship-hold-migration');
mig(sh);
const migrator = sh.migrator();
migrator.up()
.then(function(){
return migrator.down();
});A migration file must contains up (executing a migration) and down (rolling back a migration) methods which return Promise; and a timestamp property referring to the creation date of the migration (so migration can be ordered) You can optionally add a name property otherwise it will use the file name (without the extension) as default
//myMigration.js
module.exports = {
name:'createUserTable',
timestamp:12312423423,
async up(sh){
//code to execute for the migration (sh is the shiphold instance)
return sh.query(`CREATE TABLE users(
id serial PRIMARY KEY,
name varchar(128)
);`);
},
async down(sh){
return sh.query(`DROP TABLE users`);
}
}Options to pass to the adapter factory
- modelName: the name of the model used to store meta data related to the migrations (default: migrations)
- tableName: the name of the table used to store meta data related to the migrations (default: shiphold_migrations)
- directory: the path to the directory containing the migrations file (default:'/migrations')
##api
Run all pending migrations; returns a Promise which resolve with successful migrations object (as an array)
rollback the last migration; returns a Promise which resolve with successful migrations object (as an array)
return a Promise which resolves with the names of the pending migrations (as an array):
return a Promise which resolves with the names of the already executed migrations (as an array):
return a Promise which resolves with the names of all migrations (as an array)
return a Promise which resolves with all the migrations objects (as an array)
Find or create the model related to migrations meta data. resolve a Promise with that model.