TransferDatabaseTask Class

Definition

Namespace:

Microsoft.SqlServer.Dts.Tasks.TransferDatabaseTask

Assembly:

Microsoft.SqlServer.TransferDatabasesTask.dll

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.

public ref class TransferDatabaseTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::TransferDatabaseTask::ITransferDatabaseTask

[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transferdatabasetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferDatabaseTask.Localized), SamplesTag="SsisTransferDatabaseTask", TaskContact="Transfer Database Task; Microsoft Corporation; SQL Server 2019; (C) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferDatabasesTaskUI.TransferDatabasesTaskUI, Microsoft.SqlServer.TransferDatabasesTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[System.Runtime.InteropServices.Guid("F609B862-C801-4560-A6C0-B152830A7FDB")]
public sealed class TransferDatabaseTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.TransferDatabaseTask.ITransferDatabaseTask

[<Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.transferdatabasetask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.TransferDatabaseTask.Localized), SamplesTag="SsisTransferDatabaseTask", TaskContact="Transfer Database Task; Microsoft Corporation; SQL Server 2019; (C) Microsoft Corporation; All Rights Reserved;http://www.microsoft.com/sql/support/default.asp;1", TaskType="DTS90", UITypeName="Microsoft.SqlServer.Dts.Tasks.TransferDatabasesTaskUI.TransferDatabasesTaskUI, Microsoft.SqlServer.TransferDatabasesTaskUI, Version=15.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")>]
[<System.Runtime.InteropServices.Guid("F609B862-C801-4560-A6C0-B152830A7FDB")>]
type TransferDatabaseTask = class
    inherit Task
    interface ITransferDatabaseTask
    interface IDTSComponentPersist

Public NotInheritable Class TransferDatabaseTask
Inherits Task
Implements IDTSComponentPersist, ITransferDatabaseTask

Inheritance

Object

DtsObject

Task

TransferDatabaseTask

Attributes

DtsTaskAttribute GuidAttribute

Implements

IDTSComponentPersist ITransferDatabaseTask

Remarks

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

Constructors

TransferDatabaseTask()

Initializes a new instance of the TransferDatabaseTask class.

Properties

Action	Gets or sets a value from the TransferAction enumeration indicating whether the Transfer Database task is copying or moving databases.
DestinationConnection	Gets or sets a String containing the name of the SMO connection manager for the destination database.
DestinationDatabaseFiles	Gets or sets a String containing the name of the database files for the destination database.
DestinationDatabaseName	Gets or sets a String containing the name of the database at the destination.
DestinationOverwrite	Gets or sets a Boolean indicating whether the destination database can be overwritten if it exists.
ExecutionValue	Returns the result of the task execution.
Method	Gets or sets a value from the TransferMethod enumeration indicating whether to use Online or Offline transfer method.
ReattachSourceDatabase	A Boolean indicating whether the database should be reattached or not.
SourceConnection	Gets or sets a String containing the name of the SMO connection manager for the source database.
SourceDatabaseFiles	Gets or sets a String containing the names of the source database files to transfer.
SourceDatabaseName	Gets or sets a String containing the name of the source database to transfer.
TargetServerVersion	(Inherited from Task)
Version	*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only. (Inherited from Task)

Methods

CanUpdate(String)	*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task)
Equals(Object)	Determines whether two object instances are equal. (Inherited from DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)	Runs the task.
GetConnectionID(Connections, String)	Gets a String containing the ID of the connection. (Inherited from Task)
GetConnectionName(Connections, String)	Gets a String containing the name of the connection. (Inherited from Task)
GetHashCode()	Returns the hash code for this instance. (Inherited from DtsObject)
InitializeTask(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.
LoadFromXML(XmlElement, IDTSInfoEvents)	This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method.
SaveToXML(XmlDocument, IDTSInfoEvents)	This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.
Update(String)	*** Member deprecated; see Remarks. ***   This method updates the old package XML with the new package XML if CanUpdate(String) is set to true. (Inherited from Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)	Verifies that the task component is correctly configured.