Restore-Klasse

Artikel
07/13/2013

The Restore object provides programmatic access to restore operations.

Vererbungshierarchie

System.Object
Microsoft.SqlServer.Management.Smo.BackupRestoreBase
Microsoft.SqlServer.Management.Smo.Restore

Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.SmoExtended (in Microsoft.SqlServer.SmoExtended.dll)

Syntax

'Declaration
Public NotInheritable Class Restore _
    Inherits BackupRestoreBase
'Usage
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

Der Restore-Typ macht folgende Elemente verfügbar.

Konstruktoren

	Name	Beschreibung
	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.

Zum Anfang

Eigenschaften

	Name	Beschreibung
	Action	Gets or sets the type of restore to be performed.
	AsyncStatus	Ruft den asynchronen Status eines Sicherungs- oder Wiederherstellungsvorgangs ab. (Geerbt von BackupRestoreBase.)
	BlockSize	Ruft die physische Blockgröße der Sicherung oder Wiederherstellung in Bytes ab oder legt sie fest. (Geerbt von BackupRestoreBase.)
	BufferCount	Ruft die Gesamtanzahl von E/A-Puffern ab, die für den Sicherungs- oder Wiederherstellungsvorgang verwendet werden sollen, oder legt sie fest. (Geerbt von BackupRestoreBase.)
	Checksum	Ruft einen Boolean-Eigenschaftswert ab, der bestimmt, ob im Verlauf von Sicherungs- oder Wiederherstellungsvorgängen ein Prüfsummenwert berechnet wird, oder legt ihn fest. (Geerbt von 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	Ruft einen Boolean-Eigenschaftswert ab, der bestimmt, ob die Sicherung oder Wiederherstellung nach einem Prüfsummenfehler fortgesetzt wird, oder legt ihn fest. (Geerbt von BackupRestoreBase.)
	Database	Ruft die Datenbank ab, auf der der Sicherungs- oder Wiederherstellungsvorgang ausgeführt wird, oder legt sie fest. (Geerbt von BackupRestoreBase.)
	DatabaseFileGroups	Ruft die SQL Server-Dateigruppen ab, die Ziel des Sicherungs- oder Wiederherstellungsvorgangs sind. (Geerbt von BackupRestoreBase.)
	DatabaseFiles	Ruft die Betriebssystemdateien ab, die Ziel des Sicherungs- oder Wiederherstellungsvorgangs sind. (Geerbt von BackupRestoreBase.)
	DatabasePages	Gets the list of the restore pages.
	Devices	Ruft die für den Sicherungs- oder Wiederherstellungsvorgang angegebenen Sicherungsmedien ab. (Geerbt von 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	Ruft die maximale Anzahl von Bytes ab, die zwischen den Sicherungsmedien und der SQL Server-Instanz übertragen werden sollen, oder legt sie fest. (Geerbt von BackupRestoreBase.)
	MediaName	Ruft den Namen ab, der zur Identifikation eines bestimmten Mediensatzes verwendet wurde, oder legt ihn fest. (Geerbt von BackupRestoreBase.)
	NoRecovery	Ruft einen Boolean-Eigenschaftswert ab, der bestimmt, ob das Protokollfragment gesichert und die Datenbank in den Wiederherstellungsstatus wiederhergestellt wird, oder legt ihn fest. (Geerbt von BackupRestoreBase.)
	NoRewind	Ruft einen Boolean-Eigenschaftswert ab, der bestimmt, ob Microsoft SQL Server das Band nach dem Sicherungs- oder Wiederherstellungsvorgang offen hält, oder legt ihn fest. (Geerbt von 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	Ruft das Prozentintervall für Aufrufe des PercentCompleteEventHandler-Ereignishandlers ab oder legt es fest. (Geerbt von 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	Ruft einen Boolean-Eigenschaftswert ab, der bestimmt, ob der Sicherungs- oder Wiederherstellungsvorgang bei einer Unterbrechung neu gestartet wird, oder legt ihn fest. (Geerbt von 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	Ruft einen Boolean-Eigenschaftswert ab, der bestimmt, ob Bandmedien zurückgespult und nach Ende des Sicherungs- oder Wiederherstellungsvorgangs entladen werden, oder legt ihn fest. (Geerbt von BackupRestoreBase.)

Zum Anfang

Methoden

	Name	Beschreibung
	Abort	Beendet einen laufenden Sicherungs- oder Wiederherstellungsvorgang. (Geerbt von BackupRestoreBase.)
	ClearSuspectPageTable	Deletes entries in the suspect page table.
	Equals	(Geerbt von Object.)
	GetHashCode	(Geerbt von Object.)
	GetType	(Geerbt von 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)	Veraltet Legt das Kennwort für einen Mediensatz fest. (Geerbt von BackupRestoreBase.)
	SetMediaPassword(String)	Veraltet Legt das Kennwort für einen Mediensatz fest. (Geerbt von BackupRestoreBase.)
	SetPassword(SecureString)	Legt das Kennwort für einen Sicherungssatz fest. (Geerbt von BackupRestoreBase.)
	SetPassword(String)	Legt das Kennwort für einen Sicherungssatz fest. (Geerbt von 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	(Geerbt von Object.)
	Wait	Wartet das Ende des aktuellen Sicherungs- oder Wiederherstellungsvorgangs ab, bevor der nächste Prozess gestartet wird. (Geerbt von BackupRestoreBase.)

Zum Anfang

Ereignisse

	Name	Beschreibung
	Complete	Tritt auf, sobald der Sicherungs- oder Wiederherstellungsvorgang abgeschlossen ist. (Geerbt von BackupRestoreBase.)
	Information	Tritt auf, wenn eine beliebige Informationsmeldung von Microsoft SQL Server ausgegeben wird, die von den Ereignissen NextMedia, PercentComplete oder Complete nicht behandelt werden kann. (Geerbt von BackupRestoreBase.)
	NextMedia	Tritt auf, wenn die Kapazität des Mediums in einem Zielgerät vom Sicherungs- oder Wiederherstellungsvorgang aufgebraucht ist. (Geerbt von BackupRestoreBase.)
	PercentComplete	Tritt auf, wenn bei einem Sicherungs- oder Wiederherstellungsvorgang eine Abschlusseinheit erreicht wird. (Geerbt von BackupRestoreBase.)

Zum Anfang

Felder

	Name	Beschreibung
	VerifyComplete	Specifies the VerifyCompleteEventHandler.

Zum Anfang

Hinweise

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

Alle öffentlichen, statischen Elemente dieses Typs (Shared in Microsoft Visual Basic) sind für Vorgänge mit mehreren Threads sicher. Bei Instanzmembern ist die Threadsicherheit nicht gewährleistet.

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.

Beispiele

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.

'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

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.