RestorePlan Class

Represents a sequence of Database Restore operations which will recover a database to a particular state in a point in time.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.RestorePlan

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

Syntax

'Declaration
Public Class RestorePlan
'Usage
Dim instance As RestorePlan
public class RestorePlan
public ref class RestorePlan
type RestorePlan =  class end
public class RestorePlan

The RestorePlan type exposes the following members.

Constructors

  Name Description
Public method RestorePlan(Database) Initializes a new instance of the RestorePlan class with specified database.
Public method RestorePlan(Server) Initializes a new instance of the RestorePlan class with specified server.
Public method RestorePlan(Server, String) Initializes a new instance of the RestorePlan class with specified server and database name.

Top

Properties

  Name Description
Public property AsyncStatus Gets the status of most recent asynchronous operation including possible errors.
Public property CloseExistingConnections Gets or sets a value indicating whether to close existing connections.
Public property DatabaseName Gets or sets the name of the database.
Public property RestoreAction Gets and sets the type of the Restore action: Database,File,Log,Page.
Public property RestoreOperations Gets or sets the restore operations.
Public property Server Gets or sets the erver where the Restore plan executes.
Public property TailLogBackupOperation Gets or sets the tail log backup operation.

Top

Methods

  Name Description
Public method AddRestoreOperation(BackupSet) Adds the restore operation with specified backup set to be restored.
Public method AddRestoreOperation(List<BackupSet>) Adds the restore operations with specified backup sets..
Public method Equals (Inherited from Object.)
Public method Execute Verifies and executes the Restore Plan.
Public method ExecuteAsync Verifies and executes the Restore Plan async.
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method Script Verifies the Restore plan and scripts the operation.
Public method SetRestoreOptions Sets the restore options.
Public method ToString (Inherited from Object.)
Public method Verify Verifies the restore plan.

Top

Events

  Name Description
Public event Complete Occurs when the restore plan is completed.
Public event Information Occurs when the server sends information.
Public event NextMedia Occurs when the next media needs to be loaded.
Public event NextRestore Occurs when the next restore occurs.
Public event PercentComplete Occurs when the server sends percent complete information.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace