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("6C2A0641-7935-4351-8F04-1D4805285F0F")> _
Public NotInheritable Class TransferDatabaseTask _
Inherits Task _
Implements ITransferDatabaseTask, IDTSComponentPersist
'Usage
Dim instance As TransferDatabaseTask
[GuidAttribute("6C2A0641-7935-4351-8F04-1D4805285F0F")]
public sealed class TransferDatabaseTask : Task,
ITransferDatabaseTask, IDTSComponentPersist
[GuidAttribute(L"6C2A0641-7935-4351-8F04-1D4805285F0F")]
public ref class TransferDatabaseTask sealed : public Task,
ITransferDatabaseTask, IDTSComponentPersist
[<SealedAttribute>]
[<GuidAttribute("6C2A0641-7935-4351-8F04-1D4805285F0F")>]
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 | |
---|---|---|
TransferDatabaseTask | Initializes a new instance of the TransferDatabaseTask class. |
Top
Properties
Name | Description | |
---|---|---|
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. (Overrides Task.ExecutionValue.) | |
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. | |
Version | *** Member deprecated; see Remarks. *** Returns the version of the task. This property is read-only. (Inherited from Task.) |
Top
Methods
Name | Description | |
---|---|---|
CanUpdate | *** Member deprecated; see Remarks. *** A Boolean that indicates whether the new package XML can update the old package XML. (Inherited from Task.) | |
Equals | Determines whether two object instances are equal. (Inherited from DtsObject.) | |
Execute | Runs the task. (Overrides Task.Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object).) | |
GetConnectionID | Gets a String containing the ID of the connection. (Inherited from Task.) | |
GetConnectionName | Gets a String containing the name of the connection. (Inherited from Task.) | |
GetHashCode | Returns the hash code for this instance. (Inherited from DtsObject.) | |
GetType | (Inherited from Object.) | |
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).) | |
LoadFromXML | This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method. | |
SaveToXML | This method is not callable by your application code. To save a package as .xml, use the Application.SaveToXml method. | |
ToString | (Inherited from Object.) | |
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.) | |
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.
See Also
Reference
Microsoft.SqlServer.Dts.Tasks.TransferDatabaseTask Namespace