dgbr is CLI tool allowing to backup/restore Dgraph database to/from AWS S3 bucket. dgbr handles backups by requesting Dgraph to export existing database, archiving the data and uploading it to the S3 bucket. Backups can be configured to be made periodically. dgbr handles database restore by downlaoding existing archive from S3 bucket, extracting it and importing data/schema to dgraph using live loader. dgbr is currently used in production and is planned to be maintained and improved.
You can either download binary release or build dgbr from source.
dgbr is written in Go, therefore you have to instal the compiler to build it from source.
git clone https://github.com/AugustDev/dgbr.git
go build
go install
If you choose to download the release, you may add it to your bin path like this.
wget https://github.com/AugustDev/dgbr/releases/download/1.0.0/dgbr-linux-amd64.gz
gunzip -c dgbr-linux-amd64.gz > dgbr
chmod +x dgbr
sudo mv dgbr /usr/bin/dgbr
Both Dgraph backup and restore actions require specifying: AWS_ACCESS_KEY, AWS_SECRET_KEY, bucket and region.
In adition to aforementioned variables dgbr backup requires to specify Dgraph export path which is specified when starting dgraph alpha (Read in Notes). Make sure Dgraph has permission to write to export path and that the user calling dgbr has permission to access and then delete files from export path.
dgbr backup \
--AWS_ACCESS_KEY=X \
--AWS_SECRET_KEY=Y \
--bucket=my-dgraph-backups \
--region=eu-west-1 \
--export=/exportsRestoring database requires specifying name of the zip file in S3 bucket.
dgbr restore \
--AWS_ACCESS_KEY=X \
--AWS_SECRET_KEY=Y \
--bucket=dgraph-backups-development \
--region=eu-west-1 \
--name=dg-my_backup.zipThere are many ways to schedule tasks. This is one example. To schedule perodic (daily, hourly etc.) backups simply create a script and add it to your cron list. Make sure that dgbr is in the appropriate bin folder.
#!/bin/bash
export PATH="/usr/local/bin:/usr/bin:/bin"
AWS_ACCESS_KEY=X
AWS_SECRET_KEY=Y
BUCKET=dgraph-backups-development
REGION=eu-west-1
EXPORT_PATH=/Users/august/exports
dgbr backup \
--AWS_ACCESS_KEY=${AWS_ACCESS_KEY} \
--AWS_SECRET_KEY=${AWS_SECRET_KEY} \
--bucket=${BUCKET} \
--region=${REGION} \
--export=${EXPORT_PATH} An example of hourly export cronjob would be
0 * * * * /Users/august/backup.sh >> /Users/august/log.txt 2>&1where the logs are saved to /Users/august/log.txt.
Type dgbr backup --help
Example use:
dgbr backup --AWS_ACCESS_KEY=X --AWS_SECRET_KEY=Y --bucket=my-dgraph-backups --region=eu-west-1 --export=/exports
Usage:
dgbr backup [flags]
Flags:
--alphaHost string alpha server host name (default "localhost")
--alphaPort string alpha server port (default "9080")
--export string Location where dgraph alpha is exporting data (required) (default "/exports")
--format string Export format rdf or json (default "rdf")
-h, --help help for backup
--host string Hostname of running instance of Dgraph server (default "localhost")
--port string Hostname port (default "8080")
--prefix string Prefix appended to backup file name (default "dg")
--zeroHost string zero server host name (default "localhost")
--zeroPort string zero server port (default "5080")
Global Flags:
--AWS_ACCESS_KEY string AWS access key for your IAM user (required)
--AWS_SECRET_KEY string AWS secret key for your IAM user (requried)
--bucket string Name of your AWS S3 bucket (requried)
--config string config file (default is $HOME/.dgraph-backup-restore.yaml)
--region string Your AWS S3 bucket region (requried)
Type dgbr restore --help
Example use:
dgbr restore --AWS_ACCESS_KEY=X --AWS_SECRET_KEY=Y --bucket=my-dgraph-backups --region=eu-west-1 --name=dg_date.zip
Usage:
dgbr restore [flags]
Flags:
--alphaHost string alpha server host name (default "localhost")
--alphaPort string alpha server port (default "9080")
-h, --help help for restore
--name string backup name for the restore in S3 bucket (required)
--zeroHost string zero server host name (default "localhost")
--zeroPort string zero server port (default "5080")
Global Flags:
--AWS_ACCESS_KEY string AWS access key for your IAM user (required)
--AWS_SECRET_KEY string AWS secret key for your IAM user (requried)
--bucket string Name of your AWS S3 bucket (requried)
--config string config file (default is $HOME/.dgraph-backup-restore.yaml)
--region string Your AWS S3 bucket region (requried)
If you start dgraph alpha using
dgraph alpha --lru_mb 2048 -p /var/run/dgraph/p -w /var/run/dgraph/w --export /exports
your export path is /exports.
Project was inspired by https://github.com/xanthous-tech/dgraph-backup-cli, yet I found it to have multiple issues and lacking documentation.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent