Candidate Key Profile Request Element
X-Ref:
- Ast Candidate Key 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 | |
| KeyStrengthThreshold | Double | 0.95 | This value specifies the threshold for key strength that must be satisfied before key strength is reported. This value must be specified in conjunction with a ThresholdSetting of 'Specified'. The default is 0.95. |
| MaxNumberOfViolations | Int32 | 100 | This value specifies the maximum number of unique key 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. | |
| 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. | |
| ThresholdSetting | ProfileRequestThresholdSetting | Specified | This value specifies the conditions under which the strength of a given candidate key will be reported. The default is 'Specified'. |
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. |
| <KeyColumns> <Column /> </KeyColumns> | String | This is a collection of names of columns that will be examined as candidate key columns for the table. |