Simple integration of liquibase with grunt - specifically for postgresql (the postgresql jdbc driver is bundled as part of the module - if you want to add more support then feel free to fork)
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-liquibase --save-dev
The "liquibase" task
In your project's Gruntfile, add a section named
liquibase to the data object passed into
Dry Run Support
If running grunt with the
--no-write CLI flag, then no liquibase commands will be excuted. This is useful for performing a dry run to verify that the liquibase commands are being formed as you expect.
grunt liquibase:update --no-write --verbose
...Will excecute:updateCommand: java -jar /Users/grunt-liquibase/lib/liquibase.jar --classpath /Users/grunt-liquibase/lib/postgresql-9.3-1100.jdbc41.jar --driver org.postgresql.Driver --logLevel info --username test_username --password test_password --url jdbc:postgresql://DB_HOST:DB_PORT/DB_NAME --changeLogFile changelog.xml update>> no-write specified, not running command
NONE - required
Database user - passed into the
--username argument to liquibase.
NONE - required
Database password - passed into the
--password argument to liquibase.
NONE - required
JDBC url - passed into the
--url argument to liquibase.
Path to the changelog file for liquibase.
Path to the jar file containing the jdbc driver. The module contains this jar file so you don't need it if you are talking to a postgresql database. Passed into the
--classpath argument to liquibase.
JDBC driver class. Passed into the
--driver argument to liquibase.
Default schema name
Liquibase properties file path
Runs all changesets in the changeLogFile
Drops all database objects owned by the user. Note that functions, procedures and packages are not dropped
Rollback changesets in the changeLogFile to a specific tag. Must also supply the target tag as the commandAttr.
Rollback to version 0.0.1
Rollback up to N changesets in the changeLogFile. Must also supply the number of changesets to rollback in the commandAttr.
Rollback the last 3 changesets
"Tags" the current database state for future rollback. Must also supply the desired tag name in the commadAttr.
Tag the current DB with
Marks all changesets in the changeLogFile as run in the database. Useful when you are not starting from a empty database.
Outputs the SQL to mark all changesets in the changeLogFile as run in the database. This allows DBAs to validate the SQL and then run it manually against the necessary database.
Clears checksums so they can be recalculated in the next run.
In this example, the default options are used to update a postgresql database called test_db running on localhost at port 5432 using the user dbuser with password passwd with the contents of changelog.xml
In this example, the location of the changelog file is modified.
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.