lsbackup command-line tool prints information about the stored backups in a user-defined location.
lsbackup command has two flags:
Flags: -h, --help help for lsbackup -l, --location string Sets the source location URI (required). --verbose Outputs additional info in backup list.
--location: indicates a source URI with Dgraph backup objects. This URI supports all the schemes used for backup.
--verbose: if enabled will print additional information about the selected backup.
For example, you can execute the
lsbackup command as follows:
dgraph lsbackup -l <source-location-URI>
Source URI formats:
/[path]?[args](only for local or NFS)
Source URI parts:
scheme: service handler, one of:
host: remote address; e.g.:
path: directory, bucket or container at target; e.g.:
args: specific arguments that are ok to appear in logs
The following snippet is an example output of
[Decoder]: Using assembly version of decoder Page Size: 4096 Listing backups from: ~/bkp Name Since Groups Encrypted dgraph_backup/dgraph.20210121.125014.852/manifest.json 30005 map[1:[dgraph.graphql.schema_created_at dgraph.graphql.xid dgraph.drop.op dgraph.type dgraph.cors dgraph.graphql.schema_history score dgraph.graphql.p_query dgraph.graphql.schema dgraph.graphql.p_sha256hash series]] false
Name: Name of the backup
Since: is the timestamp at which this backup was taken. It’s called
Sincebecause it will become the timestamp from which to backup in the next incremental backup.
Groups: is the map of valid groups to predicates at the time the backup was created. This is printed only if
--verboseflag is enabled
Encrypted: Indicates whether this backup is encrypted or not
Checking information about backups stored in an AWS S3 bucket:
dgraph lsbackup -l s3:///s3.us-west-2.amazonaws.com/dgraph_backup
You might need to set up access and secret key environment variables in the shell (or session) you are going to run the
lsbackup command. For example:
Checking information about backups stored in a MinIO bucket:
dgraph lsbackup -l minio://localhost:9000/dgraph_backup
In case the MinIO server is started without
tls, you must specify that
secure=false as it set to
true by default. You also need to set the environment variables for the access key and secret key.
In order to get the
lsbackup running, you should following these steps:
MINIO_ACCESS_KEYas an environment variable for the running shell this can be done with the following command: (
minioadminis the default access key, unless is changed by the user)
Set MINIO_SECRET_KEY as an environment variable for the running shell this can be done with the following command: (
minioadminis the default secret key, unless is changed by the user)
Add the argument
lsbackup command, that means the command will look like: (the double quotes
dgraph lsbackup -l "minio://localhost:9000/<bucket-name>?secure=false"
Checking information about backups stored locally (on disk):
dgraph lsbackup -l ~/dgraph_backup
This is a companion discussion topic for the original entry at https://dgraph.io/docs/enterprise-features/lsbackup/