Класс 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.

Безопасность многопоточности

Любые открытые статический (Shared в Visual Basic) элементы этого типа потокобезопасны. Потокобезопасность с элементами экземпляров не гарантируется.