Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The Restore object provides programmatic access to restore operations.
The following tables list the members exposed by the Restore type.
Public Constructors
| Name | Description | |
|---|---|---|
| Restore | Initializes a new instance of the Restore class. |
Top
Public Fields
(see also Protected Fields )
| Name | Description | |
|---|---|---|
.gif "ms220122.pubfield(en-US,SQL.90).gif") |
VerifyComplete | Specifies the VerifyCompleteEventHandler. |
Top
Protected Fields
| Name | Description | |
|---|---|---|
.gif "ms220122.protfield(en-US,SQL.90).gif") |
currentAsyncOperation | (inherited from BackupRestoreBase ) |
|
m_BackupAction | (inherited from BackupRestoreBase ) |
|
m_LogTruncation | (inherited from BackupRestoreBase ) |
|
m_RestoreAction | (inherited from BackupRestoreBase ) |
Top
Public Properties
| Name | Description | |
|---|---|---|
.gif "ms220122.pubproperty(en-US,SQL.90).gif") |
Action | Gets or sets the type of restore to be performed. |
|
AsyncStatus | Gets the asynchronous status of a backup or restore process. (inherited from BackupRestoreBase) |
|
Checksum | Gets or sets a Boolean property value that determines whether a checksum value is calculated during backup or restore operations. (inherited from BackupRestoreBase) |
|
ClearSuspectPageTableAfterRestore | Gets or sets a Boolean value that determines whether entries in the suspect page table will be deleted following the restore operation. |
|
ContinueAfterError | Gets or sets a Boolean property value that determines whether the backup or restore continues after a checksum error occurs. (inherited from BackupRestoreBase) |
|
Database | Gets or sets the database on which the backup or restore operation runs. (inherited from BackupRestoreBase) |
|
DatabaseFileGroups | Gets the Microsoft SQL Server file groups targeted by the backup or restore operation. (inherited from BackupRestoreBase) |
|
DatabaseFiles | Gets the operating system files targeted by the backup or restore operation. (inherited from BackupRestoreBase) |
|
Devices | Gets the backup devices specified for the backup or restore operation. This property is not CLS-compliant. (inherited from BackupRestoreBase) |
|
FileNumber | Gets or sets the index number used to identify the targeted backup set on the backup medium. |
|
KeepReplication | Gets or sets a Boolean property value that specifies whether to maintain a replication configuration during a restore operation. |
|
MediaName | Gets or sets the name used to identify a particular media set. (inherited from BackupRestoreBase) |
|
NoRecovery | Gets or sets a Boolean property value that determines whether the tail of the log is backed up and whether the database is restored into the Restoring state. (inherited from BackupRestoreBase) |
|
NoRewind | Gets or sets a Boolean property value that determines whether Microsoft SQL Server will keep the tape open after the backup or restore operation. (inherited from BackupRestoreBase) |
|
Offset | Gets or sets the array of page addresses to be restored. |
|
Partial | Gets or sets a Boolean property value that specifies whether a partial or full restore operation will be performed. |
|
PercentCompleteNotification | Gets or sets the percentage interval for PercentCompleteEventHandler event handler calls. (inherited from BackupRestoreBase) |
|
RelocateFiles | Gets or sets the array of database logical file names and operating system physical file names used to redirect database storage when a database is restored to a new physical location. |
|
ReplaceDatabase | Gets or sets a Boolean value that specifies whether a restore operation creates a new image of the restored database. |
|
Restart | Gets or sets a Boolean property value that determines whether the backup or restore operation will restart if it is interrupted. (inherited from BackupRestoreBase) |
|
RestrictedUser | Gets or sets a Boolean property value that specifies whether access to the restored database is restricted to members of the db_owner fixed database role and the dbcreator and sysadmin fixed server roles. |
|
StandbyFile | Gets or sets the name of an undo file used as part of the imaging strategy for a Microsoft SQL Server instance. |
|
StopAtMarkAfterDate | Gets or sets the date to be used in conjunction with the mark name specified by StopAtMarkName to determine the stopping point of the recovery operation. |
|
StopAtMarkName | Gets or sets the mark name to be used in conjunction with the date specified by StopAtMarkAfterDate to determine the stopping point of the recovery operation. |
|
StopBeforeMarkAfterDate | Gets or sets the date to be used in conjunction with the mark name specified by StopBeforeMarkName to determine the stopping point of the recovery operation. |
|
StopBeforeMarkName | Gets or sets the mark name to be used in conjunction with the date specified by StopBeforeMarkAfterDate to determine the stopping point of the recovery operation. |
|
ToPointInTime | Gets or sets the endpoint for database log restoration. |
|
UnloadTapeAfter | Gets or sets a Boolean property value that determines whether tape media are rewound and unloaded after the backup or restore operation completes. (inherited from BackupRestoreBase) |
Top
Public Methods
(see also Protected Methods )
| Name | Description | |
|---|---|---|
.gif "ms220122.pubmethod(en-US,SQL.90).gif") |
Abort | Terminates a running backup or restore operation. (inherited from BackupRestoreBase) |
|
ClearSuspectPageTable | Deletes entries in the suspect page table. |
|
Equals | Overloaded. (inherited from Object ) |
|
GetHashCode | (inherited from Object ) |
|
GetType | (inherited from Object ) |
|
ReadBackupHeader | Reads the backup header and returns information about the media contents. |
|
ReadFileList | Returns the list of database files on the targeted media. |
|
ReadMediaHeader | Reads the media header and returns the media header values. |
|
ReadSuspectPageTable | Returns the suspect page table for the targeted Microsoft SQL Server instance. |
.gif "ms220122.static(en-US,SQL.90).gif") |
ReferenceEquals | (inherited from Object ) |
|
Script | Generates a Transact-SQL script that can be used to re-create the restore operation. |
|
SetMediaPassword | Overloaded. (inherited from BackupRestoreBase ) |
|
SetPassword | Overloaded. (inherited from BackupRestoreBase ) |
|
SqlRestore | Performs a restore operation. |
|
SqlRestoreAsync | Performs a restore operation asynchronously. |
|
SqlVerify | Overloaded. Checks the media on the Microsoft SQL Server instance represented by the specified Server object. |
|
SqlVerifyAsync | Overloaded. Checks the media on the Microsoft SQL Server instance represented by the specified Server object asynchronously. |
|
SqlVerifyLatest | Overloaded. Verifies the most recent backup but does not restore it, and checks to see that the backup set is complete and the entire backup is readable. |
|
ToString | (inherited from Object ) |
|
Wait | Waits for the current backup or restore operation to complete before moving on to the next process. (inherited from BackupRestoreBase) |
Top
Protected Methods
| Name | Description | |
|---|---|---|
.gif "ms220122.protmethod(en-US,SQL.90).gif") |
ExecuteSql | (inherited from BackupRestoreBase ) |
|
ExecuteSqlAsync | (inherited from BackupRestoreBase ) |
|
ExecuteSqlWithResults | (inherited from BackupRestoreBase ) |
|
Finalize | (inherited from Object ) |
|
GetDevicesScript | (inherited from BackupRestoreBase ) |
|
IsStringValid | (inherited from BackupRestoreBase ) |
|
MemberwiseClone | (inherited from Object ) |
Top
Public Events
| Name | Description | |
|---|---|---|
.gif "ms220122.pubevent(en-US,SQL.90).gif") |
Complete | Occurs when the backup or restore operation completes. (inherited from BackupRestoreBase) |
|
Information | Occurs when any informational message is issued by Microsoft SQL Server that cannot be handled by the CompleteNextMedia or PercentComplete events. (inherited from BackupRestoreBase) |
|
NextMedia | Occurs when the backup or restore operation exhausts the medium in a target device. (inherited from BackupRestoreBase) |
|
PercentComplete | Occurs when a backup or restore operation reaches a completion unit. (inherited from BackupRestoreBase) |
Top
See Also
Reference
Restore Class
Microsoft.SqlServer.Management.Smo Namespace
Other Resources
Backing Up and Restoring Databases and Transaction Logs
RESTORE (Transact-SQL)
Backing Up and Restoring Databases in SQL Server