Value Inclusion Profile Request Element
X-Ref:
- Ast Value Inclusion Profile Request Node
- Ast Data Profile Request Node
Attributes
Attribute | API Type | Default | Description |
---|---|---|---|
ConnectionName | AstAdoNetConnectionNode | This value specifies the connection that will be used to access the target table. 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 | |
InclusionStrengthThreshold | Double | 0.95 | This value specifies the threshold for column inclusion strength that must be satisfied before column inclusion strength is reported. This value must be specified in conjunction with a InclusionThresholdSetting of 'Specified'. The default is 0.95. |
InclusionThresholdSetting | ProfileRequestThresholdSetting | Specified | This value specifies the conditions under which the subset columns will be reported as included. The default is 'Specified'. |
MaxNumberOfViolations | Int32 | 100 | This value specifies the maximum number of value inclusion violations to report. If ThresholdSetting is 'Exact', then this property is ignored (as it is implied to be 0). The default is 100. |
SchemaId | String | This value specifies the name of the schema that contains the table that will examined by the data profile task. This property is used in conjunction with TableId when the table cannot be referenced by the Table property, because it has not been modeled in the Biml project. | |
SupersetColumnsKeyThreshold | Double | 0.95 | This value specifies the threshold for column key inclusion strength that must be satisfied before column key inclusion strength is reported. This value must be specified in conjunction with a SupersetColumnsKeyThresholdSetting of 'Specified'. The default is 0.95. |
SupersetColumnsKeyThresholdSetting | ProfileRequestThresholdSetting | Specified | This value specifies the conditions under which the subset columns will be reported as included in the key of the superset table. The default is 'Specified'. |
SupersetTableOrViewName | AstTableNode | This value specifies a direct connection to the table that will used as the superset table. This references an existing definiton. | |
SupersetTableOrViewSchemaId | String | This value specifies the name of the schema that contains the superset table. This property is used in conjunction with SupersetTableOrViewTableId when the superset table cannot be referenced by the SupersetTableOrView property, because it has not been modeled in the Biml project. | |
SupersetTableOrViewTableId | String | This value specifies the name of the superset table. This property is used in conjunction with SupersetTableOrViewSchemaId when the superset table cannot be referenced by the SupersetTableOrView property, because it has not been modeled in the Biml project. | |
TableName | AstTableNode | This value specifies a direct connection to the table that will examined by the data profile task. This references an existing definiton. | |
TableId | String | This value specifies the name of the table that will examined by the data profile task. This property is used in conjunction with SchemaId when the table cannot be referenced by the Table property, because it has not been modeled in the Biml project. |
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. |
<SubsetInclusionColumns> <Column /> </SubsetInclusionColumns> | String | This collection defines the names of the columns in the subset table that will be used to check for inclusion. |
<SupersetInclusionColumns> <Column /> </SupersetInclusionColumns> | String | This collection defines the names of the columns in the superset table that will be used to check for inclusion. |