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)

System::Object
  Microsoft.SqlServer.Dts.Runtime::DtsObject
    Microsoft.SqlServer.Dts.Runtime::Task
      Microsoft.SqlServer.Dts.Tasks.TransferDatabaseTask::TransferDatabaseTask

[GuidAttribute("87A575D4-76EA-487F-9493-0A5ACBDFBA3E")]
public ref class TransferDatabaseTask sealed : Task, ITransferDatabaseTask, 
	IDTSComponentPersist

NameDescription
System_CAPS_pubmethodTransferDatabaseTask()

Initializes a new instance of the TransferDatabaseTask class.

NameDescription
System_CAPS_pubpropertyAction

Gets or sets a value from the TransferAction enumeration indicating whether the Transfer Database task is copying or moving databases.

System_CAPS_pubpropertyDestinationConnection

Gets or sets a String containing the name of the SMO connection manager for the destination database.

System_CAPS_pubpropertyDestinationDatabaseFiles

Gets or sets a String containing the name of the database files for the destination database.

System_CAPS_pubpropertyDestinationDatabaseName

Gets or sets a String containing the name of the database at the destination.

System_CAPS_pubpropertyDestinationOverwrite

Gets or sets a Boolean indicating whether the destination database can be overwritten if it exists.

System_CAPS_pubpropertyExecutionValue

Returns the result of the task execution.(Overrides Task::ExecutionValue.)

System_CAPS_pubpropertyMethod

Gets or sets a value from the TransferMethod enumeration indicating whether to use Online or Offline transfer method.

System_CAPS_pubpropertyReattachSourceDatabase

A Boolean indicating whether the database should be reattached or not.

System_CAPS_pubpropertySourceConnection

Gets or sets a String containing the name of the SMO connection manager for the source database.

System_CAPS_pubpropertySourceDatabaseFiles

Gets or sets a String containing the names of the source database files to transfer.

System_CAPS_pubpropertySourceDatabaseName

Gets or sets a String containing the name of the source database to transfer.

System_CAPS_pubpropertyTargetServerVersion

(Inherited from Task.)

System_CAPS_pubpropertyVersion

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.(Inherited from Task.)

NameDescription
System_CAPS_pubmethodCanUpdate(String^)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.(Inherited from Task.)

System_CAPS_pubmethodEquals(Object^)

Determines whether two object instances are equal.(Inherited from DtsObject.)

System_CAPS_pubmethodExecute(Connections^, VariableDispenser^, IDTSComponentEvents^, IDTSLogging^, Object^)
System_CAPS_pubmethodGetConnectionID(Connections^, String^)

Gets a String containing the ID of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetConnectionName(Connections^, String^)

Gets a String containing the name of the connection.(Inherited from Task.)

System_CAPS_pubmethodGetHashCode()

Returns the hash code for this instance.(Inherited from DtsObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitializeTask(Connections^, VariableDispenser^, IDTSInfoEvents^, IDTSLogging^, EventInfos^, LogEntryInfos^, ObjectReferenceTracker^)

Initializes 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^).)

System_CAPS_pubmethodLoadFromXML(XmlElement^, IDTSInfoEvents^)

This method is not callable by your application code. To load a package saved as .xml, use the Application::LoadPackage method.

System_CAPS_pubmethodSaveToXML(XmlDocument^, IDTSInfoEvents^)

This method is not callable by your application code. To save a package as .xml, use the Application::SaveToXml method.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdate(String^%)

*** 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.)

System_CAPS_pubmethodValidate(Connections^, VariableDispenser^, IDTSComponentEvents^, IDTSLogging^)

Verifies 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.

Return to top
Show: