Backup Members
The Backup object provides programmatic access to Microsoft SQL Server backup operations.
The following tables list the members exposed by the Backup type.
Protected Fields
Name | Description | |
---|---|---|
currentAsyncOperation | (inherited from BackupRestoreBase ) | |
m_BackupAction | (inherited from BackupRestoreBase ) | |
m_LogTruncation | (inherited from BackupRestoreBase ) | |
m_RestoreAction | (inherited from BackupRestoreBase ) |
Top
Public Properties
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 block size unit to be used when formatting tapes as part of a backup. (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. This property is not CLS-compliant. (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. This property is not CLS-compliant. | |
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) |
Top
Public Methods
(see also Protected Methods )
Name | Description | |
---|---|---|
Abort | Terminates a running backup or restore operation. (inherited from BackupRestoreBase) | |
Equals | Overloaded. (inherited from Object ) | |
GetHashCode | (inherited from Object ) | |
GetType | (inherited from Object ) | |
ReferenceEquals | (inherited from Object ) | |
Script | Returns a Transact-SQL statement that can be used to execute the referenced backup. | |
SetMediaPassword | Overloaded. (inherited from BackupRestoreBase ) | |
SetPassword | Overloaded. (inherited from BackupRestoreBase ) | |
SqlBackup | Performs the database backup operation as specified by the properties of the Backup object used. | |
SqlBackupAsync | 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) |
Top
Protected Methods
Name | Description | |
---|---|---|
ExecuteSql | (inherited from BackupRestoreBase ) | |
ExecuteSqlAsync | (inherited from BackupRestoreBase ) | |
ExecuteSqlWithResults | (inherited from BackupRestoreBase ) | |
Finalize | (inherited from Object ) | |
GetDevicesScript | (inherited from BackupRestoreBase ) | |
IsStringValid | (inherited from BackupRestoreBase ) | |
MemberwiseClone | (inherited from Object ) |
Top
Public Events
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 CompleteNextMedia 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) |
Top
See Also