grunt-sql-bakery

sql-bakery

Bakes out json from sql

Getting Started

This plugin requires Grunt.

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-sql-bakery --save-dev

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

grunt.loadNpmTasks('grunt-sql-bakery');

The "sql_bakery" task

Overview

In your project's Gruntfile, add a section named sql_bakery to the data object passed into grunt.initConfig(). The connection object includes the connection information specific to your database. Here is an example of a MySQL connection:

grunt.initConfig({

  sql: grunt.file.readJSON('config/sql.json'),
  sql_bakery: {
    db: {
      options: {
        client: '<%= sql.client %>', // defaults to mysql
        tables: '<%= sql.tables %>',
        output_path: '<%= sql.output_path %>', // defaults to './data'
        charset: '<%= sql.charset %>', // defaults to 'utf8'
        connection: {
          host: '<%= sql.host %>',
          database: '<%= sql.db %>',
          user: '<%= sql.user %>',
          password: '<%= sql.pw %>',
        }
      }
    }
  },

})

To bake out your json files, run grunt sql_bakery.

Options

All of the options passed in will be pulled from the config/sql.json file, where your database credentials are stored. This config file should be included in your .gitignore so you don't publish your db credentials. There's an example of what this file should look like in the config folder called sql.json.example.

Contributing

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

(Nothing yet)

License

Copyright (c) 2015 Ashlyn Still. Licensed under the MIT license.