TransferDatabaseTask Class

Allows the transfer of a database between a source and a destination server using two different methods: database online, and database offline. The task requires the use of an SMO Connection Manager.


Namespace:  Microsoft.SqlServer.Dts.Tasks.TransferDatabaseTask
Assembly:  Microsoft.SqlServer.TransferDatabasesTask (in Microsoft.SqlServer.TransferDatabasesTask.dll)

public sealed class TransferDatabaseTask : Task, 
	ITransferDatabaseTask, IDTSComponentPersist

The TransferDatabaseTask type exposes the following members.

Public methodTransferDatabaseTaskInitializes a new instance of the TransferDatabaseTask class.

Public propertyActionGets or sets a value from the TransferAction enumeration indicating whether the Transfer Database task is copying or moving databases.
Public propertyDestinationConnectionGets or sets a String containing the name of the SMO connection manager for the destination database.
Public propertyDestinationDatabaseFilesGets or sets a String containing the name of the database files for the destination database.
Public propertyDestinationDatabaseNameGets or sets a String containing the name of the database at the destination.
Public propertyDestinationOverwriteGets or sets a Boolean indicating whether the destination database can be overwritten if it exists.
Public propertyExecutionValueReturns the result of the task execution. (Overrides Task.ExecutionValue.)
Public propertyMethodGets or sets a value from the TransferMethod enumeration indicating whether to use Online or Offline transfer method.
Public propertyReattachSourceDatabaseA Boolean indicating whether the database should be reattached or not.
Public propertySourceConnectionGets or sets a String containing the name of the SMO connection manager for the source database.
Public propertySourceDatabaseFilesGets or sets a String containing the names of the source database files to transfer.
Public propertySourceDatabaseNameGets or sets a String containing the name of the source database to transfer.
Public propertyVersion*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task.)

Public methodCanUpdate*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.)
Public methodEqualsDetermines whether two object instances are equal. (Inherited from DtsObject.)
Public methodExecuteRuns the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).)
Protected methodFinalize (Inherited from Object.)
Public methodGetConnectionIDGets a String containing the ID of the connection. (Inherited from Task.)
Public methodGetConnectionNameGets a String containing the name of the connection. (Inherited from Task.)
Public methodGetHashCodeReturns the hash code for this instance. (Inherited from DtsObject.)
Public methodGetType (Inherited from Object.)
Public methodInitializeTaskInitializes the properties associated with the task. This method is called by the runtime and is not used in code. (Overrides Task.InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker).)
Public methodLoadFromXMLThis method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
Protected methodMemberwiseClone (Inherited from Object.)
Public methodSaveToXMLThis method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method.
Public methodToString (Inherited from Object.)
Public methodUpdate*** Member deprecated; see Remarks. ***   This method updates the old package XML with the new package XML if CanUpdate is set to true. (Inherited from Task.)
Public methodValidateVerifies that the task component is correctly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

The transfer can occur between databases of the same version, or to a higher version. For more information, see Transfer Database Task.

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