Share via


TransferStoredProceduresTask Class

Contains the methods, properties, and enumerations that allow you to copy stored procedures from the master database located on one instance of SQL Server to another. This class cannot be inherited.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<GuidAttribute("FD5592B7-1CDF-4ABF-81AF-8C782E7F01FB")> _
Public NotInheritable Class TransferStoredProceduresTask _
    Inherits Task _
    Implements ITransferStoredProceduresTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
'Usage
Dim instance As TransferStoredProceduresTask
[GuidAttribute("FD5592B7-1CDF-4ABF-81AF-8C782E7F01FB")]
public sealed class TransferStoredProceduresTask : Task, 
    ITransferStoredProceduresTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
[GuidAttribute(L"FD5592B7-1CDF-4ABF-81AF-8C782E7F01FB")]
public ref class TransferStoredProceduresTask sealed : public Task, 
    ITransferStoredProceduresTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist
[<SealedAttribute>]
[<GuidAttribute("FD5592B7-1CDF-4ABF-81AF-8C782E7F01FB")>]
type TransferStoredProceduresTask =  
    class 
        inherit Task 
        interface ITransferStoredProceduresTask 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
        interface IDTSComponentPersist 
    end
public final class TransferStoredProceduresTask extends Task implements ITransferStoredProceduresTask, IDTSBreakpointSite, IDTSSuspend, IDTSComponentPersist

The TransferStoredProceduresTask type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property DebugMode Gets or sets a Boolean indicating whether a task should determine whether breakpoints are enabled.
Public property DestinationConnection Gets or sets a String containing the name of the SMO connection manager for the source/destination database.
Public property ExecutionValue Returns an object containing a count of the number of stored procedures that were transferred. (Overrides Task.ExecutionValue.)
Public property IfObjectExists Gets or sets a value from the IfObjectExists enumeration indicating if the task should fail, overwrite the existing stored procedure, or skip the transfer of the stored procedureif a stored procedurewith the same name exists at the destination.
Public property SourceConnection Gets or sets a String containing the name of the SMO connection manager for the source/destination database.
Public property StoredProceduresList Gets or sets a StringCollection containing a comma-delimited list of stored procedure names.
Public property SuspendRequired Gets or sets a Boolean indicating whether the task should suspend when it encounters a breakpoint. This value is set by the run-time engine for the task or container when a breakpoint is encountered.
Public property TransferAllStoredProcedures A Boolean indicating whether all stored procedures in the master database of the source SQL Server are transferred, or only the specified stored procedures.
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 AcceptBreakpointManager Passes a BreakpointManager to a task. This method is called by the runtime and is not used in code.
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).)
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.
Public method ResumeExecution Resumes execution of the task after pausing. The task or container is resumed by the run-time engine.
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 SuspendExecution Indicates that the executable needs to suspend. This method is called by the run-time engine.
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 component is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

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.TransferStoredProceduresTask Namespace