Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

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)
public sealed class Backup : BackupRestoreBase

The Backup type exposes the following members.

  NameDescription
Public methodBackupInitializes a new instance of the Backup class.
Top
  NameDescription
Public propertyActionGets or sets the type of backup to be performed.
Public propertyAsyncStatusGets the asynchronous status of a backup or restore process. (Inherited from BackupRestoreBase.)
Public propertyBackupSetDescriptionGets or sets a textual description for a particular backup set.
Public propertyBackupSetNameGets or sets the name used to identify a particular backup set.
Public propertyBlockSizeGets or sets the physical block size of the backup or restore, in bytes. (Inherited from BackupRestoreBase.)
Public propertyBufferCountGets or sets the total number of I/O buffers to be used for the backup or restore operation. (Inherited from BackupRestoreBase.)
Public propertyChecksumGets or sets a Boolean property value that determines whether a checksum value is calculated during backup or restore operations. (Inherited from BackupRestoreBase.)
Public propertyCompressionOptionGets or sets the compression option for the current backup session and is transient to the Backup Object Microsoft.SqlServer.Management.SmoExtended.Backup
Public propertyContinueAfterErrorGets or sets a Boolean property value that determines whether the backup or restore continues after a checksum error occurs. (Inherited from BackupRestoreBase.)
Public propertyCopyOnlyGets 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.
Public propertyDatabaseGets or sets the database on which the backup or restore operation runs. (Inherited from BackupRestoreBase.)
Public propertyDatabaseFileGroupsGets the SQL Server file groups targeted by the backup or restore operation. (Inherited from BackupRestoreBase.)
Public propertyDatabaseFilesGets the operating system files targeted by the backup or restore operation. (Inherited from BackupRestoreBase.)
Public propertyDevicesGets the backup devices specified for the backup or restore operation. (Inherited from BackupRestoreBase.)
Public propertyExpirationDateGets or sets the date and time when the backup set expires and the backup data is no longer considered relevant.
Public propertyFormatMediaGets or sets a Boolean property value that determines whether a tape is formatted as the first step of the backup operation.
Public propertyIncrementalGets or sets a Boolean property value that determines whether to perform a differential backup.
Public propertyInitializeGets or sets a Boolean property value that determines whether the devices associated with a backup operation are initialized as part of the backup operation.
Public propertyLogTruncationGets or sets the method used to truncate the database log as part of the backup operation.
Public propertyMaxTransferSizeGets or sets the maximum number of bytes to be transferred between the backup media and the instance of SQL Server. (Inherited from BackupRestoreBase.)
Public propertyMediaDescriptionGets or sets a textual description of the medium that contains a backup set.
Public propertyMediaNameGets or sets the name used to identify a particular media set. (Inherited from BackupRestoreBase.)
Public propertyMirrorsGets or sets the list of backup devices used by the mirrored backup.
Public propertyNoRecoveryGets 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.)
Public propertyNoRewindGets 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.)
Public propertyPercentCompleteNotificationGets or sets the percentage interval for PercentCompleteEventHandler event handler calls. (Inherited from BackupRestoreBase.)
Public propertyRestartGets or sets a Boolean property value that determines whether the backup or restore operation will restart if it is interrupted. (Inherited from BackupRestoreBase.)
Public propertyRetainDaysGets or sets the number of days that must elapse before a backup set can be overwritten.
Public propertySkipTapeHeaderGets or sets Boolean property that determines whether the tape header is read.
Public propertyUndoFileNameGets or sets the name of the undo file used to store uncommitted transactions that are rolled back during recovery.
Public propertyUnloadTapeAfterGets 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
  NameDescription
Public methodAbortTerminates a running backup or restore operation. (Inherited from BackupRestoreBase.)
Public methodEquals (Inherited from Object.)
Protected methodExecuteSqlExecutes a batch of Transact-SQL statements that does not expect a returned results set on the specified instance of SQL Server. (Inherited from BackupRestoreBase.)
Protected methodExecuteSqlAsyncExecutes 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.)
Protected methodExecuteSqlWithResultsExecutes a batch of Transact-SQL statements that expects one or more returned results sets on the specified instance of SQL Server. (Inherited from BackupRestoreBase.)
Protected methodFinalize (Inherited from Object.)
Protected methodGetDevicesScriptGets the script that is used to create devices. (Inherited from BackupRestoreBase.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodIsStringValidVerifies whether the specified string is valid. (Inherited from BackupRestoreBase.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodScriptReturns a Transact-SQL statement that can be used to execute the referenced backup.
Public methodSetMediaPassword(SecureString)Sets the password for a media set. (Inherited from BackupRestoreBase.)
Public methodSetMediaPassword(String)Sets the password for a media set. (Inherited from BackupRestoreBase.)
Public methodSetPassword(SecureString)Sets the password for a backup set. (Inherited from BackupRestoreBase.)
Public methodSetPassword(String)Sets the password for a backup set. (Inherited from BackupRestoreBase.)
Public methodSqlBackupPerforms the database backup operation as specified by the properties of the Backup object used.
Public methodSqlBackupAsyncPerforms the database backup operation asynchronously as specified by the properties of the Backup object used.
Public methodToString (Inherited from Object.)
Public methodWaitWaits for the current backup or restore operation to complete before moving on to the next process. (Inherited from BackupRestoreBase.)
Top
  NameDescription
Public eventCompleteOccurs when the backup or restore operation completes. (Inherited from BackupRestoreBase.)
Public eventInformationOccurs when any informational message is issued by Microsoft SQL Server that cannot be handled by the Complete NextMedia or PercentComplete events. (Inherited from BackupRestoreBase.)
Public eventNextMediaOccurs when the backup or restore operation exhausts the medium in a target device. (Inherited from BackupRestoreBase.)
Public eventPercentCompleteOccurs when a backup or restore operation reaches a completion unit. (Inherited from BackupRestoreBase.)
Top
  NameDescription
Protected fieldcurrentAsyncOperationSpecifies the current asynchronous operation, such as backup, restore, or none. (Inherited from BackupRestoreBase.)
Protected fieldm_BackupActionSpecifies the backup action type, such as database or log. (Inherited from BackupRestoreBase.)
Protected fieldm_LogTruncationSpecifies whether to truncate the log. (Inherited from BackupRestoreBase.)
Protected fieldm_RestoreActionSpecifies the restore action type, such as database or log. (Inherited from BackupRestoreBase.)
Top

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.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.