Restore

Configuration and Execution

• To restore your database, configure a RestoreBackupConfiguration instance and pass it to RestoreBackupOperation for execution.

• RestoreBackupOperation

  public RestoreBackupOperation(RestoreBackupConfiguration restoreConfiguration)

• RestoreBackupConfiguration

  public class RestoreBackupConfiguration
  {
      public string DatabaseName { get; set; }
      public string BackupLocation { get; set; }
      public string LastFileNameToRestore { get; set; }
      public string DataDirectory { get; set; }
      public string EncryptionKey { get; set; }
      public bool DisableOngoingTasks { get; set; }
  }

  • Parameters:

  Parameter	Value	Functionality
  DatabaseName	string	Name for the new database.
  BackupLocation	string	Backup file local path. Backup source path has to be local for the restoration to continue.
  LastFileNameToRestore (Optional - omit for default)	string	Last backup file to restore. Default behavior: Restore all backup files in the folder.
  DataDirectory (Optional - omit for default)	string	Database data directory. Default folder: Under the "Databases" folder, in a folder that carries the restored database's name.
  EncryptionKey (Optional - omit for default)	string	A key for an encrypted database. Default behavior: Try to restore as if DB is unencrypted.
  DisableOngoingTasks (Optional - omit for default)	boolean	true to disable ongoing tasks after restoring, false to enable tasks after restoring. Default: false (tasks DO run when backup is restored)

• Configuration

  • Set DatabaseName with the new database name.
  • Set BackupLocation with a local path for the backup files.

• Execution

  • Pass RestoreBackupOperation the configured RestoreBackupConfiguration.
  • Restore tha database by sending the task to the server.

• Code Sample:
  

  var restoreConfiguration = new RestoreBackupConfiguration();
  
  //New database name
  restoreConfiguration.DatabaseName = "newProductsDatabase";
  
  //Local path with a backup file
  var backupPath = @"C:\Users\RavenDB\backups\2018-12-26-16-17.ravendb-Products-A-backup";
  restoreConfiguration.BackupLocation = backupPath;
  
  var restoreBackupTask = new RestoreBackupOperation(restoreConfiguration);
  docStore.Maintenance.Server.Send(restoreBackupTask);

Restore Database to a Single Node & Replicate it to Other Nodes

The common approach to restoring a cluster is to restore the backed-up database to a single server, and then expand the database group to additional nodes, allowing normal replication.

• Restore the backup to a single node.
• Modify the database group topology using the Studio or code to spread the database to the other nodes.

Restore Database to Multiple Nodes Simultaneously

You can create the cluster in advance, and restore the database to multiple nodes simultaneously.

• On the first node, restore the database using its original name.
• On other nodes, restore the database using different names.
• Wait for the restoration to complete on all nodes.
• Soft-delete the additional databases (those with altered names).
  • Delete the databases from the cluster with HardDelete set to false, to retain the data files on disk.
• Rename the database folder on all nodes to the original database name.
• Expand the database group to all relevant nodes.