schlepper

Raw SQL Postgres migrations for node.

schlepper is a CLI tool to generate, execute and rollback Postgres migrations written in raw SQL.

Table of Contents

• Install
• Usage
• Background
• Contribute
• License

Install

Add schlepper to the development dependencies of your project:

npm install --save-dev schlepper

Or make the binary globally excessible by running:

npm install -g schlepper

Usage

If you installed schlepper globally you can just run:

$ schlepper

in the terminal of your choice and you should a help message printed to the screen.

If you instead just installed it as a dependencie you will either have to execute schlepper like so:

$ $(npm bin)/schlepper

or you could add a node script for schlepper to make it accessible through npm run <script_name>.

Setting up a new project

First of all you have to configure the postgres connection so schlepper can connect to your database. The best way of doing this is by creating a file named schlepper.json at your projects root containing something like this:

{
  "dbConfig": {
    "database": "my_project"
  }
}

For a detailed documentaion on what fields exist on that dbConfig see the docs for node-postgres's client config object.

For more options you can set in this file refer to the MainOptions type located at src/options.ts.

Generating a new migration

TBW

Executing a migration

TBW

Rolling back migrations

TBW

Background

There are already quite a number of tools to handle database migrations in node. For example one could use knex.js's migrations CLI. The problem with those was that I found myself utilizing some kind of raw helper method that let's me execute a raw SQL string quite a bit because the query builder didn't support enabling extensions or stuff like this.

Prior Art

I'm obviosuly not the first one to encouter this problem. A lot of other people have found that query builders are unnecessary for writing SQL migrations. There is for example the Rust Query Builder Diesel which lets you write your migrations in SQL. And there even is prior art in JS land. But all tools I found where either unmaintained, had an insane API or both.

Contribute

PRs accepted.

License

MIT © Mathis Wiehl