migrate

Runs the DataQueue database migrations against your PostgreSQL database using node-pg-migrate.

npx dataqueue-cli migrate [options]

Options

Environment Variables

The migration reads the connection string from the PG_DATAQUEUE_DATABASE environment variable. You can set it directly or load it from a .env file using --envPath.

Examples

Run migrations using environment variables already set in your shell:

npx dataqueue-cli migrate

Load environment variables from a specific .env file:

npx dataqueue-cli migrate --envPath .env.local

Run migrations in a custom PostgreSQL schema:

npx dataqueue-cli migrate --schema my_schema

Combine both options:

npx dataqueue-cli migrate --envPath .env.local --schema my_schema

How It Works

Under the hood, dataqueue-cli migrate runs:

npx node-pg-migrate up \
  -t dataqueuedev_migrations \
  -d PG_DATAQUEUE_DATABASE \
  -m <bundled-migrations-dir> \
  [--envPath <path>] \
  [-s <schema> --create-schema]

The migrations directory is bundled with the @nicnocquee/dataqueue package, so you don't need to manage migration files yourself.