BulkInsertTask BulkInsertTask BulkInsertTask BulkInsertTask Class

Definition

Provides the properties and methods for the Bulk Insert task, which is the quickest way to copy large amounts of data into a SQL Server table or view. This class cannot be inherited.

public ref class BulkInsertTask sealed : Microsoft::SqlServer::Dts::Runtime::Task, Microsoft::SqlServer::Dts::Runtime::IDTSBreakpointSite, Microsoft::SqlServer::Dts::Runtime::IDTSComponentPersist, Microsoft::SqlServer::Dts::Tasks::BulkInsertTask::IDTSBulkInsertTask
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.bulkinserttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.BulkInsertTask.BulkInsertTaskMessages), SamplesTag="SsisBulkInsertTask", UITypeName="Microsoft.SqlServer.Dts.Tasks.BulkInsertTask.BulkInsertTaskUI, Microsoft.SqlServer.BulkInsertTaskUI, Version=14.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
[Microsoft.SqlServer.Dts.Runtime.DtsTask(HelpKeyword="sql13.dts.designer.bulkinserttask.F1", LocalizationType=typeof(Microsoft.SqlServer.Dts.Tasks.BulkInsertTask.BulkInsertTaskMessages), SamplesTag="SsisBulkInsertTask", UITypeName="Microsoft.SqlServer.Dts.Tasks.BulkInsertTask.BulkInsertTaskUI, Microsoft.SqlServer.BulkInsertTaskUI, Version=13.0.0.0, Culture=Neutral, PublicKeyToken=89845dcd8080cc91")]
public sealed class BulkInsertTask : Microsoft.SqlServer.Dts.Runtime.Task, Microsoft.SqlServer.Dts.Runtime.IDTSBreakpointSite, Microsoft.SqlServer.Dts.Runtime.IDTSComponentPersist, Microsoft.SqlServer.Dts.Tasks.BulkInsertTask.IDTSBulkInsertTask
type BulkInsertTask = class
    inherit Task
    interface IDTSComponentPersist
    interface IDTSBulkInsertTask
    interface IDTSBreakpointSite
    interface IDTSSuspend
Public NotInheritable Class BulkInsertTask
Inherits Task
Implements IDTSBreakpointSite, IDTSBulkInsertTask, IDTSComponentPersist
Inheritance
BulkInsertTaskBulkInsertTaskBulkInsertTaskBulkInsertTask
Attributes
Implements

Remarks

For more information, see Bulk Insert Task.

Constructors

BulkInsertTask() BulkInsertTask() BulkInsertTask() BulkInsertTask()

Initializes a new instance of the BulkInsertTask class.

Properties

BatchSize BatchSize BatchSize BatchSize

Gets or sets the number of rows in each batch.

CheckConstraints CheckConstraints CheckConstraints CheckConstraints

Gets or sets a Boolean that indicates if you want to enforce table and column check constraints.

CodePage CodePage CodePage CodePage

Gets or sets the code page of the data in the data file.

DataFileType DataFileType DataFileType DataFileType

Gets or sets a value from the DTSBulkInsert_DataFileType enumeration that indicates the data-type value to use in the load operation.

DebugMode DebugMode DebugMode DebugMode

Gets or sets a Boolean that indicates whether a task should determine whether breakpoints are enabled.

DestinationConnection DestinationConnection DestinationConnection DestinationConnection

Gets or sets the name of the destination connection object.

DestinationTableName DestinationTableName DestinationTableName DestinationTableName

Gets or sets the name of the destination table or view.

ExecutionValue ExecutionValue ExecutionValue ExecutionValue

Returns a user-defined object. This field is read-only.

(Inherited from Task)
FieldTerminator FieldTerminator FieldTerminator FieldTerminator

Gets or sets the field terminator for use in char and widechar data files.

FireTriggers FireTriggers FireTriggers FireTriggers

Gets or sets a Boolean that indicates whether the insert triggers should be executed on the table during the operation.

FirstRow FirstRow FirstRow FirstRow

Gets or sets the first row from which to start copying.

FormatFile FormatFile FormatFile FormatFile

Gets or sets the full path of a format file.

KeepIdentity KeepIdentity KeepIdentity KeepIdentity

Gets or sets a Boolean that specifies how identity value or values in the imported data file are used for the identity column

KeepNulls KeepNulls KeepNulls KeepNulls

Gets or sets a Boolean that indicates whether empty columns should retain a null value during the bulk load operation, or insert default values into the columns.

LastRow LastRow LastRow LastRow

Gets or sets the number of the last row to copy.

MaximumErrors MaximumErrors MaximumErrors MaximumErrors

Gets or sets the maximum number of errors that can occur before the bulk insert operation fails.

RowTerminator RowTerminator RowTerminator RowTerminator

Gets or sets the row terminator for use in char and widechar data files.

SortedData SortedData SortedData SortedData

Gets or sets the Order by clause in the bulk insert statement

SourceConnection SourceConnection SourceConnection SourceConnection

Gets or sets the name of the source connection object.

SqlStatement SqlStatement SqlStatement SqlStatement

Gets a String array that contains the Transact-SQL statement to run.

SuspendRequired SuspendRequired SuspendRequired SuspendRequired

Gets or sets a Boolean that indicates whether tasks should suspend when they encounter a breakpoint. This value is set by the runtime engine for tasks and containers when a breakpoint is encountered.

TableLock TableLock TableLock TableLock

Gets or sets a Boolean that indicates whether the table is locked during the bulk insert operation.

TargetServerVersion TargetServerVersion TargetServerVersion TargetServerVersion Inherited from Task
UseFormatFile UseFormatFile UseFormatFile UseFormatFile

Gets or sets a Boolean that indicates whether the Bulk Insert task uses a format file.

Version Version Version Version

*** Member deprecated; see Remarks. ***   Returns the version of the task. This property is read-only.

(Inherited from Task)

Methods

AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(BreakpointManager) AcceptBreakpointManager(BreakpointManager)

Called by the run-time engine when a task or container is created, and is passed a BreakpointManager to enable the task to create, remove, and check the status of breakpoints. This method is called by the runtime and is not used in code.

CanUpdate(String) CanUpdate(String) CanUpdate(String) CanUpdate(String)

*** Member deprecated; see Remarks. ***   A Boolean that indicates whether the new package XML can update the old package XML.

(Inherited from Task)
Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object) Execute(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging, Object)

Runs the Bulk Insert task.

GetConnectionID(Connections, String) GetConnectionID(Connections, String) GetConnectionID(Connections, String) GetConnectionID(Connections, String)

Gets a String containing the ID of the connection.

(Inherited from Task)
GetConnectionName(Connections, String) GetConnectionName(Connections, String) GetConnectionName(Connections, String) GetConnectionName(Connections, String)

Gets a String containing the name of the connection.

(Inherited from Task)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker) InitializeTask(Connections, VariableDispenser, IDTSInfoEvents, IDTSLogging, EventInfos, LogEntryInfos, ObjectReferenceTracker)

Initializes the properties associated with the task. This method is called by the runtime and is not used in code.

LoadFromXML(XmlElement, IDTSInfoEvents) LoadFromXML(XmlElement, IDTSInfoEvents) LoadFromXML(XmlElement, IDTSInfoEvents) LoadFromXML(XmlElement, IDTSInfoEvents)

This method is not callable by your application code. To load a package saved as .xml, use the LoadPackage(String, IDTSEvents) method.

ResumeExecution() ResumeExecution() ResumeExecution() ResumeExecution()

Resumes execution of the task after pausing. The task or container is resumed by the runtime engine.

SaveToXML(XmlDocument, IDTSInfoEvents) SaveToXML(XmlDocument, IDTSInfoEvents) SaveToXML(XmlDocument, IDTSInfoEvents) SaveToXML(XmlDocument, IDTSInfoEvents)

This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.

SuspendExecution() SuspendExecution() SuspendExecution() SuspendExecution()

Indicates that the executable needs to suspend. This method is called by the runtime engine.

Update(String) Update(String) Update(String) Update(String)

*** Member deprecated; see Remarks. ***   This method updates the old package XML with the new package XML if CanUpdate(String) is set to true.

(Inherited from Task)
Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging) Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging)

Verifies that the Bulk Insert task component is correctly configured.

Applies to