utility container for moving data between postgres instances with pg_dump + pg_restore
4.1K
This container simplifies the process of moving a PostgreSQL database. The core functionality is based on a pipeline: pg_dump ... | pg_restore ..., which offers several advantages:
pg_dump and pg_restore are part of PostgreSQL| Repo | URL |
|---|---|
| Source Code | https://github.com/backplane/pgxfer/ |
| Docker Image | https://hub.docker.com/r/backplane/pgxfer/ |
The program emits the following help text when invoked with -h or --help flags.
usage: pgxfer [-h] [--clean-dest | --no-clean-dest]
[--init-dest | --no-init-dest] [--owner | --no-owner]
[--acl | --no-acl]
[--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}]
[--log-dir LOG_DIR] [--source-host SOURCE_HOST]
[--source-port SOURCE_PORT] [--source-username SOURCE_USERNAME]
[--source-password SOURCE_PASSWORD] [--source-name SOURCE_NAME]
[--dest-host DEST_HOST] [--dest-port DEST_PORT]
[--dest-username DEST_USERNAME] [--dest-password DEST_PASSWORD]
[--dest-name DEST_NAME]
util for copying databases between postgres servers
options:
-h, --help show this help message and exit
--clean-dest, --no-clean-dest
before restoring database objects, issue commands to
DROP all the objects that will be restored (default:
False)
--init-dest, --no-init-dest
drop and recreate the target database before restoring
into it (default: True)
--owner, --no-owner Output commands to set ownership of objects to match
the original database. When enabled pg_restore issues
ALTER OWNER or SET SESSION AUTHORIZATION statements to
set ownership of created schema elements. (default:
True)
--acl, --no-acl Restore access privileges (via grant/revoke commands)
(default: True)
--log-level {CRITICAL,ERROR,WARNING,INFO,DEBUG,NOTSET}
log level to use when writing to the console (default:
'INFO')
--log-dir LOG_DIR directory in which to write log files (default: None)
--source-host SOURCE_HOST
network address of source database server (default:
'localhost')
--source-port SOURCE_PORT
network port number of source database server
(default: 5432)
--source-username SOURCE_USERNAME
username to use when authenticating with source
database server (default: 'postgres')
--source-password SOURCE_PASSWORD
password to use when authenticating with source
database server (default: 'postgres')
--source-name SOURCE_NAME
name of database to connect to on the source database
server (default: 'postgres')
--dest-host DEST_HOST
network address of dest database server (default:
'dest')
--dest-port DEST_PORT
network port number of dest database server (default:
5432)
--dest-username DEST_USERNAME
username to use when authenticating with dest database
server (default: 'postgres')
--dest-password DEST_PASSWORD
password to use when authenticating with dest database
server (default: 'postgres')
--dest-name DEST_NAME
name of database to connect to on the dest database
server (default: 'postgres')
| Env. Var | Info |
|---|---|
DEST_HOST | network address of dest database server |
DEST_PORT | network port number of dest database server |
DEST_USERNAME | username to use when authenticating with dest database server |
DEST_PASSWORD | password to use when authenticating with dest database server |
DEST_NAME | name of database to connect to on the dest database server |
SOURCE_HOST | network address of source database server |
SOURCE_PORT | network port number of source databaseserver |
SOURCE_USERNAME | username to use when authenticating with source database server |
SOURCE_PASSWORD | password to use when authenticating with source database server |
SOURCE_NAME | name of database to connect to on the source database server |
LOG_DIR | directory in which to write log files |
LOG_LEVEL | log level to use when writing to the console |
OWNER | whether to output commands to set ownership of objects |
ACL | whether to apply access privileges (via grant/revoke commands) |
CLEAN_DEST | whether to first DROP all the restored objects in the dest db |
INIT_DEST | whether (re)create the dest database before restoring |
This container is intended to be deployed with Docker Compose (or something like Kubernetes). Here's a compose example:
services:
pgxfer:
image: backplane/pgxfer:1
environment:
SOURCE_HOST: "sourcehost"
SOURCE_PORT: "5432"
SOURCE_USERNAME: "dbadmin"
SOURCE_PASSWORD: "egg$.ample.Passw0r7"
SOURCE_NAME: "newpostgres"
DEST_HOST: "desthost"
DEST_PORT: "5432"
DEST_USERNAME: "postgres"
DEST_PASSWORD: "hunter2"
DEST_NAME: "postgres"
LOG_DIR: "/log"
LOG_LEVEL: "DEBUG"
restart: no
volumes:
- "./log:/log"
Content type
Image
Digest
sha256:7fe15875e…
Size
62.6 MB
Last updated
over 2 years ago
docker pull backplane/pgxfer