• Article

ExecuteSQLTask Class

Contains the members used to configure and run an Execute SQL task. The Execute SQL task is used to execute SQL commands against a relational database table or view.

Inheritance Hierarchy

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

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

Syntax

'Declaration
<GuidAttribute("3E0AAEAA-F8DC-370D-9206-0FC456CE748F")> _
Public Class ExecuteSQLTask _
    Inherits Task _
    Implements IDTSExecuteSQL, IDTSComponentPersist
'Usage
Dim instance As ExecuteSQLTask

[GuidAttribute("3E0AAEAA-F8DC-370D-9206-0FC456CE748F")]
public class ExecuteSQLTask : Task, 
    IDTSExecuteSQL, IDTSComponentPersist

[GuidAttribute(L"3E0AAEAA-F8DC-370D-9206-0FC456CE748F")]
public ref class ExecuteSQLTask : public Task, 
    IDTSExecuteSQL, IDTSComponentPersist

[<GuidAttribute("3E0AAEAA-F8DC-370D-9206-0FC456CE748F")>]
type ExecuteSQLTask =  
    class
        inherit Task
        interface IDTSExecuteSQL
        interface IDTSComponentPersist
    end

public class ExecuteSQLTask extends Task implements IDTSExecuteSQL, IDTSComponentPersist

The ExecuteSQLTask type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property BypassPrepare Gets or sets a Boolean that indicates whether the Execute SQL task skips preparation of the statement when sending the SQL statement to the relational database management system (RDBMS).
Public property CodePage Gets or sets the code page to use when translating variable values that are stored as Unicode wide chars to multi-bytes. Translation occurs either when storing values to or extracting values from databases.
Public property Connection Gets or sets the name of the connection manager that connects to the relational database management system (RDBMS) where the Execute SQL task is run.
Public property ExecutionValue Returns the number of rows affected by the SQL statement or statements. (Overrides Task.ExecutionValue.)
Public property IsStoredProcedure Gets or sets a Boolean that indicates whether the SQL statement specified by the Execute SQL task is a stored procedure.
Public property ParameterBindings Returns an object that implements IDTSParameterBindings.
Public property ResultSetBindings Returns an object that implements IDTSParameterBindings.
Public property ResultSetType Gets or sets a value that indicates the type of result set returned by the SQL statement that the Execute SQL tasks runs.
Public property SqlStatementSource Gets or sets the name of the source that contains the SQL statement that the Execute SQL task runs.
Public property SqlStatementSourceType Gets or sets a value that indicates the type of source that contains the SQL statement that the Execute SQL task runs.
Public property TimeOut Gets or sets an integer that indicates the maximum number of seconds the task can run before timing out.
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 Execute SQL 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 is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

Remarks

For more information about the features of this task, see SSIS Execute SQL 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.