Database Migrations

Changes to database are run with the migration package node-pg-migrate

Prerequisites

node-pg-migrate uses the connection parameters set in ./server/db/config.js, which are sourced from the .env in the server folder of the repo. See .env.sample for example of this.

Create a New Migration

To generate a new migration template called "add-books-table.js" run:

npm run migrate create add-books-table

from the server folder. This will output a migration file called <timestamp>-add-books-table.js in the migrations directory that can be filled out with the create table definition.

Read node-pg-migrate docs for helpful examples.

Apply the Migration to the Database

Once the migration script is ready apply it to the db with:

npm run migrate up

Rollback the Migration

To roll back a migration run:

npm run migrate down

and that will roll back the last migration.