KeyValueStoreReplica.Restore(String) Method

Definition

Caution

Use RestoreAsync instead

Restores this replica's local store database from a backup that was previously created by calling BackupAsync(String, StoreBackupOption, Func<StoreBackupInfo,Task<Boolean>>).

[System.Obsolete("Use RestoreAsync instead")]
public void Restore (string backupDirectory);
[<System.Obsolete("Use RestoreAsync instead")>]
member this.Restore : string -> unit
Public Sub Restore (backupDirectory As String)

Parameters

backupDirectory
String

The full path to a directory containing a backup.

Attributes

Remarks

This is only a local replica restore and the replica set is not automatically restored. The entire replica set must be restored by taking additional steps to cause a natural build of other replicas via reconfiguration. The recommended approach is to restore to an empty service with only a single replica and increase the target replica set size afterwards with a call to UpdateServiceAsync(Uri, ServiceUpdateDescription) if needed.

If the restore is successful, then the replica will restart itself and start using the restored local data after coming back online given that the recommendation to restore to a replica set containing only a single replica was followed.

Applies to