Share via


Classe Backup

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

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.SqlServer.Management.Smo
Assembly :  Microsoft.SqlServer.SmoExtended (en Microsoft.SqlServer.SmoExtended.dll)

Syntaxe

'Déclaration
Public NotInheritable Class Backup _
    Inherits BackupRestoreBase
'Utilisation
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

Le type Backup expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique Backup Initializes a new instance of the Backup class.

Haut de la page

Propriétés

  Nom Description
Propriété publique Action Gets or sets the type of backup to be performed.
Propriété publique AsyncStatus Gets the asynchronous status of a backup or restore process. (hérité de BackupRestoreBase.)
Propriété publique BackupSetDescription Gets or sets a textual description for a particular backup set.
Propriété publique BackupSetName Gets or sets the name used to identify a particular backup set.
Propriété publique BlockSize Gets or sets the physical block size of the backup or restore, in bytes. (hérité de BackupRestoreBase.)
Propriété publique BufferCount Gets or sets the total number of I/O buffers to be used for the backup or restore operation. (hérité de BackupRestoreBase.)
Propriété publique Checksum Gets or sets a Boolean property value that determines whether a checksum value is calculated during backup or restore operations. (hérité de BackupRestoreBase.)
Propriété publique CompressionOption Gets or sets the compression option for the current backup session and is transient to the Backup Object Microsoft.SqlServer.Management.SmoExtended.Backup
Propriété publique ContinueAfterError Gets or sets a Boolean property value that determines whether the backup or restore continues after a checksum error occurs. (hérité de BackupRestoreBase.)
Propriété publique 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.
Propriété publique Database Gets or sets the database on which the backup or restore operation runs. (hérité de BackupRestoreBase.)
Propriété publique DatabaseFileGroups Gets the SQL Server file groups targeted by the backup or restore operation. (hérité de BackupRestoreBase.)
Propriété publique DatabaseFiles Gets the operating system files targeted by the backup or restore operation. (hérité de BackupRestoreBase.)
Propriété publique Devices Gets the backup devices specified for the backup or restore operation. (hérité de BackupRestoreBase.)
Propriété publique ExpirationDate Gets or sets the date and time when the backup set expires and the backup data is no longer considered relevant.
Propriété publique FormatMedia Gets or sets a Boolean property value that determines whether a tape is formatted as the first step of the backup operation.
Propriété publique Incremental Gets or sets a Boolean property value that determines whether to perform a differential backup.
Propriété publique 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.
Propriété publique LogTruncation Gets or sets the method used to truncate the database log as part of the backup operation.
Propriété publique MaxTransferSize Gets or sets the maximum number of bytes to be transferred between the backup media and the instance of SQL Server. (hérité de BackupRestoreBase.)
Propriété publique MediaDescription Gets or sets a textual description of the medium that contains a backup set.
Propriété publique MediaName Gets or sets the name used to identify a particular media set. (hérité de BackupRestoreBase.)
Propriété publique Mirrors Gets or sets the list of backup devices used by the mirrored backup.
Propriété publique 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. (hérité de BackupRestoreBase.)
Propriété publique 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. (hérité de BackupRestoreBase.)
Propriété publique PercentCompleteNotification Gets or sets the percentage interval for PercentCompleteEventHandler event handler calls. (hérité de BackupRestoreBase.)
Propriété publique Restart Gets or sets a Boolean property value that determines whether the backup or restore operation will restart if it is interrupted. (hérité de BackupRestoreBase.)
Propriété publique RetainDays Gets or sets the number of days that must elapse before a backup set can be overwritten.
Propriété publique SkipTapeHeader Gets or sets Boolean property that determines whether the tape header is read.
Propriété publique UndoFileName Gets or sets the name of the undo file used to store uncommitted transactions that are rolled back during recovery.
Propriété publique UnloadTapeAfter Gets or sets a Boolean property value that determines whether tape media are rewound and unloaded after the backup or restore operation completes. (hérité de BackupRestoreBase.)

Haut de la page

Méthodes

  Nom Description
Méthode publique Abort Terminates a running backup or restore operation. (hérité de BackupRestoreBase.)
Méthode publique Equals (hérité de Object.)
Méthode protégée ExecuteSql Executes a batch of Transact-SQL statements that does not expect a returned results set on the specified instance of SQL Server. (hérité de BackupRestoreBase.)
Méthode protégée ExecuteSqlAsync Executes a batch of Transact-SQL statements asynchronously that does not expect a returned results set on the specified instance of SQL Server. (hérité de BackupRestoreBase.)
Méthode protégée ExecuteSqlWithResults Executes a batch of Transact-SQL statements that expects one or more returned results sets on the specified instance of SQL Server. (hérité de BackupRestoreBase.)
Méthode protégée Finalize (hérité de Object.)
Méthode protégée GetDevicesScript Gets the script that is used to create devices. (hérité de BackupRestoreBase.)
Méthode publique GetHashCode (hérité de Object.)
Méthode publique GetType (hérité de Object.)
Méthode protégée IsStringValid Verifies whether the specified string is valid. (hérité de BackupRestoreBase.)
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode publique Script Returns a Transact-SQL statement that can be used to execute the referenced backup.
Méthode publique SetMediaPassword(SecureString) Sets the password for a media set. (hérité de BackupRestoreBase.)
Méthode publique SetMediaPassword(String) Sets the password for a media set. (hérité de BackupRestoreBase.)
Méthode publique SetPassword(SecureString) Sets the password for a backup set. (hérité de BackupRestoreBase.)
Méthode publique SetPassword(String) Sets the password for a backup set. (hérité de BackupRestoreBase.)
Méthode publique SqlBackup Performs the database backup operation as specified by the properties of the Backup object used.
Méthode publique SqlBackupAsync Performs the database backup operation asynchronously as specified by the properties of the Backup object used.
Méthode publique ToString (hérité de Object.)
Méthode publique Wait Waits for the current backup or restore operation to complete before moving on to the next process. (hérité de BackupRestoreBase.)

Haut de la page

Événements

  Nom Description
Événement public Complete Occurs when the backup or restore operation completes. (hérité de BackupRestoreBase.)
Événement public Information Occurs when any informational message is issued by Microsoft SQL Server that cannot be handled by the Complete NextMedia or PercentComplete events. (hérité de BackupRestoreBase.)
Événement public NextMedia Occurs when the backup or restore operation exhausts the medium in a target device. (hérité de BackupRestoreBase.)
Événement public PercentComplete Occurs when a backup or restore operation reaches a completion unit. (hérité de BackupRestoreBase.)

Haut de la page

Champs

  Nom Description
Champ protégé currentAsyncOperation Specifies the current asynchronous operation, such as backup, restore, or none. (hérité de BackupRestoreBase.)
Champ protégé m_BackupAction Specifies the backup action type, such as database or log. (hérité de BackupRestoreBase.)
Champ protégé m_LogTruncation Specifies whether to truncate the log. (hérité de BackupRestoreBase.)
Champ protégé m_RestoreAction Specifies the restore action type, such as database or log. (hérité de BackupRestoreBase.)

Haut de la page

Notes

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.

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.