see on GitHub

Server-Wide Backup



Scheduling a Server-Wide Backup Task

Click the Manage Server main-menu item.

Figure 1. Manage-Server Menu Item

Figure 1. Manage-Server Menu Item


The Server-Wide Backup View

Figure 2. Add Server-Wide Backup Task

Figure 2. Add Server-Wide Backup Task

  1. Click the Server-Wide Backup menu item
  2. Click the Add Server-Wide Backup Task button to add a new task

Configure the new Backup Task.

Figure 3. Task Configuration

Figure 3. Task Configuration

The settings are similar to those of a regular backup task.

  1. Task Name
    Enter the Server-Wide Backup Task name.

  2. Backup type
    Select 'Backup' for a logical backup or 'Snapshot' for a snapshot image.

  3. Schedule
    Define task contents (Full and/or Incremental) and schedule execution time.

  4. Retention Policy
    Define the minimum amount of time to keep Backups (and Snapshots) in the system.

  5. Encryption

Figure 4. Backup Encryption

Figure 4. Backup Encryption

  • Backup files (both logical backups and snapshot images) of encrypted databases will always be encrypted,
    regardless of the settings here, using the database encryption key.
  • Logical backups of unencrypted databases, will be encrypted using the key provided here.
    You can use either the key suggested by RavenDB, or a valid key from any other source.
  • Logical backups of encrypted databases will use the database's encryption key,
    even if you provide a different key here.
  • Snapshot images of unencrypted databases will always be unencrypted, regardless of the settings here,
    since a snapshot is a faithful bitmap copy of the database.

    Encryption Summary:

    Database Encryption Backup Type Backup Encryption and Key Used
    Encrypted Logical Backup Backup is encrypted using the database key,
    even if you provide a different key
    Encrypted Snapshot Image Backup is encrypted using the database key
    Not Encrypted Logical Backup Backup is encrypted using the key you provide
    Not Encrypted Snapshot Image Backup is not encrypted,
    even if encryption is enabled

  • Destination
    Backup files can be stored locally and/or remotely.
    Backup files are created in a separate child folder per database, under a common root folder.

Figure 5. Backup Destination Folder

Figure 5. Backup Destination Folder

Restoring a Database From a Server-Wide Backup

There is no difference between restoring a database from a backup file created by the Server-Wide procedure and a separately created backup.
In both cases, you can restore the database by Creating a New Database from Backup.

  • While the Server-Wide Backup Task creates backups for all your databases at once, the restore procedure can only restore a single database at a time.
  • When restoring a database from a backup file created by the Server-Wide procedure, make sure you provide the link to the specific database backup file and not the common root folder that was created by the Server-Wide task.


Server-Wide Backup Tasks in the Database Tasks View

The Server-Wide Backup Tasks created for each database, can be viewed in the database's Ongoing-Tasks view.
You can use this view to see a task's details, or to trigger an immediate backup.
To edit or modify a Server-Wide task, navigate back to the Server-Wide Backup view.

  • Choose the database you're interested in.
Figure 6. Choose Database

Figure 6. Choose Database

  • Open the 'Manage Ongoing Tasks' View.
Figure 7. Manage-Ongoing-Tasks View

Figure 7. Manage-Ongoing-Tasks View

  1. Click to open the Manage Ongoing Tasks view for the selected database.
  2. Use this shortcut to navigate directly to the Server-Wide Backup view.
  3. This is a regular backup task, defined only on this database.
  4. This is a Server-Wide Backup Task, with its detailed-view toggled on.
    Though it is a Server-Wide task, clicking its Backup Now button would back up only the currently-chosen database.
  5. Click this button to toggle this task's detailed-view on or off.
  6. This is another Server-Wide Backup Task, with its detailed-view toggled off.


The Responsible Node

  • When defining a Server-Wide backup, the user is not given the option to select a responsible node manually, since the responsible node can differ per database depending on the nodes the database resides on (the Database Group).
    For each database, the responsible node for the task is set by the cluster to one of the database group nodes.

  • Since defining a Server-Wide backup actually creates regular backup tasks, the behavior of a Server-Wide Backup Task when the cluster or responsible-node is down is identical to that of a regular backup task.
    See Backup Task - When Cluster or Node are Down.

  • A graphical view of the database group shows which node is responsible for which task.

Figure 8. Topology View

Figure 8. Topology View