2.7.1.5.1.1.1 BulkInsertTaskDataType

  • Article

The BulkInsertTaskDataType type holds parameters, properties, and settings for a Bulk Insert Task.

The following is the XSD for the BulkInsertTaskDataType type.

   <xs:complexType name="BulkInsertTaskDataType">
     <xs:sequence/>
     <xs:attribute name="BatchSize" type="BulkInsertTask:CodePageType"/>
     <xs:attribute name="CheckConstraints">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:enumeration value="True"/>
           <xs:enumeration value="False"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="CodePage" type="xs:string"/>
     <xs:attribute name="SourceConnectionName" type="xs:string"/>
     <xs:attribute name="DestinationConnectionName" type="xs:string"/>
     <xs:attribute name="DataFileType" 
                   type="BulkInsertTask:DataFileTypeEnum"/>
     <xs:attribute name="DestinationTableName" type="xs:string"/>
     <xs:attribute name="FirstRow" type="xs:int"/>
     <xs:attribute name="LastRow" type="xs:int"/>
     <xs:attribute name="UseFormatFile">
     <xs:simpleType>
       <xs:restriction base="xs:string">
         <xs:enumeration value="True"/>
         <xs:enumeration value="False"/>
       </xs:restriction>
     </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="FormatFile" type="xs:string"/>
     <xs:attribute name="SortedData" type="xs:string"/>
     <xs:attribute name="TableLock">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:enumeration value="True"/>
           <xs:enumeration value="False"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="KeepIdentity">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:enumeration value="True"/>
           <xs:enumeration value="False"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="KeepNulls">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:enumeration value="True"/>
           <xs:enumeration value="False"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="FieldTerminator" 
                   type="BulkInsertTask:BulkInsertTaskTerminatorEnum"/>
     <xs:attribute name="RowTerminator" 
                   type="BulkInsertTask:BulkInsertTaskTerminatorEnum"/>
     <xs:attribute name="FireTriggers">
       <xs:simpleType>
         <xs:restriction base="xs:string">
           <xs:enumeration value="True"/>
           <xs:enumeration value="False"/>
         </xs:restriction>
       </xs:simpleType>
     </xs:attribute>
     <xs:attribute name="MaximumErrors" type="xs:int"/>
   </xs:complexType>

The BulkInsertTaskDataType type MUST NOT contain elements or values.

The following table specifies additional information for the attributes of the BulkInsertTaskDataType type.

Attribute

Description

BatchSize

This integer specifies the number of rows in a batch. Each batch is processed as a single transaction.<55>

CheckConstraints

This enumeration value specifies whether constraints on the table are checked during the bulk insert operation.

"True" specifies that constraints are checked.

"False" specifies that constraints are not checked.

CodePage

This value specifies the code page of the data in the data file.

SourceConnectionName

This string specifies the name of the source connection file.

DestinationConnectionName

This string specifies the name of the connection to the destination database.

DataFileType

This enumeration value specifies the type of text that is in the file.

DestinationTableName

This string specifies the name of the table in the destination database.

FirstRow

The row in the data file at which insertion begins.

LastRow

The row in the data file at which insertion ends.<56>

UseFormatFile

This enumeration value specifies whether a format file is used for the bulk insert operation.

"True" specifies that a format file is used for the bulk insert operation.

"False" specifies that a format file is not used for the bulk insert operation.

FormatFile

The string specifies the name of the format file. This string is used only when the UseFormatFile attribute is set to "True".

SortedData

This string specifies the columns on which to sort the data.

TableLock

This enumeration value specifies whether a table level lock is acquired for the bulk insert operation.

"True" specifies that a table level lock is acquired for the bulk insert operation.

"False" specifies that a table level lock is not acquired for the bulk insert operation.

KeepIdentity

This enumeration value specifies whether to keep data values from the data file for values for identity columns.

"True" specifies that values present in the data file are kept for identity columns.

"False" specifies that values present in the data file are not kept for identity columns.

KeepNulls

This enumeration value specifies whether null values in the input are retained.

"True" specifies that null values in the input are retained.

"False" specifies that a default value is used if a null value is encountered in the input.

FieldTerminator

This enumeration value specifies the character that terminates a field.

RowTerminator

This enumeration value specifies the character that terminates a row.

FireTriggers

This enumeration value specifies whether insert triggers that are specified for the table are fired during the bulk insert operation.

"True" specifies that triggers are fired during the bulk insert operation.

"False" specifies that triggers are not fired during the bulk insert operation.

MaximumErrors

This enumeration value specifies the maximum number of errors allowed.