Excel Destination Element
X-Ref:
- Ast Excel Destination Node
- Ast Ole Db Destination Node
- Ast Destination Transformation Node
- Ast Single In Transformation Node
- Ast Transformation Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| ConnectionName | AstOleDbConnectionNode | This value specifies the OLE DB connection to use when loading 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 | |
| AlwaysUseDefaultCodePage | Boolean | False | This value specifies whether the DefaultCodePage value is always used for each column. The default value is False. |
| BatchSize | Int32 | 0 | This value specifies how many rows can be loaded into the destination table in each batch before additional rows are requested from the data flow pipeline. The default value is 0, which is the equivalent of assigning no value. In this case, the component will make its own determination of batch size. |
| CheckConstraints | Boolean | True | This value indicates whether constraints are while the data is being loaded into the destination table. The default value is True. |
| DefaultCodePage | Int32 | 0 | This value specifies the default codepage to be used with the OLE DB destination. |
| FastLoadOptions | String | If the fast load data access mode, fast load options can be used to lock tables and check contraints during data loading. This option is specifically used for additional fast load options that are not exposed as properties on the OLE DB Destination. | |
| KeepIdentity | Boolean | False | This value determines whether identity values are copied when the data is loaded. The default value is False. |
| KeepNulls | Boolean | False | This value determines whether null values are copied when the data is loaded. The default value is False. |
| LocaleId | Language | Inherited | This value specifies which locale is used by the dataflow task. |
| MaximumInsertCommitSize | Int32 | -1 | This value specifies how many rows can be loaded into the destination table in each batch before additional rows are requested from the data flow pipeline during a fast load. The default value is 0, which is the equivalent of assigning no value. |
| TableLock | Boolean | True | This value specifies whether the destination table is locked while the data is loaded. The default value is True. |
| Timeout | Int32 | 0 | The number of seconds before the command times out. 0 indicates an infinite time-out. |
| UseFastLoadIfAvailable | Boolean | True | This value specifies whether FastLoad options are used. |
| ValidateExternalMetadata | Boolean | true | This value specifies whether the data flow transformation is validated against columns that originated in external data sources. When server assets such as tables and stored procedures are created during processing, ValidateExternalMetadata is normally set to False, which prevents validation from completing at compile time. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <SqlCommandOutput /> | AstDirectResourceNode | The AstDirectResourceNode type provides the facility to directly input text data for use in the referencing Biml object. This is a required property |
| <TableOutput /> | 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 |
| <TableFromVariableOutput /> | AstTableFromVariableResourceNode | The AstTableFromVariableResourceNode type provides the facility to reference a SQL Server Integration Services package variable that contains a table name for use in the referencing Biml object. This is a required property |
| <ExternalTableOutput /> | 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 |
| <ErrorHandling /> | AstComponentErrorHandlingNode | Specifies the error handling defaults to apply to an entire component |
| <InputPath /> | AstDataflowInputPathNode | AstDataflowInputPathNode is used to model input paths in a SQL Server Integration Services dataflow task. Connections are made by referencing an appropriate output path. |
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. |
| <Columns> <Column /> </Columns> | AstDataflowColumnMappingNode | This value specifies how the component should map columns in the data flow to columns in the destination. Columns that are not explicitly listed in this collection are automatically mapped based on name. |
| <DataflowOverrides> Multiple Choices... </DataflowOverrides> | AstDataflowOverrideNode | Provides a collection of objects to override properties of the component, its input paths, its output paths, and its consituent dataflow columns. |