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

BackupRestoreBase Class

The BackupRestoreBase class is a base class that represents functionality that is common to both backup and restore operations.

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

The BackupRestoreBase type exposes the following members.

  NameDescription
Public methodBackupRestoreBaseInitializes a new instance of the BackupRestoreBase class.
Top
  NameDescription
Public propertyAsyncStatusGets the asynchronous status of a backup or restore process.
Public propertyBlockSizeGets or sets the physical block size of the backup or restore, in bytes.
Public propertyBufferCountGets or sets the total number of I/O buffers to be used for the backup or restore operation.
Public propertyChecksumGets or sets a Boolean property value that determines whether a checksum value is calculated during backup or restore operations.
Public propertyContinueAfterErrorGets or sets a Boolean property value that determines whether the backup or restore continues after a checksum error occurs.
Public propertyDatabaseGets or sets the database on which the backup or restore operation runs.
Public propertyDatabaseFileGroupsGets the SQL Server file groups targeted by the backup or restore operation.
Public propertyDatabaseFilesGets the operating system files targeted by the backup or restore operation.
Public propertyDevicesGets the backup devices specified for the backup or restore operation.
Public propertyMaxTransferSizeGets or sets the maximum number of bytes to be transferred between the backup media and the instance of SQL Server.
Public propertyMediaNameGets or sets the name used to identify a particular media set.
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.
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.
Public propertyPercentCompleteNotificationGets or sets the percentage interval for PercentCompleteEventHandler event handler calls.
Public propertyRestartGets or sets a Boolean property value that determines whether the backup or restore operation will restart if it is interrupted.
Public propertyUnloadTapeAfterGets or sets a Boolean property value that determines whether tape media are rewound and unloaded after the backup or restore operation completes.
Top
  NameDescription
Public methodAbortTerminates a running backup or restore operation.
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.
Protected methodExecuteSqlAsyncExecutes a batch of Transact-SQL statements asynchronously that does not expect a returned results set on the specified instance of SQL Server.
Protected methodExecuteSqlWithResultsExecutes a batch of Transact-SQL statements that expects one or more returned results sets on the specified instance of SQL Server.
Protected methodFinalize (Inherited from Object.)
Protected methodGetDevicesScriptGets the script that is used to create devices.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodIsStringValidVerifies whether the specified string is valid.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodSetMediaPassword(SecureString) Obsolete. Sets the password for a media set.
Public methodSetMediaPassword(String) Obsolete. Sets the password for a media set.
Public methodSetPassword(SecureString)Sets the password for a backup set.
Public methodSetPassword(String)Sets the password for a backup set.
Public methodToString (Inherited from Object.)
Public methodWaitWaits for the current backup or restore operation to complete before moving on to the next process.
Top
  NameDescription
Public eventCompleteOccurs when the backup or restore operation completes.
Public eventInformationOccurs when any informational message is issued by Microsoft SQL Server that cannot be handled by the Complete NextMedia or PercentComplete events.
Public eventNextMediaOccurs when the backup or restore operation exhausts the medium in a target device.
Public eventPercentCompleteOccurs when a backup or restore operation reaches a completion unit.
Top
  NameDescription
Protected fieldcurrentAsyncOperationSpecifies the current asynchronous operation, such as backup, restore, or none.
Protected fieldm_BackupActionSpecifies the backup action type, such as database or log.
Protected fieldm_LogTruncationSpecifies whether to truncate the log.
Protected fieldm_RestoreActionSpecifies the restore action type, such as database or log.
Top

The BackupRestoreBase class is used in the construction of the Restore class and the Backup class, and contains functionality that is common.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.