• Article

BackupRestoreBase Members

Include Protected Members
Include Inherited Members

The BackupRestoreBase class is a base class that represents functionality that is common to both backup and restore operations.

The BackupRestoreBase type exposes the following members.

Constructors

  Name Description
Public method BackupRestoreBase() Initializes a new instance of the BackupRestoreBase class.

Top

Methods

  Name Description
Public method Abort() Terminates a running backup or restore operation.
Public method Equals(Object) (Inherited from Object.)
Protected method 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.
Protected method 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.
Protected method 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.
Protected method Finalize() (Inherited from Object.)
Protected method GetDevicesScript(StringBuilder, BackupDeviceList, ServerVersion)
Public method GetHashCode() (Inherited from Object.)
Public method GetType() (Inherited from Object.)
Protected method IsStringValid(String) Verifies whether the specified string is valid.
Protected method MemberwiseClone() (Inherited from Object.)
Public method SetMediaPassword(SecureString) Sets the password for a media set.
Public method SetMediaPassword(String) Sets the password for a media set.
Public method SetPassword(SecureString) Sets the password for a backup set.
Public method SetPassword(String) Sets the password for a backup set.
Public method ToString() (Inherited from Object.)
Public method Wait() Waits for the current backup or restore operation to complete before moving on to the next process.

Top

Properties

  Name Description
Public property AsyncStatus Gets the asynchronous status of a backup or restore process.
Public property BlockSize Gets or sets the physical block size of the backup or restore, in bytes.
Public property BufferCount Gets or sets the total number of I/O buffers to be used for the backup or restore operation.
Public property Checksum Gets or sets a Boolean property value that determines whether a checksum value is calculated during backup or restore operations.
Public property ContinueAfterError Gets or sets a Boolean property value that determines whether the backup or restore continues after a checksum error occurs.
Public property Database Gets or sets the database on which the backup or restore operation runs.
Public property DatabaseFileGroups Gets the SQL Server file groups targeted by the backup or restore operation.
Public property DatabaseFiles Gets the operating system files targeted by the backup or restore operation.
Public property Devices Gets the backup devices specified for the backup or restore operation.
Public property MaxTransferSize Gets or sets the maximum number of bytes to be transferred between the backup media and the instance of SQL Server.
Public property MediaName Gets or sets the name used to identify a particular media set.
Public property 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.
Public property 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.
Public property PercentCompleteNotification Gets or sets the percentage interval for PercentCompleteEventHandler event handler calls.
Public property Restart Gets or sets a Boolean property value that determines whether the backup or restore operation will restart if it is interrupted.
Public property UnloadTapeAfter Gets or sets a Boolean property value that determines whether tape media are rewound and unloaded after the backup or restore operation completes.

Top

Events

  Name Description
Public event Complete Occurs when the backup or restore operation completes.
Public event Information Occurs when any informational message is issued by Microsoft SQL Server that cannot be handled by the Complete NextMedia or PercentComplete events.
Public event NextMedia Occurs when the backup or restore operation exhausts the medium in a target device.
Public event PercentComplete Occurs when a backup or restore operation reaches a completion unit.

Top