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)

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

Public Class BackupRestoreBase

NameDescription
System_CAPS_pubmethodBackupRestoreBase()

Initializes a new instance of the BackupRestoreBase class.

NameDescription
System_CAPS_pubpropertyAsyncStatus

Gets the asynchronous status of a backup or restore process.

System_CAPS_pubpropertyBlockSize

Gets or sets the physical block size of the backup or restore, in bytes.

System_CAPS_pubpropertyBufferCount

Gets or sets the total number of I/O buffers to be used for the backup or restore operation.

System_CAPS_pubpropertyChecksum

Gets or sets a Boolean property value that determines whether a checksum value is calculated during backup or restore operations.

System_CAPS_pubpropertyContinueAfterError

Gets or sets a Boolean property value that determines whether the backup or restore continues after a checksum error occurs.

System_CAPS_pubpropertyCredentialName

Gets or sets the Credential property value, which is used to authenticate to the Windows Azure storage account.

System_CAPS_pubpropertyDatabase

Gets or sets the database on which the backup or restore operation runs.

System_CAPS_pubpropertyDatabaseFileGroups

Gets the SQL Server file groups targeted by the backup or restore operation.

System_CAPS_pubpropertyDatabaseFiles

Gets the operating system files targeted by the backup or restore operation.

System_CAPS_pubpropertyDevices

Gets the backup devices specified for the backup or restore operation.

System_CAPS_pubpropertyMaxTransferSize

Gets or sets the maximum number of bytes to be transferred between the backup media and the instance of SQL Server.

System_CAPS_pubpropertyMediaName

Gets or sets the name used to identify a particular media set.

System_CAPS_pubpropertyNoRecovery

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.

System_CAPS_pubpropertyNoRewind

Gets or sets a Boolean property value that determines whether Microsoft SQL Server will keep the tape open after the backup or restore operation.

System_CAPS_pubpropertyPercentCompleteNotification

Gets or sets the percentage interval for PercentCompleteEventHandler event handler calls.

System_CAPS_pubpropertyRestart

Gets or sets a Boolean property value that determines whether the backup or restore operation will restart if it is interrupted.

System_CAPS_pubpropertyUnloadTapeAfter

Gets or sets a Boolean property value that determines whether tape media are rewound and unloaded after the backup or restore operation completes.

NameDescription
System_CAPS_pubmethodAbort()

Terminates a running backup or restore operation.

System_CAPS_protmethodCheckForHADRMaintPlan(Server, StringBuilder)

Checks for HADR Maintenance plan.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodExecuteSql(Server, StringCollection)

Executes a batch of Transact-SQL statements that does not expect a returned results set on the specified instance of SQL Server.

System_CAPS_protmethodExecuteSqlAsync(Server, StringCollection)

Executes a batch of Transact-SQL statements asynchronously that does not expect a returned results set on the specified instance of SQL Server.

System_CAPS_protmethodExecuteSqlWithResults(Server, String)

Executes a batch of Transact-SQL statements that expects one or more returned results sets on the specified instance of SQL Server.

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_protmethodGetDevicesScript(StringBuilder, BackupDeviceList, ServerVersion)

Gets the script that is used to create devices.

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodSystem_CAPS_staticIsBackupUrlDeviceSupported(ServerVersion)

Indicates whether BackupToUrl is supported on the connected server version.

System_CAPS_protmethodIsStringValid(String)

Verifies whether the specified string is valid.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodSetMediaPassword(SecureString)

Obsolete. Sets the password for a media set.

System_CAPS_pubmethodSetMediaPassword(String)

Obsolete. Sets the password for a media set.

System_CAPS_pubmethodSetPassword(SecureString)

Sets the password for a backup set.

System_CAPS_pubmethodSetPassword(String)

Sets the password for a backup set.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodWait()

Waits for the current backup or restore operation to complete before moving on to the next process.

NameDescription
System_CAPS_protfieldcurrentAsyncOperation

Specifies the current asynchronous operation, such as backup, restore, or none.

System_CAPS_protfieldm_BackupAction

Specifies the backup action type, such as database or log.

System_CAPS_protfieldm_LogTruncation

Specifies whether to truncate the log.

System_CAPS_protfieldm_RestoreAction

Specifies the restore action type, such as database or log.

NameDescription
System_CAPS_pubeventComplete

Occurs when the backup or restore operation completes.

System_CAPS_pubeventInformation

Occurs when any informational message is issued by Microsoft SQL Server that cannot be handled by the Complete NextMedia or PercentComplete events.

System_CAPS_pubeventNextMedia

Occurs when the backup or restore operation exhausts the medium in a target device.

System_CAPS_pubeventPercentComplete

Occurs when a backup or restore operation reaches a completion unit.

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.

Return to top
Show: