Backup Class

 

The Backup object provides programmatic access to Microsoft SQL Server backup operations.

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

System.Object
  Microsoft.SqlServer.Management.Smo.BackupRestoreBase
    Microsoft.SqlServer.Management.Smo.Backup

No code example is currently available or this language may not be supported.

NameDescription
System_CAPS_pubmethodBackup()

Initializes a new instance of the Backup class.

NameDescription
System_CAPS_pubpropertyAction

Gets or sets the type of backup to be performed.

System_CAPS_pubpropertyAsyncStatus

Gets the asynchronous status of a backup or restore process.(Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyBackupSetDescription

Gets or sets a textual description for a particular backup set.

System_CAPS_pubpropertyBackupSetName

Gets or sets the name used to identify a particular backup set.

System_CAPS_pubpropertyBlockSize

Gets or sets the physical block size of the backup or restore, in bytes. (Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyBufferCount

Gets or sets the total number of I/O buffers to be used for the backup or restore operation. (Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyChecksum

Gets or sets a Boolean property value that determines whether a checksum value is calculated during backup or restore operations. (Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyCompressionOption

Gets or sets the backup compression option.

System_CAPS_pubpropertyContinueAfterError

Gets or sets a Boolean property value that determines whether the backup or restore continues after a checksum error occurs. (Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyCopyOnly

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.

System_CAPS_pubpropertyCredentialName

Gets or sets the Credential property value, which is used to authenticate to the Windows Azure storage account.(Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyDatabase

Gets or sets the database on which the backup or restore operation runs. (Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyDatabaseFileGroups

Gets the SQL Server file groups targeted by the backup or restore operation. (Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyDatabaseFiles

Gets the operating system files targeted by the backup or restore operation. (Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyDevices

Gets the backup devices specified for the backup or restore operation. (Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyEncryptionOption

Gets or sets the backup encryption option.

System_CAPS_pubpropertyExpirationDate

Gets or sets the date and time when the backup set expires and the backup data is no longer considered relevant.

System_CAPS_pubpropertyFormatMedia

Gets or sets a Boolean property value that determines whether a tape is formatted as the first step of the backup operation.

System_CAPS_pubpropertyIncremental

Gets or sets a Boolean property value that determines whether to perform a differential backup.

System_CAPS_pubpropertyInitialize

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.

System_CAPS_pubpropertyLogTruncation

Gets or sets the method used to truncate the database log as part of the backup operation.

System_CAPS_pubpropertyMaxTransferSize

Gets or sets the maximum number of bytes to be transferred between the backup media and the instance of SQL Server. (Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyMediaDescription

Gets or sets a textual description of the medium that contains a backup set.

System_CAPS_pubpropertyMediaName

Gets or sets the name used to identify a particular media set. (Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyMirrors

Gets or sets the list of backup devices used by the mirrored backup.

System_CAPS_pubpropertyNoRecovery

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.)

System_CAPS_pubpropertyNoRewind

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.)

System_CAPS_pubpropertyPercentCompleteNotification

Gets or sets the percentage interval for PercentCompleteEventHandler event handler calls. (Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyRestart

Gets or sets a Boolean property value that determines whether the backup or restore operation will restart if it is interrupted. (Inherited from BackupRestoreBase.)

System_CAPS_pubpropertyRetainDays

Gets or sets the number of days that must elapse before a backup set can be overwritten.

System_CAPS_pubpropertySkipTapeHeader

Gets or sets Boolean property that determines whether the tape header is read.

System_CAPS_pubpropertyUndoFileName

Gets or sets the name of the undo file used to store uncommitted transactions that are rolled back during recovery.

System_CAPS_pubpropertyUnloadTapeAfter

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.)

NameDescription
System_CAPS_pubmethodAbort()

Terminates a running backup or restore operation. (Inherited from BackupRestoreBase.)

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodScript(Server)

Returns a String containing the Transact-SQL statement that can be used to execute the referenced backup.

System_CAPS_pubmethodSetMediaPassword(SecureString)

Obsolete. Sets the password for a media set. (Inherited from BackupRestoreBase.)

System_CAPS_pubmethodSetMediaPassword(String)

Obsolete. Sets the password for a media set. (Inherited from BackupRestoreBase.)

System_CAPS_pubmethodSetPassword(SecureString)

Sets the password for a backup set. (Inherited from BackupRestoreBase.)

System_CAPS_pubmethodSetPassword(String)

Sets the password for a backup set. (Inherited from BackupRestoreBase.)

System_CAPS_pubmethodSqlBackup(Server)

Performs the database backup operation as specified by the properties of the Backup object used.

System_CAPS_pubmethodSqlBackupAsync(Server)

Performs the database backup operation asynchronously as specified by the properties of the Backup object used.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodWait()

Waits for the current backup or restore operation to complete before moving on to the next process.(Inherited from BackupRestoreBase.)

NameDescription
System_CAPS_pubeventComplete

Occurs when the backup or restore operation completes. (Inherited from BackupRestoreBase.)

System_CAPS_pubeventInformation

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.)

System_CAPS_pubeventNextMedia

Occurs when the backup or restore operation exhausts the medium in a target device. (Inherited from BackupRestoreBase.)

System_CAPS_pubeventPercentComplete

Occurs when a backup or restore operation reaches a completion unit. (Inherited from BackupRestoreBase.)

A Backup object allows you to do the following:

  • Back up a SQL Server database or database transaction log.

  • Generate a Transact-SQL BACKUP statement defining a backup.

  • Monitor a backup operation, reporting status to the user.

For SQL Server, a database delimits the largest backup unit. Although many different database backup images can be maintained on any single medium, a backup cannot span more than a single database. By default, backup operations performed with a Backup object back up a complete database.

SQL Server can write a backup to one of the following media types: disk, tape, or a proprietary medium called a backup device.

SQL Server supports backup striping. A striped backup is one directed to more than a single device. When striped, a backup is written across the devices in equal chunks. Striping is supported to a single media type only. For example, a backup can be written to two tape devices, but SQL Server cannot write part of a backup to a tape device and the rest to a disk.

At a minimum, you must supply values for a backup source and a backup target when using a Backup object. The Database property (inherited from BackupRestoreBase class) specifies the backup operation source.

To get Backup object properties, users can be a member of the public fixed server role.

To set Backup object properties, users must have BACKUP DATABASE or BACKUP LOG permissions on the database, or be a member of the db_owner and db_backupoperator fixed database role and the sysadmin fixed server role.

To run the SqlBackup method, users must have BACKUP DATABASE or BACKUP LOG permissions on the database, or be a member of the db_owner and db_backupoperator fixed database role and the sysadmin fixed server role.

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

Return to top
Show: