grunt-pg

grunt-pg

Grunt plugin to help with administering Postgres.

Installation

If you haven't used grunt before, be sure to check out the Getting Started guide.

From the same directory as your project's Gruntfile and package.json, install this plugin with the following command:

npm install --save-dev grunt-pg

Once that's done, add this line to your project's Gruntfile:

grunt.loadNpmTasks('grunt-pg');

If the plugin has been installed correctly, running grunt --help at the command line should list the newly-installed plugin's task or tasks. In addition, the plugin should be listed in package.json as a devDependency, which ensures that it will be installed whenever the npm install command is run.

Tasks

There are 5 tasks in grunt-pg: pgcreateuser, pgdropuser, pgcreatedb, pgowner and pgdropdb.

Each works similarly as the example below shows. The connection credentials must be a user who is privieleged enough to be able to perform these operations. For example, using the 'postgres' user to the 'template1' database should be sufficient.

Firstly, an example of using the pgcreate task:

grunt.initConfig({
  pgcreatedb: {
    project1: {
      // Target-specific file lists and/or options go here.
      name: 'project1', // will be created
      connection: {
        user: 'postgres',
        database: 'template1',
      },
    },
  },
})

The connection object can also specify anything that node-pg understands: user, database, password, port and host.

Each task also requires the following:

• pgcreateuser: user
• pgdropuser: user
• pgcreatedb: name
• pgdropdb: name
• pgowner: name, user

The "pgdrop" task

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

2013-01-16: 0.1.0 - 

Author

Andrew Chilton.

Licence

Copyright (c) 2013 Moneytribe. MIT.