PostgreSQL Loader Plugin

The PostgreSQL loader plugin transforms .sql files into JavaScript functions that Emigrate can use to execute the migrations. In the same package you can find the PostgreSQL Generator and the PostgreSQL Storage.

Installation

npm install @emigrate/postgres

pnpm add @emigrate/postgres

yarn add @emigrate/postgres

bun add @emigrate/postgres

{
  "dependencies": {
    "@emigrate/postgres": "*"
  }
}

Configuration

The PostgreSQL loader plugin can be configured either using environment variables or by configuring the plugin directly in the emigrate.config.js file.

Configuration file

import { createPostgresLoader } from '@emigrate/postgres';

export default {
  plugins: [
    createPostgresLoader({
      connection: { ... },
    }),
  ],
};

Options

`connection` (required)

type: object | string

The connection options to use for connecting to the PostgreSQL database when the SQL statements from the migration files are executed. This can either be a connection URI or an object with connection options. For a list of supported connection options, see the postgres documentation.

Environment variables

The following environment variables are supported:

Variable	Description	Default
`POSTGRES_URL`	The full URI for connecting to a PostgreSQL database, e.g: `"postgres://user:pass@127.0.0.1:3306/database"`
`POSTGRES_HOST`	The host on which the PostgreSQL server instance is running	`"localhost"`
`POSTGRES_USER`	The PostgreSQL user account to use for the authentication
`POSTGRES_PASSWORD`	The PostgreSQL user password to use for the authentication
`POSTGRES_PORT`	The network port on which the PostgreSQL server is listening	`5432`
`POSTGRES_DB`	The PostgreSQL database to use for the connection

The environment variables are used when the plugin is used using the --plugin command line option:

npx emigrate list --plugin postgres

pnpm emigrate list --plugin postgres

yarn emigrate list --plugin postgres

bunx --bun emigrate list --plugin postgres

{
  "scripts": {
    "emigrate": "emigrate"
  }
}

deno task emigrate list --plugin postgres

Or when specifying the plugin in the emigrate.config.js file as a string:

export default {
  plugins: ['postgres'],
};