Backup-Klasse

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

Vererbungshierarchie

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

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

Syntax

'Declaration
Public NotInheritable Class Backup _
    Inherits BackupRestoreBase
'Usage
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

Der Backup-Typ macht folgende Elemente verfügbar.

Konstruktoren

  Name Beschreibung
Öffentliche Methode Backup Initializes a new instance of the Backup class.

Zum Anfang

Eigenschaften

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

Zum Anfang

Methoden

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

Zum Anfang

Ereignisse

  Name Beschreibung
Öffentliches Ereignis Complete Occurs when the backup or restore operation completes. (Geerbt von BackupRestoreBase.)
Öffentliches Ereignis Information Occurs when any informational message is issued by Microsoft SQL Server that cannot be handled by the Complete NextMedia or PercentComplete events. (Geerbt von BackupRestoreBase.)
Öffentliches Ereignis NextMedia Occurs when the backup or restore operation exhausts the medium in a target device. (Geerbt von BackupRestoreBase.)
Öffentliches Ereignis PercentComplete Occurs when a backup or restore operation reaches a completion unit. (Geerbt von BackupRestoreBase.)

Zum Anfang

Felder

  Name Beschreibung
Geschütztes Feld currentAsyncOperation Specifies the current asynchronous operation, such as backup, restore, or none. (Geerbt von BackupRestoreBase.)
Geschütztes Feld m_BackupAction Specifies the backup action type, such as database or log. (Geerbt von BackupRestoreBase.)
Geschütztes Feld m_LogTruncation Specifies whether to truncate the log. (Geerbt von BackupRestoreBase.)
Geschütztes Feld m_RestoreAction Specifies the restore action type, such as database or log. (Geerbt von BackupRestoreBase.)

Zum Anfang

Hinweise

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.

Threadsicherheit

Alle öffentlichen static (Shared in Visual Basic)-Elemente dieses Typs sind Threadsicher. Für Instanzelemente wird die Threadsicherheit nicht gewährleistet.