Restore Members
Include Protected Members
Include Inherited Members
The Restore object provides programmatic access to restore operations.
The Restore type exposes the following members.
Methods
Name | Description | |
---|---|---|
![]() |
Abort() | Terminates a running backup or restore operation. (Inherited from BackupRestoreBase.) |
![]() |
ClearSuspectPageTable(Server) | Deletes entries in the suspect page table. |
![]() |
Equals(Object) | (Inherited from Object.) |
![]() |
ExecuteSql(Server, StringCollection) | Executes a batch of Transact-SQL statements that does not expect a returned results set on the specified instance of SQL Server. (Inherited from BackupRestoreBase.) |
![]() |
ExecuteSqlAsync(Server, StringCollection) | Executes a batch of Transact-SQL statements asynchronously that does not expect a returned results set on the specified instance of SQL Server. (Inherited from BackupRestoreBase.) |
![]() |
ExecuteSqlWithResults(Server, String) | Executes a batch of Transact-SQL statements that expects one or more returned results sets on the specified instance of SQL Server. (Inherited from BackupRestoreBase.) |
![]() |
Finalize() | (Inherited from Object.) |
![]() |
GetDevicesScript(StringBuilder, BackupDeviceList, ServerVersion) | (Inherited from BackupRestoreBase.) |
![]() |
GetHashCode() | (Inherited from Object.) |
![]() |
GetType() | (Inherited from Object.) |
![]() |
IsStringValid(String) | Verifies whether the specified string is valid. (Inherited from BackupRestoreBase.) |
![]() |
MemberwiseClone() | (Inherited from Object.) |
![]() |
ReadBackupHeader(Server) | Reads the backup header and returns information about the media contents. |
![]() |
ReadFileList(Server) | Returns the list of database files on the targeted media. |
![]() |
ReadMediaHeader(Server) | Reads the media header and returns the media header values. |
![]() |
ReadSuspectPageTable(Server) | Returns the suspect page table for the targeted instance of SQL Server. |
![]() |
Script(Server) | Generates a Transact-SQL script that can be used to re-create the restore operation. |
![]() |
SetMediaPassword(SecureString) | Sets the password for a media set. (Inherited from BackupRestoreBase.) |
![]() |
SetMediaPassword(String) | Sets the password for a media set. (Inherited from BackupRestoreBase.) |
![]() |
SetPassword(SecureString) | Sets the password for a backup set. (Inherited from BackupRestoreBase.) |
![]() |
SetPassword(String) | Sets the password for a backup set. (Inherited from BackupRestoreBase.) |
![]() |
SqlRestore(Server) | Performs a restore operation. |
![]() |
SqlRestoreAsync(Server) | Performs a restore operation asynchronously. |
![]() |
SqlVerify(Server) | Checks the media on the instance of SQL Server that is represented by the specified Server object. |
![]() |
SqlVerify(Server, Boolean) | Checks the media on instance of SQL Server that is represented by the specified Server object and loads backup history information into the history tables. |
![]() |
SqlVerify(Server, String%) | Checks the media on the instance of SQL Server that is represented by the specified Server object and returns an error message. |
![]() |
SqlVerify(Server, Boolean, String%) | Checks the media on the instance of SQL Server that is represented by the specified Server object, loads backup history information into the history tables, and returns an error message. |
![]() |
SqlVerifyAsync(Server) | Checks the media on the instance of SQL Server that is represented by the specified Server object asynchronously. |
![]() |
SqlVerifyAsync(Server, Boolean) | Checks the media on the instance of SQL Server that is represented by the specified Server object asynchronously and loads backup history information into the history tables. |
![]() |
SqlVerifyLatest(Server) | 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. |
![]() |
SqlVerifyLatest(Server, SqlVerifyAction) | Verifies the most recent backup with the specified action, and checks to see that the backup set is complete and the entire backup is readable. |
![]() |
SqlVerifyLatest(Server, String%) | Verifies the most recent backup but does not restore it, checks to see that the backup set is complete and the entire backup is readable, and returns an error message. |
![]() |
SqlVerifyLatest(Server, SqlVerifyAction, String%) | Verifies the most recent backup with the specified action, checks to see that the backup set is complete and the entire backup is readable, and returns an error message. |
![]() |
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
Fields
Name | Description | |
---|---|---|
![]() |
currentAsyncOperation | (Inherited from BackupRestoreBase.) |
![]() |
m_BackupAction | (Inherited from BackupRestoreBase.) |
![]() |
m_LogTruncation | (Inherited from BackupRestoreBase.) |
![]() |
m_RestoreAction | (Inherited from BackupRestoreBase.) |
![]() |
VerifyComplete | Specifies the VerifyCompleteEventHandler. |
Top
Properties
Name | Description | |
---|---|---|
![]() |
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.) |
![]() |
BlockSize | Gets or sets the physical block size of the backup or restore, in bytes. (Inherited from BackupRestoreBase.) |
![]() |
BufferCount | Gets or sets the total number of I/O buffers to be used for the backup or restore operation. (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 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. (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. |
![]() |
MaxTransferSize | Gets or sets the maximum number of bytes to be transferred between the backup media and the instance of SQL Server. (Inherited from BackupRestoreBase.) |
![]() |
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 that is used as part of the imaging strategy for an instance of SQL Server. |
![]() |
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
Events
Name | Description | |
---|---|---|
![]() |
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 Complete NextMedia 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