Share via


BulkInsertTask Class

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.

Inheritance Hierarchy

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

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

Syntax

'Declaration
Public NotInheritable Class BulkInsertTask _
    Inherits Task _
    Implements IDTSComponentPersist, IDTSBulkInsertTask, IDTSBreakpointSite, IDTSSuspend
'Usage
Dim instance As BulkInsertTask
public sealed class BulkInsertTask : Task, 
    IDTSComponentPersist, IDTSBulkInsertTask, IDTSBreakpointSite, IDTSSuspend
public ref class BulkInsertTask sealed : public Task, 
    IDTSComponentPersist, IDTSBulkInsertTask, IDTSBreakpointSite, IDTSSuspend
[<SealedAttribute>]
type BulkInsertTask =  
    class 
        inherit Task 
        interface IDTSComponentPersist 
        interface IDTSBulkInsertTask 
        interface IDTSBreakpointSite 
        interface IDTSSuspend 
    end
public final class BulkInsertTask extends Task implements IDTSComponentPersist, IDTSBulkInsertTask, IDTSBreakpointSite, IDTSSuspend

The BulkInsertTask type exposes the following members.

Constructors

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

Top

Properties

  Name Description
Public property BatchSize Gets or sets the number of rows in each batch.
Public property CheckConstraints Gets or sets a Boolean that indicates if you want to enforce table and column check constraints.
Public property CodePage Gets or sets the code page of the data in the data file.
Public property DataFileType Gets or sets a value from the DTSBulkInsert_DataFileType enumeration that indicates the data-type value to use in the load operation.
Public property DebugMode Gets or sets a Boolean that indicates whether a task should determine whether breakpoints are enabled.
Public property DestinationConnection Gets or sets the name of the destination connection object.
Public property DestinationTableName Gets or sets the name of the destination table or view.
Public property ExecutionValue Returns a user-defined object. This field is read-only. (Inherited from Task.)
Public property FieldTerminator Gets or sets the field terminator for use in char and widechar data files.
Public property FireTriggers Gets or sets a Boolean that indicates whether the insert triggers should be executed on the table during the operation.
Public property FirstRow Gets or sets the first row from which to start copying.
Public property FormatFile Gets or sets the full path of a format file.
Public property KeepIdentity Gets or sets a Boolean that specifies how identity value or values in the imported data file are used for the identity column
Public property KeepNulls Gets or sets a Boolean that indicates whether empty columns should retain a nulla null reference (Nothing in Visual Basic) value during the bulk load operation, or insert default values into the columns.
Public property LastRow Gets or sets the number of the last row to copy.
Public property MaximumErrors Gets or sets the maximum number of errors that can occur before the bulk insert operation fails.
Public property RowTerminator Gets or sets the row terminator for use in char and widechar data files.
Public property SortedData Gets or sets the Order by clause in the bulk insert statement
Public property SourceConnection Gets or sets the name of the source connection object.
Public property SqlStatement Gets a String array that contains the Transact-SQL statement to run.
Public property 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.
Public property TableLock Gets or sets a Boolean that indicates whether the table is locked during the bulk insert operation.
Public property UseFormatFile Gets or sets a Boolean that indicates whether the Bulk Insert task uses a format file.
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 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.
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 Bulk Insert 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 runtime 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 runtime 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 Bulk Insert task component is correctly configured. (Overrides Task.Validate(Connections, VariableDispenser, IDTSComponentEvents, IDTSLogging).)

Top

Remarks

For more information, see Bulk Insert 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.BulkInsertTask Namespace