grunt-deployments

Deploy (push/pull) MYSQL databases using Grunt

npm install grunt-deployments
5 downloads in the last week
72 downloads in the last month

Grunt (MYSQL) Database Deployments

Push/pull MYSQL databases from one location to another using Grunt. Designed to ease the pain of migrating databases from one environment (local) to another environment (remotes). Automatically updates hardcoded siteurl references and backs up source and target before any modificaitions are made.

IMPORTANT NOTE: the authors of this Plugin assume no responsibility for any actions which result from the usage of this script. You use it entirely at your own risk. It is strongly recommended that you test the script in a non-critical environment prior to rolling out for production use. Always manually backup your local and remote databases before using the script for the first time. No support can be provided for critical situations.

Getting Started

This plugin requires Grunt ~0.4.1

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-deployments --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-deployments');

Documentation

Overview

In your project's Gruntfile, add a section named deployments to the data object passed into grunt.initConfig().

The task expects a series of targets, one for each of the locations which you want to move the database to/from.

grunt.initConfig({
  deployments: {
    local: {

    },
    my_target_1: {

    },
    my_target_2: {

    },
    // etc
  }
});

IMPORTANT NOTE: The task is opinionated in that it assumes you are working on a local machine and pushing/pulling databases from/to that location. Thus it is imperative that you define a local target as part of your configuration.

Available Tasks

The Plugin makes two new tasks available via Grunt. These are db_pull and db_push. The interface for both commands is identical:

grunt db_pull --target="%%TARGET%%" // replace %%TARGET%% with the target you've defined in your config

There is a single argument --target that is required each time you run either command.

Task: db_push

The db_push command moves your local database to a remote database location. The following process is observed:

  1. Takes a dump of your local database
  2. Runs a search and replace on the local dump file
  3. Backups up the target database (remote)
  4. Imports the local dump into the target database

The target argument represents the remote target to which you wish to push your database.

grunt db_push --target="develop"

Task: db_pull

The db_pull command pulls a remote database into your local environment. The following process is observed:

  1. Takes a dump of the remote database
  2. Runs a search and replace on the dump file
  3. Backups up your local database
  4. Imports the remote dump into your local database

The target argument represents the remote target whose database you wish to pull into your local environment. Eg:

grunt db_pull --target="stage"

Usage

Local Target (required)

As above, the Plugin task is opinionated. It expects that you are working locally and pushing/pulling from/to that location.

As a result, it is essential that you define a single target without an ssh_host parameter. This is typically named "local" for convenience.

"local": {
  "title": "Local",
  "database": "local_db_name",
  "user": "local_db_username",
  "pass": "local_db_password",
  "host": "local_db_host",
  "url": "local_db_url"
  // note that the `local` target does not have an "ssh_host"
},

The task will assume that this target is equivilant to your local environment. You can call it anything you wish but it must not have an ssh_host parameter.

Other Environment Targets

All other targets must contain a valid ssh_host parameter.

"develop": {
  "title": "Development",
  "database": "development_db_name",
  "user": "development_db_username",
  "pass": "development_db_password",
  "host": "development_db_host",
  "url": "development_db_url",
  "ssh_host": "ssh_user@ssh_host"
},
"stage": {
  "title": "Stage",
  "database": "stage_db_name",
  "user": "stage_db_username",
  "pass": "stage_db_password",
  "host": "stage_db_host",
  "url": "stage_db_url",
  "ssh_host": "ssh_user@ssh_host"
},
"production": {
  "title": "Production",
  "database": "production_db_name",
  "user": "production_db_username",
  "pass": "production_db_password",
  "host": "production_db_host",
  "url": "production_db_url",
  "ssh_host": "ssh_user@ssh_host"
}

Full Usage Example

The structure below represents an typical usage example for the task configuration. Obviously you should replace the placeholders with your own database/environment configurations.

grunt.initConfig({
  deployments: {
    options: {
      // any should be defined options here
    },
    // "Local" target
    "local": {
      "title": "Local",
      "database": "local_db_name",
      "user": "local_db_username",
      "pass": "local_db_password",
      "host": "local_db_host",
      "url": "local_db_url"
      // note that the `local` target does not have an "ssh_host"
    },
    // "Remote" targets
    "develop": {
      "title": "Development",
      "database": "development_db_name",
      "user": "development_db_username",
      "pass": "development_db_password",
      "host": "development_db_host",
      "url": "development_db_url",
      "ssh_host": "ssh_user@ssh_host"
    },
    "stage": {
      "title": "Stage",
      "database": "stage_db_name",
      "user": "stage_db_username",
      "pass": "stage_db_password",
      "host": "stage_db_host",
      "url": "stage_db_url",
      "ssh_host": "ssh_user@ssh_host"
    },
    "production": {
      "title": "Production",
      "database": "production_db_name",
      "user": "production_db_username",
      "pass": "production_db_password",
      "host": "production_db_host",
      "url": "production_db_url",
      "ssh_host": "ssh_user@ssh_host"
    }
  },
})

Configuration

Each target expects a series of configuration options to be provided to enable the task to function correctly. These are detailed below:

title

Type: String Description: A proper case name for the target. Used to describe the target to humans in console output whilst the task is running.

database

Type: String Description: the name of the database for this target.

user

Type: String Description: the database user with permissions to access and modify the database

pass

Type: String Description: the password for the database user (above)

host

Type: String Description: the hostname for the location in which the database resides. Typically this will be localhost

url

Type: String Description: the string to search and replace within the database before it is moved to the target location. Typically this is designed for use with systems such as WordPress where the siteurl value is stored in the database and is required to be updated upon migration to a new environment. It is however suitable for replacing any single value within the database before it is moved.

ssh_host

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.

Options

options.backups_dir

Type: String Default value: backups

A string value that represents the directory path (relative to your Grunt file) to which you want your database backups for source and target to be saved prior to modifications.

You may wish to have your backups reside outside the current working directory of your Gruntfile. In which case simply provide the relative path eg: ../../backups.

options.target

Type: String Default value: ``

A string value that represents the default target for the tasks. You can easily override it using the --target option

Contributing

Contributions to this plugin are most welcome. This is very much a Alpha release and so if you find a problem please consider raising a pull request or creating a Issue which describes the problem you are having and proposes a solution.

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.

Release History

  • 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.
npm loves you