Класс Restore
The Restore object provides programmatic access to restore operations.
Иерархия наследования
System.Object
Microsoft.SqlServer.Management.Smo.BackupRestoreBase
Microsoft.SqlServer.Management.Smo.Restore
Пространство имен: Microsoft.SqlServer.Management.Smo
Сборка: Microsoft.SqlServer.SmoExtended (в Microsoft.SqlServer.SmoExtended.dll)
Синтаксис
'Декларация
Public NotInheritable Class Restore _
Inherits BackupRestoreBase
'Применение
Dim instance As Restore
public sealed class Restore : BackupRestoreBase
public ref class Restore sealed : public BackupRestoreBase
[<SealedAttribute>]
type Restore =
class
inherit BackupRestoreBase
end
public final class Restore extends BackupRestoreBase
Тип Restore обеспечивает доступ к следующим элементам.
Конструкторы
Имя | Описание | |
---|---|---|
Restore() | Initializes a new instance of the Restore class. | |
Restore(String, BackupSet) | Initializes a new instance of the Restore class with specified destination database name and backup set. |
В начало
Свойства
Имя | Описание | |
---|---|---|
Action | Gets or sets the type of restore to be performed. | |
AsyncStatus | Возвращает асинхронное состояние процесса резервного копирования или восстановления. (Производный от BackupRestoreBase.) | |
BlockSize | Возвращает или задает размер физического блока в байтах для резервного копирования или восстановления. (Производный от BackupRestoreBase.) | |
BufferCount | Возвращает или задает общее число буферов ввода-вывода, которые будут использоваться для операции резервного копирования или восстановления. (Производный от BackupRestoreBase.) | |
Checksum | Возвращает или задает значение свойства типа Boolean, определяющего, будет ли рассчитано значение контрольной суммы при выполнении операций резервного копирования или восстановления. (Производный от 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 | Возвращает или задает значение свойства Boolean, определяющего, будет ли продолжено выполнение операции резервного копирования или восстановления после возникновения ошибки контрольной суммы. (Производный от BackupRestoreBase.) | |
Database | Возвращает или задает базу данных, в которой выполняются операции резервного копирования или восстановления. (Производный от BackupRestoreBase.) | |
DatabaseFileGroups | Возвращает файловые группы SQL Server, указанные при выполнении операций резервного копирования или восстановления. (Производный от BackupRestoreBase.) | |
DatabaseFiles | Возвращает файлы операционной системы, указанные при выполнении операций резервного копирования или восстановления. (Производный от BackupRestoreBase.) | |
DatabasePages | Gets the list of the restore pages. | |
Devices | Возвращает устройства резервного копирования, указанные для операций резервного копирования или восстановления. (Производный от 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 | Возвращает или задает максимальное число байтов, передаваемое между носителем резервных копий и экземпляром SQL Server. (Производный от BackupRestoreBase.) | |
MediaName | Возвращает или задает имя, используемое для идентификации определенного набора носителей. (Производный от BackupRestoreBase.) | |
NoRecovery | Возвращает или задает значение свойства Boolean, определяющее, будет ли выполняться резервное копирование конца журнала и будет ли выполнено восстановление базы данных до состояния восстановления. (Производный от BackupRestoreBase.) | |
NoRewind | Возвращает или задает значение свойства Boolean, определяющее, оставит ли Microsoft SQL Server ленту открытой после выполнения операции резервного копирования или восстановления. (Производный от 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 | Возвращает или задает значение интервала в процентах для вызовов обработчика событий PercentCompleteEventHandler. (Производный от BackupRestoreBase.) | |
RelocateFiles | Gets 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 | Возвращает или задает значение свойства типа Boolean, определяющего, будет ли перезапущена операция резервного копирования или восстановления в случае прерывания. (Производный от 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 | Возвращает или задает значение свойства Boolean, определяющего будет ли лента перемотана и выгружена после завершения операции резервного копирования или восстановления. (Производный от BackupRestoreBase.) |
В начало
Методы
Имя | Описание | |
---|---|---|
Abort | Завершает выполнение операции резервного копирования или восстановления. (Производный от BackupRestoreBase.) | |
ClearSuspectPageTable | Deletes entries in the suspect page table. | |
Equals | (Производный от Object.) | |
GetHashCode | (Производный от Object.) | |
GetType | (Производный от 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 instance of SQL Server. | |
Script | Generates a Transact-SQL script that can be used to re-create the restore operation. | |
SetMediaPassword(SecureString) | Устарело. Устанавливает пароль для набора носителей. (Производный от BackupRestoreBase.) | |
SetMediaPassword(String) | Устарело. Устанавливает пароль для набора носителей. (Производный от BackupRestoreBase.) | |
SetPassword(SecureString) | Устанавливает пароль для резервного набора данных. (Производный от BackupRestoreBase.) | |
SetPassword(String) | Устанавливает пароль для резервного набора данных. (Производный от BackupRestoreBase.) | |
SqlRestore | Performs a restore operation on the specified server. | |
SqlRestoreAsync | 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 | (Производный от Object.) | |
Wait | Ожидает завершения выполняемой операции резервного копирования или восстановления до перехода к следующему процессу. (Производный от BackupRestoreBase.) |
В начало
События
Имя | Описание | |
---|---|---|
Complete | Вызывается после завершения операции резервного копирования или восстановления. (Производный от BackupRestoreBase.) | |
Information | Вызывается при отправке информационного сообщения Microsoft SQL Server, которое не может быть обработано событиями Complete NextMedia или PercentComplete. (Производный от BackupRestoreBase.) | |
NextMedia | Возникает при завершении выполнения операции резервного копирования или восстановления на носителе на целевом устройстве. (Производный от BackupRestoreBase.) | |
PercentComplete | Вызывается, когда операция резервного копирования или восстановления достигает очередного уровня выполнения. (Производный от BackupRestoreBase.) |
В начало
Поля
Имя | Описание | |
---|---|---|
VerifyComplete | Specifies the VerifyCompleteEventHandler. |
В начало
Замечания
By using a Restore object you can do the following:
Restore all or part of a database.
Restore backup images of transaction log records.
Verify the integrity of backup media.
Report the contents of backup media.
Monitor a restore operation, reporting status to the user.
SQL Server can write a backup to one of four media types: disk, tape, named pipe, or a backup device. SQL Server supports backup striping. A striped backup is one directed to more than a single device. Striping is supported to a single media type only. That is, a backup can be written to two tape devices. Half of a backup cannot be written to a tape device and the other half to a disk.
At a minimum, supply values for a restore source when using a Restore object. Use one media type property to specify the restore operation source.
Setting other properties in the Restore object may be required by the restore operation desired.
Thread Safety
Все общие статические члены этого типа (Shared в Microsoft Visual Basic) можно использовать в многопоточных операциях. Потокобезопасная работа с членами экземпляров типа не гарантируется.
To get Restore object properties, users can be a member of the public fixed server role.
To set Restore object properties, users must have CREATE DATABASE permission on the server, or be a member of sysadmin or dbcreator fixed server roles, or be a member of db_owner fixed database role.
To perform a restore operation, users must have CREATE DATABASE permission on the server, or be a member of sysadmin or dbcreator fixed server roles. If the database already exists, then members of the db_owner fixed database role can also perform a restore operation.
Примеры
The following code example demonstrates how to create a normal and an asynchronous backup of the AdventureWorks2012 database and use each of those backups to restore it.
VB
'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks2012 database.
Dim db As Database
db = srv.Databases("AdventureWorks2012")
'Store the current recovery model in a variable.
Dim recoverymod As Integer
recoverymod = db.DatabaseOptions.RecoveryModel
'Define a Backup object variable.
Dim bk As New Backup
'Specify the type of backup, the description, the name, and the database to be backed up.
bk.Action = BackupActionType.Database
bk.BackupSetDescription = "Full backup of AdventureWorks2012"
bk.BackupSetName = "AdventureWorks2012 Backup"
bk.Database = "AdventureWorks2012"
'Declare a BackupDeviceItem by supplying the backup device file name in the constructor, and the type of device is a file.
Dim bdi As BackupDeviceItem
bdi = New BackupDeviceItem("Test_Full_Backup1", DeviceType.File)
'Add the device to the Backup object.
bk.Devices.Add(bdi)
'Set the Incremental property to False to specify that this is a full database backup.
bk.Incremental = False
'Set the expiration date.
Dim backupdate As New Date
backupdate = New Date(2006, 10, 5)
bk.ExpirationDate = backupdate
'Specify that the log must be truncated after the backup is complete.
bk.LogTruncation = BackupTruncateLogType.Truncate
'Run SqlBackup to perform the full database backup on the instance of SQL Server.
bk.SqlBackup(srv)
'Inform the user that the backup has been completed.
Console.WriteLine("Full Backup complete.")
'Remove the backup device from the Backup object.
bk.Devices.Remove(bdi)
'Make a change to the database: in this case, add a table called test_table.
Dim t As Table
t = New Table(db, "test_table")
Dim c As Column
c = New Column(t, "col", DataType.Int)
t.Columns.Add(c)
t.Create()
'Create another file device for the differential backup and add the Backup object.
Dim bdid As BackupDeviceItem
bdid = New BackupDeviceItem("Test_Differential_Backup1", DeviceType.File)
'Add the device to the Backup object.
bk.Devices.Add(bdid)
'Set the Incremental property to True for a differential backup.
bk.Incremental = True
'Run SqlBackup to perform the incremental database backup on the instance of SQL Server.
bk.SqlBackup(srv)
'Inform the user that the differential backup is complete.
Console.WriteLine("Differential Backup complete.")
'Remove the device from the Backup object.
bk.Devices.Remove(bdid)
'Delete the AdventureWorks2012 database before restoring it.
srv.Databases("AdventureWorks2012").Drop()
'Define a Restore object variable.
Dim rs As Restore
rs = New Restore
'Set the NoRecovery property to true, so the transactions are not recovered.
rs.NoRecovery = True
'Add the device that contains the full database backup to the Restore object.
rs.Devices.Add(bdi)
'Specify the database name.
rs.Database = "AdventureWorks2012"
'Restore the full database backup with no recovery.
rs.SqlRestore(srv)
'Inform the user that the Full Database Restore is complete.
Console.WriteLine("Full Database Restore complete.")
'Remove the device from the Restore object.
rs.Devices.Remove(bdi)
'Set te NoRecovery property to False.
rs.NoRecovery = False
'Add the device that contains the differential backup to the Restore object.
rs.Devices.Add(bdid)
'Restore the differential database backup with recovery.
rs.SqlRestore(srv)
'Inform the user that the differential database restore is complete.
Console.WriteLine("Differential Database Restore complete.")
'Remove the device.
rs.Devices.Remove(bdid)
'Set the database recovery mode back to its original value.
srv.Databases("AdventureWorks2012").DatabaseOptions.RecoveryModel = recoverymod
'Drop the table that was added.
srv.Databases("AdventureWorks2012").Tables("test_table").Drop()
srv.Databases("AdventureWorks2012").Alter()
'Remove the backup files from the hard disk.
My.Computer.FileSystem.DeleteFile("C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Backup\Test_Full_Backup1")
My.Computer.FileSystem.DeleteFile("C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Backup\Test_Differential_Backup1")
Powershell
$srv = new-object Microsoft.SqlServer.Management.Smo.Server("(local)")
$db = New-Object Microsoft.SqlServer.Management.Smo.Database
$db = $srv.Databases.Item("AdventureWorks2012")
$rs = new-object Microsoft.SqlServer.Management.Smo.Restore
$rs.NoRecovery = $TRUE
$rs.Devices.Add($bdi)
$recoverymod = $db.DatabaseOptions.RecoveryModel
$bk = new-object Microsoft.SqlServer.Management.Smo.Backup
$bk.Action = [Microsoft.SqlServer.Management.Smo.BackupActionType]::Database
$bk.BackupSetDescription = "Full backup of AdventureWorks2012"
$bk.BackupSetName = "AdventureWorks2012 Backup"
$bk.Database = "AdventureWorks2012"
$bdi = new-object Microsoft.SqlServer.management.Smo.BackupDeviceItem("Test_Full_Backup1", [Microsoft.SqlServer.Management.Smo.DeviceType]::File)
$bk.Devices.Add($bdi)
$bk.Incremental = $FALSE
$backupdate = new-object System.DateTime(2009, 3, 2)
$bk.ExpirationDate = $backupdate
$bk.LogTruncation = [Microsoft.SqlServer.Management.Smo.BackupTruncateLogType]::Truncate
$bk.SqlBackup($srv)
Write-Host "Full Backup complete."
$bk.Devices.Remove($bdi)
$t = new-object Microsoft.SqlServer.Management.Smo.Table($db, "test_table")
$c = new-object Microsoft.SqlServer.Management.Smo.Column($t, "col", [Microsoft.SqlServer.Management.Smo.DataType]::Int)
$t.Columns.Add($c)
$t.Create()
$bdid = new-object Microsoft.SqlServer.Management.Smo.BackupDeviceItem("Test_Differential_Backup1", [Microsoft.SqlServer.Management.Smo.DeviceType]::File)
$bk.Devices.Add($bdid)
$bk.Incremental = $TRUE
$bk.SqlBackup($srv)
Write-Host "Differential Backup complete."
$bk.Devices.Remove($bdid)
$rs.Database = "AdventureWorks2012"
$srv.Databases["AdventureWorks2012"].Drop()
$rs.SqlRestore($srv)
Write-Host "Full Database Restore complete."
$rs.Devices.Remove($bdi)
$rs.NoRecovery = $FALSE
$rs.Devices.Add($bdid)
$rs.SqlRestore($srv)
Write-Host "Differential Database Restore complete."
$rs.Devices.Remove($bdid)
$srv.Databases["AdventureWorks2012"].DatabaseOptions.RecoveryModel = $recoverymod
$srv.Databases["AdventureWorks2012"].Tables["test_table"].Drop()
$srv.Databases["AdventureWorks2012"].Alter()
remove-item C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Backup\Test_Full_Backup1
remove-item C:\Program Files\Microsoft SQL Server\MSSQL.1\MSSQL\Backup\Test_Differential_Backup1
Безопасность многопоточности
Любые открытые статический (Shared в Visual Basic) элементы этого типа потокобезопасны. Потокобезопасность с элементами экземпляров не гарантируется.
См. также
Справочник
Пространство имен Microsoft.SqlServer.Management.Smo
Другие ресурсы
Резервное копирование и восстановление баз данных SQL Server
Резервное копирование и восстановление баз данных и журналов транзакций из копий