Note

Access to this page requires authorization. You can try signing in or .

Access to this page requires authorization. You can try .

Restore Class

Definition

Namespace:
Microsoft.SqlServer.Management.Smo
Assembly:
Microsoft.SqlServer.SmoExtended.dll
Package:
Microsoft.SqlServer.SqlManagementObjects v150.18208.0
Package:
Microsoft.SqlServer.SqlManagementObjects v160.2004021.0
Package:
Microsoft.SqlServer.SqlManagementObjects v172.64.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

public sealed class Restore : Microsoft.SqlServer.Management.Smo.BackupRestoreBase
type Restore = class
 inherit BackupRestoreBase
Public NotInheritable Class Restore
Inherits BackupRestoreBase
Inheritance

Constructors

Restore()
Restore(String, BackupSet)

Creates a Restore object

Fields

currentAsyncOperation (Inherited from BackupRestoreBase)
m_BackupAction (Inherited from BackupRestoreBase)
m_LogTruncation (Inherited from BackupRestoreBase)
m_RestoreAction (Inherited from BackupRestoreBase)
VerifyComplete

An event raised at the end of SqlVerify operation. It indicates if verification succeeded or not.

Properties

Action
AsyncStatus

A status of most recent asynchronous operation, including possible errors.

(Inherited from BackupRestoreBase)
BackupSet

The restore backup set

BlockSize (Inherited from BackupRestoreBase)
BufferCount (Inherited from BackupRestoreBase)
Checksum (Inherited from BackupRestoreBase)
ClearSuspectPageTableAfterRestore
ContinueAfterError (Inherited from BackupRestoreBase)
CredentialName

Gets or sets the credential name that is used by Backup to Url

(Inherited from BackupRestoreBase)
Database (Inherited from BackupRestoreBase)
DatabaseFileGroups (Inherited from BackupRestoreBase)
DatabaseFiles (Inherited from BackupRestoreBase)
DatabasePages

Gets the restore pages.

Devices

A list of devices used as a target for backup

(Inherited from BackupRestoreBase)
FileNumber
KeepReplication
KeepTemporalRetention
MaxTransferSize (Inherited from BackupRestoreBase)
MediaName (Inherited from BackupRestoreBase)
NoRecovery (Inherited from BackupRestoreBase)
NoRewind (Inherited from BackupRestoreBase)
Offset
Options (Inherited from BackupRestoreBase)
Partial
PercentCompleteNotification (Inherited from BackupRestoreBase)
RelocateFiles
ReplaceDatabase
Restart (Inherited from BackupRestoreBase)
RestrictedUser
RetryFailedQueries (Inherited from BackupRestoreBase)
StandbyFile
StopAtMarkAfterDate
StopAtMarkName
StopBeforeMarkAfterDate
StopBeforeMarkName
ToPointInTime
UnloadTapeAfter (Inherited from BackupRestoreBase)

Methods

Abort()

Aborts the current action, if any

(Inherited from BackupRestoreBase)
CheckForHADRMaintPlan(Server, StringBuilder)

If invoked from Maintenance plan Check if HADR is enabled

(Inherited from BackupRestoreBase)
ClearSuspectPageTable(Server)
ExecuteSql(Server, StringCollection) (Inherited from BackupRestoreBase)
ExecuteSqlAsync(Server, StringCollection) (Inherited from BackupRestoreBase)
ExecuteSqlWithResults(Server, String) (Inherited from BackupRestoreBase)
GetDevicesScript(StringBuilder, BackupDeviceList, ServerVersion) (Inherited from BackupRestoreBase)
IsStringValid(String) (Inherited from BackupRestoreBase)
ReadBackupHeader(Server)
ReadFileList(Server)
ReadMediaHeader(Server)
ReadSuspectPageTable(Server)
Script(Server)
SetMediaPassword(SecureString)
Obsolete.
(Inherited from BackupRestoreBase)
SetMediaPassword(String)
Obsolete.
(Inherited from BackupRestoreBase)
SetPassword(SecureString) (Inherited from BackupRestoreBase)
SetPassword(String) (Inherited from BackupRestoreBase)
SqlRestore(Server)

Runs Restore operation in a synchronous way, i.e. the call blocks until verification is completed.

SqlRestoreAsync(Server)

Runs Restore operation in an asynchronous way, i.e. the call returns immediately and verify operation continues in background.

SqlVerify(Server, Boolean, String)

Runs Verify operation in a synchronous way, i.e. the call blocks until verification is completed.

SqlVerify(Server, Boolean)

Runs Verify operation in a synchronous way, i.e. the call blocks until verification is completed.

SqlVerify(Server, String)

Runs Verify operation in a synchronous way, i.e. the call blocks until verification is completed.

SqlVerify(Server)

Runs Verify operation in a synchronous way, i.e. the call blocks until verification is completed.

SqlVerifyAsync(Server, Boolean)

Runs Verify operation in an asynchronous way, i.e. the call returns immediately and verify operation continues in background.

SqlVerifyAsync(Server)

Runs Verify operation in an asynchronous way, i.e. the call returns immediately and verify operation continues in background.

SqlVerifyLatest(Server, SqlVerifyAction, String)

Performs a verify on the last backup recorded in the backup history. FileNumber will be ignored, as the latest file number will be automatically determined.

SqlVerifyLatest(Server, SqlVerifyAction)

Performs a verify on the last backup recorded in the backup history. FileNumber will be ignored, as the latest file number will be automatically determined.

SqlVerifyLatest(Server, String)

Performs a verify on the last backup recorded in the backup history. FileNumber will be ignored, as the latest file number will be automatically determined.

SqlVerifyLatest(Server)

Performs a verify on the last backup recorded in the backup history. FileNumber will be ignored, as the latest file number will be automatically determined.

Wait()

Waits for the current asynchronous action to complete.

(Inherited from BackupRestoreBase)

Events

Complete

Complete event

(Inherited from BackupRestoreBase)
Information

Information event

(Inherited from BackupRestoreBase)
NextMedia

NextMedia event

(Inherited from BackupRestoreBase)
PercentComplete

PercentComplete event

(Inherited from BackupRestoreBase)

Applies to