• Article

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.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<GuidAttribute("D9E9F0F6-7771-4596-BC26-2A8BE222CB56")> _
Public NotInheritable Class TransferDatabaseTask _
    Inherits Task _
    Implements ITransferDatabaseTask, IDTSComponentPersist
'Usage
Dim instance As TransferDatabaseTask

[GuidAttribute("D9E9F0F6-7771-4596-BC26-2A8BE222CB56")]
public sealed class TransferDatabaseTask : Task, 
    ITransferDatabaseTask, IDTSComponentPersist

[GuidAttribute(L"D9E9F0F6-7771-4596-BC26-2A8BE222CB56")]
public ref class TransferDatabaseTask sealed : public Task, 
    ITransferDatabaseTask, IDTSComponentPersist

[<SealedAttribute>]
[<GuidAttribute("D9E9F0F6-7771-4596-BC26-2A8BE222CB56")>]
type TransferDatabaseTask =  
    class
        inherit Task
        interface ITransferDatabaseTask
        interface IDTSComponentPersist
    end

public final class TransferDatabaseTask extends Task implements ITransferDatabaseTask, IDTSComponentPersist

The TransferDatabaseTask type exposes the following members.

Constructors

  Name Description
Public method TransferDatabaseTask Initializes a new instance of the TransferDatabaseTask class.

Top

Properties

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

Top

Methods

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

Top

Remarks

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

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.