Binary Backups

input BackupInput {
  """
  Destination for the backup: e.g. MinIO or S3 bucket.
  """
  destination: String!

  """
  Access key credential for the destination.
  """
  accessKey: String

  """
  Secret key credential for the destination.
  """
  secretKey: String

  """
  AWS session token, if required.
  """
  sessionToken: String

  """
  Set to true to allow backing up to S3 or MinIO bucket that requires no credentials.
  """
  anonymous: Boolean

  """
  Force a full backup instead of an incremental backup.
  """
  forceFull: Boolean
}

mutation {
  backup(
    input: { destination: "s3://s3.us-west-2.amazonaws.com/<bucketname>" }
  ) {
    response {
      message
      code
    }
    taskId
  }
}

mutation {
  backup(input: { destination: "minio://127.0.0.1:9000/<bucketname>" }) {
    response {
      message
      code
    }
    taskId
  }
}

mutation {
  backup(
    input: { destination: "minio://127.0.0.1:9000/<bucketname>?secure=false" }
  ) {
    response {
      message
      code
    }
    taskId
  }
}

mutation {
  backup(input: { destination: "/path/to/local/directory" }) {
    response {
      message
      code
    }
    taskId
  }
}

mutation {
  backup(input: { destination: "/path/to/local/directory", forceFull: true }) {
    response {
      message
      code
    }
    taskId
  }
}

query backup() {
  listBackups(input: {location: "/data/backup"}) {
    backupId
    backupNum
    encrypted
    groups {
      groupId
      predicates
    }
    path
    since
    type
  }
}

input ListBackupsInput {
  """
  Destination for the backup: e.g. MinIO or S3 bucket.
  """
  location: String!

  """
  Access key credential for the destination.
  """
  accessKey: String

  """
  Secret key credential for the destination.
  """
  secretKey: String

  """
  AWS session token, if required.
  """
  sessionToken: String

  """
  Whether the destination doesn't require credentials (e.g. S3 public bucket).
  """
  anonymous: Boolean
}

type Manifest {
  """
  Unique ID for the backup series.
  """
  backupId: String

  """
  Number of this backup within the backup series. The full backup always has a value of one.
  """
  backupNum: Int

  """
  Whether this backup was encrypted.
  """
  encrypted: Boolean

  """
  List of groups and the predicates they store in this backup.
  """
  groups: [BackupGroup]

  """
  Path to the manifest file.
  """
  path: String

  """
  The timestamp at which this backup was taken. The next incremental backup will
  start from this timestamp.
  """
  since: Int

  """
  The type of backup, either full or incremental.
  """
  type: String
}

type BackupGroup {
  """
  The ID of the cluster group.
  """
  groupId: Int

  """
  List of predicates assigned to the group.
  """
  predicates: [String]
}

name: string .
friend: uid .

name: string .
friend: [uid] .

backup
├── dgraph.20210102.204757.509
│   └── r9-g1.backup
├── dgraph.20210104.224757.707
│   └── r9-g1.backup
└── manifest.json

dgraph.r9.u0108.1621
├── g01.gql_schema.gz
├── g01.rdf.gz
└── g01.schema.gz

backup
├── dgraph.20210104.224757.709
│   └── r9-g1.backup
└── manifest.json

dgraph export_backup --location "<location-of-your-binary-backup>" --destination "<destination-of-the-export-dir>"

dgraph.r9.u0108.1621
├── g01.gql_schema.gz
├── g01.rdf.gz
└── g01.schema.gz

mutation {
  restore(
    input: {
      location: "/path/to/backup/directory"
      backupId: "id_of_backup_to_restore"
    }
  ) {
    message
    code
  }
}

input RestoreInput {
  """
  Destination for the backup: e.g. MinIO or S3 bucket.
  """
  location: String!

  """
  Backup ID of the backup series to restore. This ID is included in the manifest.json file.
  If missing, it defaults to the latest series.
  """
  backupId: String

  """
  Number of the backup within the backup series to be restored. Backups with a greater value
  will be ignored. If the value is zero or is missing, the entire series will be restored.
  """
  backupNum: Int

  """
  Path to the key file needed to decrypt the backup. This file should be accessible
  by all Alpha servers in the group. The backup will be written using the encryption key
  with which the cluster was started, which might be different than this key.
  """
  encryptionKeyFile: String

  """
  Vault server address where the key is stored. This server must be accessible
  by all Alpha servers in the group. Default "http://localhost:8200".
  """
  vaultAddr: String

  """
  Path to the Vault RoleID file.
  """
  vaultRoleIDFile: String

  """
  Path to the Vault SecretID file.
  """
  vaultSecretIDFile: String

  """
  Vault kv store path where the key lives. Default "secret/data/dgraph".
  """
  vaultPath: String

  """
  Vault kv store field whose value is the key. Default "enc_key".
  """
  vaultField: String

  """
  Vault kv store field's format. Must be "base64" or "raw". Default "base64".
  """
  vaultFormat: String

  """
  Access key credential for the destination.
  """
  accessKey: String

  """
  Secret key credential for the destination.
  """
  secretKey: String

  """
  AWS session token, if required.
  """
  sessionToken: String

  """
  Set to true to allow backing up to S3 or MinIO bucket that requires no credentials.
  """
  anonymous: Boolean

  """
  All the backups with num >= incrementalFrom will be restored.
  """
  incrementalFrom: Int

  """
  If `isPartial` is set to true then the cluster is kept in draining mode after
  restore to ensure that the database is not corrupted by any mutations or tablet moves in
  between two restores.
  """
  isPartial: Boolean
}

mutation{
  restore(input:{
    incrementalFrom:"incremental_backup_from",
    location: "/path/to/backup/directory",
    backupId: "id_of_backup_to_restore"'
  }){
    message
    code
  }
}

mutation {
  restoreTenant(
    input: {
      restoreInput: {
        incrementalFrom: "incremental_backup_from"
        location: "/path/to/backup/directory"
        backupId: "id_of_backup_to_restore"
      }
      fromNamespace: namespaceToBeRestored
    }
  ) {
    message
    code
  }
}

input RestoreTenantInput {
  """
  restoreInput contains fields that are required for the restore operation,
  i.e., location, backupId, and backupNum
  """
  restoreInput: RestoreInput

  """
  fromNamespace is the namespace of the tenant that needs to be restored into namespace 0 of the new cluster.
  """
  fromNamespace: Int!
}

dgraph restore --postings "/var/db/dgraph" --location "s3://s3.<region>.amazonaws.com/<bucketname>"

dgraph restore --postings "/var/db/dgraph" --location "minio://127.0.0.1:9000/<bucketname>"

dgraph restore --postings "/var/db/dgraph" --location "/var/backups/dgraph"

dgraph restore --postings "/var/db/dgraph" --location "/var/backups/dgraph" --zero "localhost:5080"