Backup 类

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

继承层次结构

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

命名空间:  Microsoft.SqlServer.Management.Smo
程序集:  Microsoft.SqlServer.SmoExtended(在 Microsoft.SqlServer.SmoExtended.dll 中)

语法

声明
Public NotInheritable Class Backup _
    Inherits BackupRestoreBase
用法
Dim instance As Backup
public sealed class Backup : BackupRestoreBase
public ref class Backup sealed : public BackupRestoreBase
[<SealedAttribute>]
type Backup =  
    class
        inherit BackupRestoreBase
    end
public final class Backup extends BackupRestoreBase

Backup 类型公开以下成员。

构造函数

  名称 说明
公共方法 Backup Initializes a new instance of the Backup class.

页首

属性

  名称 说明
公共属性 Action Gets or sets the type of backup to be performed.
公共属性 AsyncStatus Gets the asynchronous status of a backup or restore process. (从 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. (从 BackupRestoreBase 继承。)
公共属性 BufferCount Gets or sets the total number of I/O buffers to be used for the backup or restore operation. (从 BackupRestoreBase 继承。)
公共属性 Checksum Gets or sets a Boolean property value that determines whether a checksum value is calculated during backup or restore operations. (从 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. (从 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. (从 BackupRestoreBase 继承。)
公共属性 DatabaseFileGroups Gets the SQL Server file groups targeted by the backup or restore operation. (从 BackupRestoreBase 继承。)
公共属性 DatabaseFiles Gets the operating system files targeted by the backup or restore operation. (从 BackupRestoreBase 继承。)
公共属性 Devices Gets the backup devices specified for the backup or restore operation. (从 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. (从 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. (从 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. (从 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. (从 BackupRestoreBase 继承。)
公共属性 PercentCompleteNotification Gets or sets the percentage interval for PercentCompleteEventHandler event handler calls. (从 BackupRestoreBase 继承。)
公共属性 Restart Gets or sets a Boolean property value that determines whether the backup or restore operation will restart if it is interrupted. (从 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. (从 BackupRestoreBase 继承。)

页首

方法

  名称 说明
公共方法 Abort Terminates a running backup or restore operation. (从 BackupRestoreBase 继承。)
公共方法 Equals (从 Object 继承。)
受保护方法 ExecuteSql Executes a batch of Transact-SQL statements that does not expect a returned results set on the specified instance of SQL Server. (从 BackupRestoreBase 继承。)
受保护方法 ExecuteSqlAsync Executes a batch of Transact-SQL statements asynchronously that does not expect a returned results set on the specified instance of SQL Server. (从 BackupRestoreBase 继承。)
受保护方法 ExecuteSqlWithResults Executes a batch of Transact-SQL statements that expects one or more returned results sets on the specified instance of SQL Server. (从 BackupRestoreBase 继承。)
受保护方法 Finalize (从 Object 继承。)
受保护方法 GetDevicesScript Gets the script that is used to create devices. (从 BackupRestoreBase 继承。)
公共方法 GetHashCode (从 Object 继承。)
公共方法 GetType (从 Object 继承。)
受保护方法 IsStringValid Verifies whether the specified string is valid. (从 BackupRestoreBase 继承。)
受保护方法 MemberwiseClone (从 Object 继承。)
公共方法 Script Returns a Transact-SQL statement that can be used to execute the referenced backup.
公共方法 SetMediaPassword(SecureString) Sets the password for a media set. (从 BackupRestoreBase 继承。)
公共方法 SetMediaPassword(String) Sets the password for a media set. (从 BackupRestoreBase 继承。)
公共方法 SetPassword(SecureString) Sets the password for a backup set. (从 BackupRestoreBase 继承。)
公共方法 SetPassword(String) Sets the password for a backup set. (从 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 (从 Object 继承。)
公共方法 Wait Waits for the current backup or restore operation to complete before moving on to the next process. (从 BackupRestoreBase 继承。)

页首

事件

  名称 说明
公共事件 Complete Occurs when the backup or restore operation completes. (从 BackupRestoreBase 继承。)
公共事件 Information Occurs when any informational message is issued by Microsoft SQL Server that cannot be handled by the Complete NextMedia or PercentComplete events. (从 BackupRestoreBase 继承。)
公共事件 NextMedia Occurs when the backup or restore operation exhausts the medium in a target device. (从 BackupRestoreBase 继承。)
公共事件 PercentComplete Occurs when a backup or restore operation reaches a completion unit. (从 BackupRestoreBase 继承。)

页首

字段

  名称 说明
受保护字段 currentAsyncOperation Specifies the current asynchronous operation, such as backup, restore, or none. (从 BackupRestoreBase 继承。)
受保护字段 m_BackupAction Specifies the backup action type, such as database or log. (从 BackupRestoreBase 继承。)
受保护字段 m_LogTruncation Specifies whether to truncate the log. (从 BackupRestoreBase 继承。)
受保护字段 m_RestoreAction Specifies the restore action type, such as database or log. (从 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.

线程安全

此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。