Making running down migrations in reverse run order the default (and only) option.

Author: Andrew Kerr

README.md

@@ -17,16 +17,17 @@ Database migration framework for node.js
 ```
 Usage: db-migrate [up|down|create] migrationName [options]
 
+Down migrations are run in reverse run order, so migrationName is ignored for down migrations.
+Use the --count option to control how many down migrations are run (default is 1).
+
 Options:
-  --env, -e               The environment to run the migrations under.    [default: "dev"]
-  --migrations-dir, -m    The directory containing your migration files.  [default: "./migrations"]
-  --count, -c             Max number of migrations to run.
-  --dry-run               Prints the SQL but doesn't run it.              [boolean]
-  --verbose, -v           Verbose mode.                                   [default: false]
-  --config                Location of the database.json file.             [default: "./database.json"]
-  --force-exit            Call system.exit() after migration run          [default: false]
-  --down-using-run-order  Run down migrations in reverse run order,       [default: false]
-                          rather than reverse creation order.
+  --env, -e             The environment to run the migrations under.    [default: "dev"]
+  --migrations-dir, -m  The directory containing your migration files.  [default: "./migrations"]
+  --count, -c           Max number of migrations to run.
+  --dry-run             Prints the SQL but doesn't run it.              [boolean]
+  --verbose, -v         Verbose mode.                                   [default: false]
+  --config              Location of the database.json file.             [default: "./database.json"]
+  --force-exit          Call system.exit() after migration run          [default: false]
 ```
 
 ## Creating Migrations

bin/db-migrate

@@ -20,7 +20,6 @@ var argv = optimist
     .default({
       verbose: false,
       "force-exit": false,
-      "down-using-run-order": false,
       config: process.cwd() + '/database.json',
       'migrations-dir': process.cwd() + '/migrations' })
     .usage('Usage: db-migrate [up|down|create] migrationName [options]')
@@ -43,9 +42,6 @@ var argv = optimist
     .describe('force-exit', 'Forcibly exit the migration process on completion.')
     .boolean('force-exit')
 
-    .describe('down-using-run-order', 'Run down migrations in reverse run order, rather than reverse creation order.')
-    .boolean('down-using-run-order')
-
     .describe('verbose', 'Verbose mode.')
     .alias('v', 'verbose')
     .boolean('v')
@@ -75,7 +71,6 @@ if (argv.help || argv._.length == 0) {
 
 global.verbose = argv.verbose;
 global.dryRun = argv['dry-run'];
-global.downUsingRunOrder = argv['down-using-run-order'];
 if(global.dryRun) {
   log.info('dry run');
 }
@@ -139,7 +134,8 @@ function executeUp() {
 }
 
 function executeDown() {
-  if(!argv.destination && !argv.count) {
+  if(!argv.count) {
+    log.info('Defaulting to running 1 down migration.');
     argv.count = 1;
   }
   index.connect(config.getCurrent().settings, function(err, migrator) {
@@ -170,20 +166,16 @@ function run() {
     case 'down':
       loadConfig();
       if(argv._.length > 0) {
-        if (global.downUsingRunOrder) {
-          log.info('Ignoring migration name since --down-using-run-order is set.');
+        if (action == 'down') {
+          log.info('Ignoring migration name for down migrations.  Use --count to control how many down migrations are run.');
+          argv.destination = null;
         } else {
           argv.destination = argv._.shift().toString();
         }
       }
       if(action == 'up') {
         executeUp();
       } else {
-        if(global.downUsingRunOrder) {
-          log.info('using run order for down migrations');
-        } else {
-          log.info('using creation order for down migrations');
-        }
         executeDown();
       }
       break;

lib/migration.js

@@ -134,10 +134,7 @@ Migration.loadFromFilesystem = function(dir, callback) {
 
 Migration.loadFromDatabase = function(dir, driver, callback) {
   log.verbose('loading migrations from database');
-  var query = 'SELECT * FROM migrations ORDER BY ';
-  query += global.downUsingRunOrder ? 'run_on DESC, name DESC' : 'name DESC';
-
-  driver.all(query, function(err, dbResults) {
+  driver.all('SELECT * FROM migrations ORDER BY run_on DESC, name DESC', function(err, dbResults) {
     if (err) { callback(err); return; }
     var migrations = dbResults.map(function(result) {
       return new Migration(path.join(dir, result.name));

lib/migrator.js

@@ -12,15 +12,6 @@ function isIncludedInUp(migration, destination) {
   return migrationTest <= destinationTest;
 }
 
-function isIncludedInDown(migration, destination) {
-  if(!destination) {
-    return true;
-  }
-  var migrationTest = migration.name.substring(0, Math.min(migration.name.length, destination.length));
-  var destinationTest = destination.substring(0, Math.min(migration.name.length, destination.length));
-  return migrationTest >= destinationTest;
-}
-
 function filterUp(allMigrations, completedMigrations, destination, count) {
   var sortFn = function(a, b) {
     return a.name.slice(0, a.name.indexOf('-')) - b.name.slice(0, b.name.indexOf('-'));
@@ -39,12 +30,8 @@ function filterUp(allMigrations, completedMigrations, destination, count) {
   .slice(0, count);
 }
 
-function filterDown(completedMigrations, destination, count) {
-  return completedMigrations
-  .filter(function(completedMigration) {
-    return isIncludedInDown(completedMigration, destination);
-  })
-  .slice(0, count);
+function filterDown(completedMigrations, count) {
+  return completedMigrations.slice(0, count);
 }
 
 
@@ -94,18 +81,10 @@ Migrator.prototype = {
     if (dbmUtil.isFunction(funcOrOpts)) {
       funcOrOpts(this.driver, callback);
     } else {
-      this.downToBy(funcOrOpts.destination, funcOrOpts.count, callback);
+      this.downToBy(funcOrOpts.count, callback);
     }
   },
 
-  upBy: function(count, callback) {
-    this.upToBy('99999999999999', count, callback);
-  },
-
-  upTo: function(partialName, callback) {
-    this.upToBy(partialName, Number.MAX_VALUE, callback);
-  },
-
   upToBy: function(partialName, count, callback) {
     var self = this;
     Migration.loadFromFilesystem(self.migrationsDir, function(err, allMigrations) {
@@ -134,20 +113,12 @@ Migrator.prototype = {
     });
   },
 
-  downBy: function(count, callback) {
-    this.downToBy('00000000000000', count, callback);
-  },
-
-  downTo: function(partialName, callback) {
-    this.downToBy(partialName, Number.MAX_VALUE, callback);
-  },
-
-  downToBy: function(partialName, count, callback) {
+  downToBy: function(count, callback) {
     var self = this;
     Migration.loadFromDatabase(self.migrationsDir, self.driver, function(err, completedMigrations) {
       if (err) { return callback(err); }
 
-      var toRun = filterDown(completedMigrations, partialName, count);
+      var toRun = filterDown(completedMigrations, count);
 
       if (toRun.length === 0) {
         log.info('No migrations to run');