BackupRestoreBase Class

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

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public Class BackupRestoreBase
'Usage
Dim instance As BackupRestoreBase

public class BackupRestoreBase

public ref class BackupRestoreBase

type BackupRestoreBase =  class end

public class BackupRestoreBase

The BackupRestoreBase type exposes the following members.

Constructors

	Name	Description
	BackupRestoreBase	Initializes a new instance of the BackupRestoreBase class.

Top

Properties

	Name	Description
	AsyncStatus	Gets the asynchronous status of a backup or restore process.
	BlockSize	Gets or sets the physical block size of the backup or restore, in bytes.
	BufferCount	Gets or sets the total number of I/O buffers to be used for the backup or restore operation.
	Checksum	Gets or sets a Boolean property value that determines whether a checksum value is calculated during backup or restore operations.
	ContinueAfterError	Gets or sets a Boolean property value that determines whether the backup or restore continues after a checksum error occurs.
	Database	Gets or sets the database on which the backup or restore operation runs.
	DatabaseFileGroups	Gets the SQL Server file groups targeted by the backup or restore operation.
	DatabaseFiles	Gets the operating system files targeted by the backup or restore operation.
	Devices	Gets the backup devices specified for the backup or restore operation.
	MaxTransferSize	Gets or sets the maximum number of bytes to be transferred between the backup media and the instance of SQL Server.
	MediaName	Gets or sets the name used to identify a particular media set.
	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.
	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.
	PercentCompleteNotification	Gets or sets the percentage interval for PercentCompleteEventHandler event handler calls.
	Restart	Gets or sets a Boolean property value that determines whether the backup or restore operation will restart if it is interrupted.
	UnloadTapeAfter	Gets or sets a Boolean property value that determines whether tape media are rewound and unloaded after the backup or restore operation completes.

Top

Methods

	Name	Description
	Abort	Terminates a running backup or restore operation.
	Equals	(Inherited from Object.)
	ExecuteSql	Executes a batch of Transact-SQL statements that does not expect a returned results set on the specified instance of SQL Server.
	ExecuteSqlAsync	Executes a batch of Transact-SQL statements asynchronously that does not expect a returned results set on the specified instance of SQL Server.
	ExecuteSqlWithResults	Executes a batch of Transact-SQL statements that expects one or more returned results sets on the specified instance of SQL Server.
	Finalize	(Inherited from Object.)
	GetDevicesScript	Gets the script that is used to create devices.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	IsStringValid	Verifies whether the specified string is valid.
	MemberwiseClone	(Inherited from Object.)
	SetMediaPassword(SecureString)	Obsolete. Sets the password for a media set.
	SetMediaPassword(String)	Obsolete. Sets the password for a media set.
	SetPassword(SecureString)	Sets the password for a backup set.
	SetPassword(String)	Sets the password for a backup set.
	ToString	(Inherited from Object.)
	Wait	Waits for the current backup or restore operation to complete before moving on to the next process.

Top

Events

	Name	Description
	Complete	Occurs when the backup or restore operation completes.
	Information	Occurs when any informational message is issued by Microsoft SQL Server that cannot be handled by the Complete NextMedia or PercentComplete events.
	NextMedia	Occurs when the backup or restore operation exhausts the medium in a target device.
	PercentComplete	Occurs when a backup or restore operation reaches a completion unit.

Top

Fields

	Name	Description
	currentAsyncOperation	Specifies the current asynchronous operation, such as backup, restore, or none.
	m_BackupAction	Specifies the backup action type, such as database or log.
	m_LogTruncation	Specifies whether to truncate the log.
	m_RestoreAction	Specifies the restore action type, such as database or log.

Top

Remarks

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

Examples

Backing Up and Restoring Databases and Transaction Logs

Thread Safety

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

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

BACKUP (Transact-SQL)

RESTORE (Transact-SQL)