Backup Class

Definition

public sealed class Backup : Microsoft.SqlServer.Management.Smo.BackupRestoreBase
type Backup = class
    inherit BackupRestoreBase
Public NotInheritable Class Backup
Inherits BackupRestoreBase
Inheritance

Constructors

Backup()

Fields

currentAsyncOperation (Inherited from BackupRestoreBase)
m_BackupAction (Inherited from BackupRestoreBase)
m_LogTruncation (Inherited from BackupRestoreBase)
m_RestoreAction (Inherited from BackupRestoreBase)

Properties

Action
AsyncStatus

A status of most recent asynchronous operation, including possible errors.

(Inherited from BackupRestoreBase)
BackupSetDescription
BackupSetName
BlockSize (Inherited from BackupRestoreBase)
BufferCount (Inherited from BackupRestoreBase)
Checksum (Inherited from BackupRestoreBase)
CompressionOption

The CompressionOption property specifies backup compression option

ContinueAfterError (Inherited from BackupRestoreBase)
CopyOnly
CredentialName

Gets or sets the credential name that is used by Backup to Url

(Inherited from BackupRestoreBase)
Database (Inherited from BackupRestoreBase)
DatabaseFileGroups (Inherited from BackupRestoreBase)
DatabaseFiles (Inherited from BackupRestoreBase)
Devices

A list of devices used as a target for backup

(Inherited from BackupRestoreBase)
EncryptionOption

The EncryptionOption property specifies backup encryption option.

ExpirationDate
FormatMedia
Incremental
Initialize
LogTruncation
MaxTransferSize (Inherited from BackupRestoreBase)
MediaDescription
MediaName (Inherited from BackupRestoreBase)
Mirrors

Mirrors

NoRecovery (Inherited from BackupRestoreBase)
NoRewind (Inherited from BackupRestoreBase)
PercentCompleteNotification (Inherited from BackupRestoreBase)
Restart (Inherited from BackupRestoreBase)
RetainDays
RetryFailedQueries (Inherited from BackupRestoreBase)
SkipTapeHeader
UndoFileName
UnloadTapeAfter (Inherited from BackupRestoreBase)

Methods

Abort()

Aborts the current action, if any

(Inherited from BackupRestoreBase)
CheckForHADRMaintPlan(Server, StringBuilder)

If invoked from Maintenance plan Check if HADR is enabled

(Inherited from BackupRestoreBase)
ExecuteSql(Server, StringCollection) (Inherited from BackupRestoreBase)
ExecuteSqlAsync(Server, StringCollection) (Inherited from BackupRestoreBase)
ExecuteSqlWithResults(Server, String) (Inherited from BackupRestoreBase)
GetDevicesScript(StringBuilder, BackupDeviceList, ServerVersion) (Inherited from BackupRestoreBase)
IsStringValid(String) (Inherited from BackupRestoreBase)
Script(Server)

Generates script for the current backup operation

SetMediaPassword(SecureString)
Obsolete.
(Inherited from BackupRestoreBase)
SetMediaPassword(String)
Obsolete.
(Inherited from BackupRestoreBase)
SetPassword(SecureString) (Inherited from BackupRestoreBase)
SetPassword(String) (Inherited from BackupRestoreBase)
SqlBackup(Server)

Runs backup operation synchronously, i.e. the function call blocks untill the backup is done.

SqlBackupAsync(Server)

Runs backup operation asynchronously, i.e. the call returns immediately, and the backup operation runs in the background

Wait()

Waits for the current asynchronous action to complete.

(Inherited from BackupRestoreBase)

Events

Complete

Complete event

(Inherited from BackupRestoreBase)
Information

Information event

(Inherited from BackupRestoreBase)
NextMedia

NextMedia event

(Inherited from BackupRestoreBase)
PercentComplete

PercentComplete event

(Inherited from BackupRestoreBase)

Applies to