Data source: pg_dump

You need to set up machine for Database Lab instance first. Check the Setup machine for the Database Lab Engine guide for the details.



In order to set up Database Lab Engine to automatically get the data from database using dump/restore you need to use following jobs:


Copy the contents of configuration example config.example.logical_generic.yml from the Database Lab repository to ~/.dblab/server.yml and update the following options:

  • Set secure server:verificationToken, it will be used to authorize API requests to the Engine;
  • Set connection options in retrieval:spec:logicalDump:options:source:connection:
    • dbname: database name to connect to;
    • host: database server host;
    • port: database server port;
    • username: database user name;
    • password: database master password (can be also set as PGPASSWORD environment variable of the Docker container).
  • Set proper version in Postgres Docker images tags (change the images itself only if you know what are you doing):
    • provision:options:dockerImage;
    • retrieval:spec:logicalRestore:options:dockerImage;
    • retrieval:spec:logicalDump:options:dockerImage.

Run Database Lab Engine

sudo docker run \
--name dblab_server \
--label dblab_control \
--privileged \
--publish 2345:2345 \
--volume /var/run/docker.sock:/var/run/docker.sock \
--volume /var/lib/dblab/db.dump:/var/lib/dblab/db.dump \
--volume /var/lib/dblab:/var/lib/dblab/:rshared \
--volume ~/.dblab/server.yml:/home/dblab/configs/config.yml \
--detach \
--restart on-failure \

You can use PGPASSWORD env to set the password.

Restart Engine in the case of failure

# Stop and remove the Database Lab Engine control container.
sudo docker rm -f dblab_server
# Clean up data directory.
sudo rm -rf /var/lib/dblab/data/*
# Remove dump file.
sudo umount /var/lib/dblab/db.dump
sudo rm -rf /var/lib/dblab/db.dump