Adf Dataflow Dataset Sink Element
X-Ref:
- Ast Adf Dataflow Dataset Sink Node
- Ast Adf Dataflow Dataset Base Node
- Ast Adf Dataflow Component Base Node
- Ast Scope Boundary Node
Attributes
| Attribute | API Type | Default | Description |
|---|---|---|---|
| DatasetName | AstAdfDatasetBaseNode | Specifies a reference to the dataset used in the dataflow. This is a required reference to an existing definiton. | |
| InputStreamName | AstAdfDataflowOutputStreamNode | A reference to a previous component's output stream. 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 | |
| SkipDuplicateInputColumns | Boolean | False | If the same input column is used in more than one mapping, then any instance after the first will be skipped. This is a required property |
| SkipDuplicateOutputColumns | Boolean | False | If a mapping will produce an output column that matches another column, then each instance after the first will be skipped. This is a required property |
| AllowDelete | Boolean | False | Allow rows to be deleted in the sink. |
| AllowInsert | Boolean | False | Allow rows to be inserted in the sink. |
| AllowSchemaDrift | Boolean | False | Select true if your source columns are likely to change during the dataflow. If marked true, all columns pass through the dataflow to the sink. |
| AllowUpdate | Boolean | False | Allow rows to be updated in the sink. |
| AllowUpsert | Boolean | False | Allow rows to be upserted in the sink. |
| BatchSize | Int32 | -1 | Size of batches for columnar caching. |
| PartitionOption | AdfDataflowPartitionOption | CurrentPartitioning | Specifies how the user would like to handle partitioning inside of dataflow components. |
| TableAction | AdfDataflowSinkTableAction | None | Select the table action: None, Truncate, Recreate. |
| ValidateSchema | Boolean | False | Dataflow will fail if any column in the dataflow is not found in the source. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <RoundRobin /> | AstAdfRoundRobinPartitionSettingsNode | Settings node for Round Robin partitioning in dataflow components. |
| <Hash /> | AstAdfHashPartitionSettingsNode | Settings node for Hash partitioning in dataflow components. |
| <DynamicRange /> | AstAdfDynamicRangePartitionSettingsNode | Settings node for Dynamic Range partitioning in dataflow components. |
| <FixedRange /> | AstAdfFixedRangePartitionSettingsNode | Settings node for Fixed Range partitioning in dataflow components. |
| <Key /> | AstAdfKeyPartitionSettingsNode | Settings node for Key partitioning in dataflow components. |
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. |
| <ColumnMappings> Multiple Choices... </ColumnMappings> | AstAdfDataflowComponentColumnBaseNode | This is a collection of column mappings that are used to map the columns to the sink. |
| <Columns> <Column /> </Columns> | AstAdfDataflowDatasetColumnNode | Specifies an optional list of columns to be used as an output from a source or input for a sink. |
| <Parameters> <Parameter /> </Parameters> | AstAdfDatasetReferenceParameterNode | Specifies an optional list of parameters to be passed in with the dataset. |
| <PostSqlScripts> <Script /> </PostSqlScripts> | String | This is a collection of scripts to run after the sink action. |
| <PreSqlScripts> <Script /> </PreSqlScripts> | String | This is a collection of scripts to run before the sink action. |