ExecuteSQLTask Class

Article
04/26/2013

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("C876C481-2EA3-40E1-9D75-5F73D0BED1D4")> _
Public Class ExecuteSQLTask _
    Inherits Task _
    Implements IDTSExecuteSQL, IDTSComponentPersist
'Usage
Dim instance As ExecuteSQLTask

[GuidAttribute("C876C481-2EA3-40E1-9D75-5F73D0BED1D4")]
public class ExecuteSQLTask : Task, 
    IDTSExecuteSQL, IDTSComponentPersist

[GuidAttribute(L"C876C481-2EA3-40E1-9D75-5F73D0BED1D4")]
public ref class ExecuteSQLTask : public Task, 
    IDTSExecuteSQL, IDTSComponentPersist

[<GuidAttribute("C876C481-2EA3-40E1-9D75-5F73D0BED1D4")>]
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
	ExecuteSQLTask	Initializes a new instance of the ExecuteSQLTask class.

Top

Properties

	Name	Description
	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).
	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.
	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.
	ExecutionValue	Returns the number of rows affected by the SQL statement or statements. (Overrides Task.ExecutionValue.)
	IsStoredProcedure	Gets or sets a Boolean that indicates whether the SQL statement specified by the Execute SQL task is a stored procedure.
	ParameterBindings	Returns an object that implements IDTSParameterBindings.
	ResultSetBindings	Returns an object that implements IDTSParameterBindings.
	ResultSetType	Gets or sets a value that indicates the type of result set returned by the SQL statement that the Execute SQL tasks runs.
	SqlStatementSource	Gets or sets the name of the source that contains the SQL statement that the Execute SQL task runs.
	SqlStatementSourceType	Gets or sets a value that indicates the type of source that contains the SQL statement that the Execute SQL task runs.
	TimeOut	Gets or sets an integer that indicates the maximum number of seconds the task can run before timing out.
	TypeConversionMode	Gets or sets the conversion mode used by the Execute SQL Task.
	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).)
	Finalize	(Inherited from 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 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).)
	LoadFromXML	This method is not callable by your application code. To load a package saved as .xml, use the Application.LoadPackage method.
	MemberwiseClone	(Inherited from Object.)
	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 is properly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

Remarks

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

Share via