Merged ignoreTables and MYSQL port options

Author: getdave

README.md

@@ -95,7 +95,8 @@ As a result, it is essential that you define a *single* target *without* an `ssh
   "user": "local_db_username",
   "pass": "local_db_password",
   "host": "local_db_host",
-  "url": "local_db_url"
+  "url": "local_db_url",
+  "ignoreTables": ["table1","table2",...]
   // note that the `local` target does not have an "ssh_host"
 },
 ```
@@ -113,7 +114,8 @@ All other targets *must* contain a valid `ssh_host` parameter.
   "pass": "development_db_password",
   "host": "development_db_host",
   "url": "development_db_url",
-  "ssh_host": "ssh_user@ssh_host"
+  "ssh_host": "ssh_user@ssh_host",
+  "ignoreTables": ["table1","table2",...]
 },
 "stage": {
   "title": "Stage",
@@ -122,7 +124,8 @@ All other targets *must* contain a valid `ssh_host` parameter.
   "pass": "stage_db_password",
   "host": "stage_db_host",
   "url": "stage_db_url",
-  "ssh_host": "ssh_user@ssh_host"
+  "ssh_host": "ssh_user@ssh_host",
+  "ignoreTables": ["table1","table2",...]
 },
 "production": {
   "title": "Production",
@@ -131,7 +134,8 @@ All other targets *must* contain a valid `ssh_host` parameter.
   "pass": "production_db_password",
   "host": "production_db_host",
   "url": "production_db_url",
-  "ssh_host": "ssh_user@ssh_host"
+  "ssh_host": "ssh_user@ssh_host",
+  "ignoreTables": ["table1","table2",...]
 }
 ```
 
@@ -152,7 +156,8 @@ grunt.initConfig({
       "user": "local_db_username",
       "pass": "local_db_password",
       "host": "local_db_host",
-      "url": "local_db_url"
+      "url": "local_db_url",
+      "ignoreTables": ["table1","table2",...]
       // note that the `local` target does not have an "ssh_host"
     },
     // "Remote" targets
@@ -163,7 +168,8 @@ grunt.initConfig({
       "pass": "development_db_password",
       "host": "development_db_host",
       "url": "development_db_url",
-      "ssh_host": "ssh_user@ssh_host"
+      "ssh_host": "ssh_user@ssh_host",
+      "ignoreTables": ["table1","table2",...]
     },
     "stage": {
       "title": "Stage",
@@ -172,7 +178,8 @@ grunt.initConfig({
       "pass": "stage_db_password",
       "host": "stage_db_host",
       "url": "stage_db_url",
-      "ssh_host": "ssh_user@ssh_host"
+      "ssh_host": "ssh_user@ssh_host",
+      "ignoreTables": ["table1","table2",...]
     },
     "production": {
       "title": "Production",
@@ -181,7 +188,8 @@ grunt.initConfig({
       "pass": "production_db_password",
       "host": "production_db_host",
       "url": "production_db_url",
-      "ssh_host": "ssh_user@ssh_host"
+      "ssh_host": "ssh_user@ssh_host",
+      "ignoreTables": ["table1","table2",...]
     }
   },
 })
@@ -223,6 +231,10 @@ Description: the string to search and replace within the database before it is m
 Type: `String`
 Description: ssh connection string in the format `SSH_USER@SSH_HOST`. The task assumes you have ssh keys setup which allow you to remote into your server without requiring the input of a password. As this is an exhaustive topic we will not cover it here but you might like to start by reading [Github's own advice](https://help.github.com/articles/generating-ssh-keys).
 
+#### ignoreTables
+Type: `Array of Strings`
+Description: tables to ignore. They won't be in the dump — neither their structure nor their content.
+
 ### Options
 
 #### options.backups_dir
@@ -248,6 +260,7 @@ In lieu of a formal styleguide, take care to maintain the existing coding style.
 
 ## Release History
 
+* 2013-12-09   v0.3.0   Added `ignoreTables` option.
 * 2013-11-12   v0.2.0   Fix escaping issues, ability to define `target` via options, README doc fixes, pass host param to mysqldump.
 * 2013-06-11   v0.1.0   Minor updates to docs including addtion of Release History section.
 * 2013-06-11   v0.0.1   Initial Plugin release.

tasks/deployments.js

@@ -181,6 +181,10 @@ module.exports = function(grunt) {
 
         grunt.file.mkdir(output_paths.dir);
 
+        // 1) Get array of tables to ignore, as defined in the config, and format it correctly
+        if( config.ignoreTables ) {
+            var ignoreTables = '--ignore-table=' + config.database + "." + config.ignoreTables.join(' --ignore-table='+config.database+'.');
+        }        
 
         // 2) Compile MYSQL cmd via Lo-Dash template string
         var tpl_mysqldump = grunt.template.process(tpls.mysqldump, {
@@ -189,12 +193,13 @@ module.exports = function(grunt) {
                 pass: config.pass,
                 database: config.database,
                 host: config.host,
-                port: config.port || 3306
+                port: config.port || 3306,
+                ignoreTables: ignoreTables || ''
             }
         });
 
-
         // 3) Test whether MYSQL DB is local or whether requires remote access via SSH
+
         if (typeof config.ssh_host === "undefined") { // it's a local connection
             grunt.log.writeln("Creating DUMP of local database");
             cmd = tpl_mysqldump;
@@ -251,7 +256,9 @@ module.exports = function(grunt) {
 
         search_replace: "sed -i '' 's#<%= search %>#<%= replace %>#g' <%= path %>",
 
-        mysqldump: "mysqldump -h <%= host %> -u<%= user %> -p<%= pass %> -P<%= port %> <%= database %>",
+
+        mysqldump: "mysqldump -h <%= host %> -u<%= user %> -p<%= pass %> -P<%= port %> <%= database %> <%= ignoreTables %>",
+
 
         mysql: "mysql -h <%= host %> -u <%= user %> -p<%= pass %> -P<%= port %> <%= database %>",