pg-restore

Restore a postgres service container using a sql backup file with psql.

[!NOTE]

• This only supports sql backups.

Prerequisite

Create a backup using

$ cd [project_root]
$ mkdir backups
$ pg_dump -O -f backups/backup.sql $DATABASE_URL

See: https://github.com/tj-actions/pg-dump

Usage

Using the default PostgreSQL installed on the runner

...
    steps:
      # Checkout the repository
      - uses: actions/checkout@v4

      # Run pg-restore
      - name: Postgres Backup Restore
        uses: tj-actions/pg-restore@v6
        with:
          database_url: "postgres://test_user:test_password@localhost:5432/test_db"
          backup_file: "backups/backup.sql"

Using a different PostgreSQL version

...
    steps:
      # Checkout the repository
      - uses: actions/checkout@v2

      # Run pg-restore
      - name: Postgres Backup Restore
        uses: tj-actions/pg-restore@v6
        with:
          database_url: "postgres://test_user:test_password@localhost:5432/test_db"
          backup_file: "backups/backup.sql"
          postgresql_version: "15"  # Note: Only the major version is required e.g. 12, 14, 15

Inputs

INPUT	TYPE	REQUIRED	DEFAULT	DESCRIPTION
backup_file	string	true		Backup file name
database_url	string	true		Database URL
options	string	false		Extra options to pass directly to psql
postgresql_version	string	false		Version of PostgreSQL. e.g 15

• Free software: MIT license

If you feel generous and want to show some extra appreciation:

Credits

This package was created with Cookiecutter.

• install-postgresql

Report Bugs

Report bugs at https://github.com/tj-actions/pg-restore/issues.

If you are reporting a bug, please include:

• Your operating system name and version.
• Any details about your workflow that might be helpful in troubleshooting.
• Detailed steps to reproduce the bug.