Aggregate Element
X-Ref:
- Ast Aggregate Node
- Ast Single In Transformation Node
- Ast Transformation Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| 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 | |
| AutoExtendFactor | Int32 | 25 | This value specifies the percentage that memory can be extended during aggregation. The default value is 25. Valid values are between 1 and 100. |
| CountDistinctKeys | Int32 | 0 | This value specifies exactly how many distinct values the transformation can count in a column. If a CountDistinctKeyScale value is also specified, the value in CountDistinctKeys takes precedence. |
| CountDistinctScale | AggregateTransformScale | Unspecified | This value specifies approximately how many distinct values the transformation can count in a column. |
| GroupByKeys | Int32 | 0 | This value specifies the exact number of group by keys that the aggregation produces. If a GroupByKeyScale value is also specified, the value in GroupByKeys takes precedence. |
| GroupByKeyScale | AggregateTransformScale | Unspecified | This value specifies approximately how many Group By keys the Aggregation transformation can produce. |
| LocaleId | Language | Inherited | This value specifies which locale is used by the dataflow task. |
| 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 |
|---|---|---|
| <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. |
| <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. |
| <OutputPaths> <OutputPath /> </OutputPaths> | AstAggregateOutputPath | This is a collection of output path definitions to which the results of the aggregation are directed. |