Table Index Element
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 the index is clustered. A clustered index is physically laid out on disc with all columns of the rows of the table. |
| CompressionType | TableCompressionType | None | This value specifies what kind of compression the index uses. |
| DropExisting | Boolean | false | When DropExisting is specified, the index creation removes any existing indexes with the same name before creating the new index. Unspecified properties in the new index are inherited from the dropped index. Without this option, an attempt to create a second index with the same name would result in an error. |
| 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 index value should produce a warning (and continue) or an error (and terminate). This property applies only for indexes where the value of Unique is True. It is useful for enabling large bulk inserts to complete when duplicate rows exist. |
| Online | Boolean | false | This value specifies whether the index remains online and accessible while index operations are being performed. |
| PadIndex | Boolean | false | This value determines whether each intermediate level of the index is padded with extra open space in each page. |
| PartitionColumnName | AstTableColumnBaseNode | Defines the column used by the partition scheme. This references an existing definiton. | |
| PartitionSchemeName | AstPartitionSchemeNode | Defines the partition scheme used to partition this index. This references an existing definiton. | |
| SortInTempdb | Boolean | false | This value determines whether the configured temporary database should be used for storing the index. |
| Unique | Boolean | false | This value specifies whether each index value is unique. When the value is True, no two rows have the same values across all of the columns participating in the index. |
Singleton Children
| Child | API Type | Description |
|---|---|---|
| <FileGroup /> | AstDatabaseFileGroupResourceNode | AstDatabaseFileGroupResourceNode is used for creating references to database file groups that have been modeled in the Biml project. |
| <ExternalFileGroup /> | AstExternalDatabaseFileGroupResourceNode | AstExternalDatabaseFileGroupResourceNode is used for creating references to database file groups that have not been modeled in the Biml project. |
| <FilterPredicate /> | String | String is the .NET Framework String class. More information can be found at http://msdn.microsoft.com/en-us/library/system.string.aspx. |
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. |
| <Columns> <Column /> </Columns> | AstTableIndexColumnNode | This is a container for index column reference definitions. |
| <Includes> <Include /> </Includes> | AstTableIndexLeafNode | This is a container for index include column reference definitions. |