Importing an existing Postgres database
The simplest way to import a database into BigAnimal is using logical backups taken with
pg_dump and loaded using
pg_restore. This approach provides a way to export and import a database across different versions of Postgres, including exporting from PostgreSQL and EDB Postgres Advanced Server versions prior to 10.
The high-level steps are:
- Export existing roles.
- Import existing roles.
- For each database, you are migrating:
In case your source PostgreSQL instance hosts multiple databases, you can segment them in multiple BigAnimal clusters for easier management, better performance, increased predictability, and finer control of resources. For example, if your host has 10 databases, you can import one database and related users on a different BigAnimal cluster, one at a time.
This approach requires suspending write operations to the database application for the duration of the export/import process. You can then resume the write operations on the new system. This is because
pg_dump takes an online snapshot of the source database. As a result, the changes after the backup starts aren't included in the output.
The required downtime depends on many factors, including:
- Size of the database
- Speed of the network between the two systems
- Your team's familiarity with the migration procedure
To minimize the downtime, you can test the process as many times as needed before the actual migration. You can perform the export with
pg_dump online, and the process is repeatable and measurable.
Make sure that you:
- Understand the terminology conventions.
- Have the required Postgres client binaries and libraries.
- Can access the source and target databases.
|source database||Postgres instance from which you want to import your data.|
|target database||Postgres cluster in BigAnimal where you want to import your data.|
|migration host||Temporary Linux machine in your trusted network from which to execute the export of the database and the subsequent import into BigAnimal. The migration host needs access to both the source and target databases. Or, if your source and target databases are on the same version of Postgres, the source host can serve as your migration host.|
The following client binaries must be on the migration host:
They must be the same version as the Postgres version of the target database. For example, if you want to import a PostgreSQL 10 database from your private network into a PostgreSQL 14 database in BigAnimal, use the client libraries and binaries from version 14.
- PostgreSQL superuser access to the source database. This can be the postgres user or another user with superuser privileges.
- Access to the target database in BigAnimal as the edb_admin user.
Connect to the source database using
psql. For example:
<pg-source>with the actual hostname or IP address of the source database and the
dbnamevalues as appropriate. If the connection doesn't work, contact your system and database administrators to make sure that you can access the source database. This might require changes to your
pg_hba.confand network settings. If
pg_hba.confchanges, reload the configuration with either
SELECT pg_reload_conf();using a psql connection or
pg_ctl reloadin a shell connection to the database host.
Connect to the target database using the edb_admin user. For example:
<pg-target>with the actual hostname of your BigAnimal cluster.
Export the existing roles from your source Postgres instance by running the following command on the migration host:
The generated SQL file looks like this:
- Your BigAnimal cluster already contains the
edb_adminuser, as well as the following-system required roles:
postgres— The superuser, needed by BigAnimal to manage the cluster.
streaming_replica— Required to manage streaming replication.
As a result, you need to modify the
Remove the lines involving the postgres user. For example, remove lines like these:
Remove any role with superuser or replication privileges. For example, remove lines like these:
For every role that's created, grant the new role to the edb_admin user immediately after creating the user. For example:
NOBYPASSRLSpermission attributes on the other users.
The role section in the modified file, then, looks similar to:
From the migration host, execute:
<pg-target>with the fully qualified domain name (FQDN) of your BigAnimal cluster.
This command tries to create the roles in a single transaction. In case of errors, the transaction is rolled back, leaving the database cluster in the same state as before the import attempt. Enforce this behavior using the
From the migration host, use the
pg_dump command to export the source database into the target database in BigAnimal. For example:
You can use the
--verbose option to monitor the progress of the operation.
The command generates a custom
.dump archive (
app.dump in this example), which contains the compressed dump of the source database. How long it takes the command to execute varies depending on several variables, including size of the database, network speed, disk speed, and CPU of both the source instance and the migration host. You can inspect the table of contents of the dump with
pg_restore -l <db_name>.dump.
As with any other custom format dump produced with
pg_dump, you can take advantage of the features that
pg_restore provides you with, including:
- Selecting a subset of the import tasks by editing the table of contents and passing it to the
- Running the command in parallel using the
-joption with the directory format.
For more information, see the
pg_restore command and the
.dump file you created when exporting the source database to import the database into BigAnimal. For example:
This process might take some time depending on the size of the database and the speed of the network.
In case of error, repeat the restore operation after you delete the database using the following command: