Bulk Insert Task Element
X-Ref:
- Ast Bulk Insert Task Node
- Ast Task Base Node
- Ast Task Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| ConnectionName | AstOleDbConnectionNode | This value specifies a direct reference to the OLE DB connection that will be used to bulk insert the data. This is a required reference to an existing definiton. | |
| Name | String | Specifies the name of the object. This name can be used to reference this object from anywhere else in the program. This is a required property | |
| BatchSize | Int64 | 0 | This value specifies whether all of the data is copied in a single transaction or in a series of smaller batches. |
| CheckConstraints | Boolean | True | This value specifies whether constraint checking is enforced or ignored during bulk import of data. |
| CodePage | String | This value specifies the code page of the data file if the data in the file contains relevant text or character data. | |
| DataFileType | BulkInsertTaskDataFileType | Char | This value specifies which data-file type the Bulk Insert task uses when importing the data. |
| DelayValidation | Boolean | false | This value specifies whether the validation of the Dataflow task in SSIS should be delayed until the package is executed. DelayValidation is most often used when the ETL process references tables and other server assets that were created in an earlier stage of the data processing run. |
| Disabled | Boolean | false | This value specifies whether the item is disabled. The default value is False. |
| DisableEventHandlers | Boolean | false | This value specifies whether the event handlers for this task, container, or package should be prevented from executing. The default value is False. |
| ExecutionValueVariableName | AstVariableBaseNode | Specifies a variable to hold the execution results of this component. This references an existing definiton. | |
| FailPackageOnFailure | Boolean | false | This value determines whether the container will fail when a container component fails. If this container corresponds to a package, then the only valid value is False. |
| FailParentOnFailure | Boolean | false | This value determines whether the parent container will fail when a child container failes. The default value is False. |
| FieldTerminator | Delimiter | Tab | This value specifies which field terminator is used in char and widechar data files. The default is tab (\t). |
| FireTriggers | Boolean | False | This value specifies whether insert triggers are executed on the table during the operation. The default is False. Set the value to True to fire the triggers. |
| FirstRow | Int64 | 1 | This value specifies the first row from which to start copying. The default value is 1 (i.e. the first row in the data file is the first row copied.) |
| ForcedExecutionValue | String | "0" | If the ForceExecutionValue property is set to True, then the container will return the value stored in this property as its execution value. Otherwise, this value will be ignored. The default value for ForecedExecutionValue is 0. |
| ForcedExecutionValueDataType | TypeCode | Int32 | This property specifies the data type of the value stored in the ForceExecutionValue property. |
| ForceExecutionResult | ForceExecutionResult | None | This value indicates whether a specified execution result value will result if the container runs. The default value is None, which means that the container does not force a specified outcome. |
| ForceExecutionValue | Boolean | false | Gets or sets a Boolean that indicates whether the execution value of the container should be forced to contain the value specified in the ForcedExecutionValue property. |
| Id | Guid | 00000000-0000-0000-0000-000000000000 | Allows the developer to specify a unique identifier (GUID) for the package. This can be used to retain a consistent ID between builds. |
| IsolationLevel | IsolationLevel | Serializable | Sets the Isolation Level which controls how Transactions behave for this container. |
| KeepIdentity | Boolean | False | This value specifies whether the identity value or values specified in the source data are applied to the identity column in the destination table or view or ignored. The default value is True, meaning that the source identity values are used. |
| KeepNulls | Boolean | False | This value specifies whether empty columns retain a null value or receive specifed default values during the bulk load operation. |
| Language | Language | Inherited | This specifies the default language to be used by this task and its descendants. |
| LastRow | Int64 | 0 | This value specifies which row is the last to be copied. |
| LoggingMode | LoggingMode | Inherit | This value specifies whether logging is enabled or disabled by the container or by the parent container. The default value is UseParentSetting. |
| MaxErrorCount | Int32 | 1 | This value specifies the maximum number of errors allowed to occur before a package is forced to stop running. The default value is 1. |
| MaxErrors | Int64 | 0 | This value specifies the maximum number of errors allowed before the bulk insert operation is halted. A value of 0 means that there is no limit on the number of errors allowed. |
| RowTerminator | Delimiter | CRLF | This value which row terminator is used in char and widechar data files. The default is newline (\n). |
| SortedData | String | This value specifies whether the data is sorted using an orber by clause in the bulk insert statement. The default value is False, meaning that the data is not sorted by an order by clause. | |
| TableLock | Boolean | False | This value specifies whether the destination table is locked during the bulk insert operation. Set the value to True to lock the table. |
| TransactionMode | ContainerTransactionMode | Join | This value specifies the transaction context in which this task will execute. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <DestinationTable /> | AstTableResourceNode | The AstTableResourceNode type is used for creating references to a table that has been modeled in the Biml project. This is a required property |
| <ExternalDestinationTable /> | AstUnmanagedTableResourceNode | The AstUnmanagedTableResourceNode type is used for creating references to a table stored in an existing relational database that has not been modeled in the Biml project. This is a required property |
| <SourceFile /> | AstFileResourceNode | AstFileResourceNode is used for creating references to file connections that have been modeled in the Biml project. This is a required property |
| <ExternalSourceFile /> | AstExternalFileResourceNode | The AstExternalFileResourceNode type is used for creating references to a file path on the local file system that has not been modeled in the Biml project as a file connection. This is a required property |
| <FormatFile /> | AstFileResourceNode | AstFileResourceNode is used for creating references to file connections that have been modeled in the Biml project. |
| <ExternalFormatFile /> | AstExternalFileResourceNode | The AstExternalFileResourceNode type is used for creating references to a file path on the local file system that has not been modeled in the Biml project as a file connection. |
| <PrecedenceConstraints /> | AstTaskflowPrecedenceConstraintsNode | The AstTaskflowPrecedenceConstraintsNode type corresponds directly to a precedence constraint in a SQL Server Integration Services task control flow. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <Annotations> <Annotation /> </Annotations> | AstAnnotationNode | This is a collection of annotation items that can be used to specify documentation, tags, or other information. Annotations are particularly useful for storing information about nodes that can be used by BimlScript code. |
| <Events> <Event /> </Events> | AstTaskEventHandlerNode | This is a collection of event handlers that can respond to SQL Server Integration Services events that are raised on this task. |
| <Expressions> <Expression /> </Expressions> | AstPropertyExpressionNode | This is a collection of SSIS expression definitions for property value overrides that are specific to this task, container, or package. |
| <LogEvents> <LogEvent /> </LogEvents> | AstLogEventNode | This is a container for log event definitions that are specific to this task, container, or package. |
| <LogProviders> Multiple Choices... </LogProviders> | AstLogProviderBaseNode | Defines the log providers to use for the SSIS task or container This is a container for log provider definitions that are specific to this task, container, or package. |
| <Variables> <Variable /> </Variables> | AstVariableNode | This is a container for variable definitions that are specific to this task, container, or package. |