Table Identity Element
X-Ref:
- Ast Table Identity Node
- Ast Table Key Base 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 | |
| Clustered | Boolean | false | This value specifies whether incoming rows that have a duplicate key value should produce a warning (and continue) or an error (and terminate). This property applies only for keys where the value of Unique is True. It is useful for enabling large bulk inserts to complete when duplicate rows exist. |
| FillFactor | Int32 | 0 | This value specifies what percentage of each index page the database engine should fill when creating or rebuilding the index. |
| IgnoreDupKey | Boolean | false | This value specifies whether incoming rows that have a duplicate key value should produce a warning (and continue) or an error (and terminate). This property applies only for keys where the value of Unique is True. It is useful for enabling large bulk inserts to complete when duplicate rows exist. |
| Increment | Int32 | 1 | This value specifies the amount by which the Identity value is incremented when a row is inserted. Both seed and increment must be specified if either is explicitly specified. The default value is 1. |
| IsEnabled | Boolean | True | Enables or Disables this constraint. Disabled constraints will not be generated in the emitted SQL statements but will have metadata available for other use. |
| PadIndex | Boolean | false | This value determines whether each intermediate level of the index is padded with extra open space in each page. |
| Seed | Int32 | 1 | This value specifies the starting value for an identity column. When the first row is inserted into the table, this value is used. Both seed and increment must be specified if either is explicitly specified. The default value is 1. |
| Unique | Boolean | true | This value specifies whether each key value is unique. When the value is True, no two rows have the same values across all of the columns participating in the key. |
Collection Children
| Child | API Type | Description |
|---|---|---|
| <Columns> <Column /> </Columns> | AstTableKeyColumnNode | This is a container for key column reference definitions. This is a required property |
| <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. |