.png)
Backup Members
SQL Server 2008
The Backup object provides programmatic access to Microsoft SQL Server backup operations.
The Backup type exposes the following members.
| Name | Description | |
|---|---|---|
|
Abort() | Terminates a running backup or restore operation. (Inherited from BackupRestoreBase.) |
|
|
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.) |
|
|
Script(Server) | Returns a Transact-SQL statement that can be used to execute the referenced backup. |
|
|
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.) |
|
|
SqlBackup(Server) | Performs the database backup operation as specified by the properties of the Backup object used. |
|
|
SqlBackupAsync(Server) | Performs the database backup operation asynchronously as specified by the properties of the Backup object used. |
|
|
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.) |
| Name | Description | |
|---|---|---|
|
|
currentAsyncOperation | (Inherited from BackupRestoreBase.) |
|
|
m_BackupAction | (Inherited from BackupRestoreBase.) |
|
|
m_LogTruncation | (Inherited from BackupRestoreBase.) |
|
|
m_RestoreAction | (Inherited from BackupRestoreBase.) |
| Name | Description | |
|---|---|---|
|
|
Action | Gets or sets the type of backup to be performed. |
|
|
AsyncStatus | Gets the asynchronous status of a backup or restore process. (Inherited from BackupRestoreBase.) |
|
|
BackupSetDescription | Gets or sets a textual description for a particular backup set. |
|
|
BackupSetName | Gets or sets the name used to identify a particular backup set. |
|
|
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.) |
|
|
CompressionOption | Gets or sets the compression option for the current backup session and is transient to the Backup Object Microsoft.SqlServer.Management.SmoExtended.Backup |
|
|
ContinueAfterError | Gets or sets a Boolean property value that determines whether the backup or restore continues after a checksum error occurs. (Inherited from BackupRestoreBase.) |
|
|
CopyOnly | Gets or sets a Boolean property value that specifies the backup is a copy-only backup. This does not affect the sequence of backups in the usual backup schedule. |
|
|
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.) |
|
|
ExpirationDate | Gets or sets the date and time when the backup set expires and the backup data is no longer considered relevant. |
|
|
FormatMedia | Gets or sets a Boolean property value that determines whether a tape is formatted as the first step of the backup operation. |
|
|
Incremental | Gets or sets a Boolean property value that determines whether to perform a differential backup. |
|
|
Initialize | Gets or sets a Boolean property value that determines whether the devices associated with a backup operation are initialized as part of the backup operation. |
|
|
LogTruncation | Gets or sets the method used to truncate the database log as part of the backup 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.) |
|
|
MediaDescription | Gets or sets a textual description of the medium that contains a backup set. |
|
|
MediaName | Gets or sets the name used to identify a particular media set. (Inherited from BackupRestoreBase.) |
|
|
Mirrors | Gets or sets the list of backup devices used by the mirrored backup. |
|
|
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.) |
|
|
PercentCompleteNotification | Gets or sets the percentage interval for PercentCompleteEventHandler event handler calls. (Inherited from BackupRestoreBase.) |
|
|
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.) |
|
|
RetainDays | Gets or sets the number of days that must elapse before a backup set can be overwritten. |
|
|
SkipTapeHeader | Gets or sets Boolean property that determines whether the tape header is read. |
|
|
UndoFileName | Gets or sets the name of the undo file used to store uncommitted transactions that are rolled back during recovery. |
|
|
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.) |
| 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.) |
