Restore a Database Backup from the Same Cluster

This page describes the process and options for restoring a database from a backup file. Please see the additional considerations if you want to restore to a different cluster other than backup’s source.

Restoring a backup is an offline operation. Your database will be down for a short period of time during database restore.

Prerequisites

  • You have access to the TigerGraph Linux user account on your cluster. All commands must be run from the TigerGraph Linux user.

  • You have access to a backup that was created from the same cluster.

Basic Procedure

To restore a backup, run the following command:

$ gadmin backup restore <tag/time point>

<tag> is the tag for an existing backup file of database. The restore will use the entire contents of the backup file. If the tag is for an incremental backup, it will also employ the chain of backups that the incremental backup(s) are based on, until it gets to a full backup.

<time point> employs Point-in-Time Restore, automatically searching for the most appropriate backup files and using only the appropriate parts of those backup files. See the documentati on Point-in-Time Restore to understand the limitations.

For example, if you want to restore a backup with the tag weekly-2022-08-31T004132, run gadmin backup restore weekly-2022-08-31T004132.

The restore operation cannot be canceled once started.

Options for Restore

To see a summary of the command options for restore, run:

gadmin backup restore -h

The -h option displays help information, listing all available parameters for the gadmin backup restore command.

Flags:

  --dr       the flag indicates to turn on cross-region replication(CRR) and set
             the cluster as a disaster-recovery(DR) cluster after the restore
             (note that the CRR-related configs should be populated before the
             restore). Enabling CRR for a new cluster, or when you simply want
             to enable CRR, can be done without providing a backup tag,
             i.e., by using the 'gadmin backup restore --dr' command.
  -h, --help                  Help for restore
      --ignore-space-check    Ignore the space check during the backup/restore.
      --staging-path string   The path used to store the graph data during backup/restore. Defaults to dataroot.
      --time-point            Restore to a specific point in time, rather than from a certain backup.
      --keep-users            Keep the existing user accounts unchanged during restore.
      -y, --y                 Yes to all questions

Global Flags:

--debug   enable debug log output to stdout