Index
Overview
An Index is an AnalyticsCreator design object that defines an index for a warehouse table.
It combines index behavior with an ordered set of table columns.
Function
Use indexes to define primary-key, clustered, unique, columnstore, and supporting index structures for physical tables.
Index settings are validated against the owning table, including restrictions on multiple clustered or primary-key indexes and incompatible columnstore combinations.
Types
Index behavior is controlled by flags that can be combined where the database rules permit.
| Type | Use |
|---|---|
| Standard index | Defines one or more ordered key columns. |
| Unique index | Requires unique key values. |
| Clustered index | Defines the table's clustered storage order. |
| Primary-key index | Implements the table's primary key. |
| Columnstore index | Uses columnstore storage for supported analytical scenarios. |
Attributes
Attributes define the configuration, behavior, and relationships of the index entity.
| Attribute | Applies to | Description |
|---|---|---|
| Table | All indexes | Table that owns the index. |
| Name | All indexes | Required index name. |
| Description | All indexes | Documents the purpose of the index. |
| Compression type | Supported indexes | Compression option used when the index is generated. |
| Unique | Optional behavior | Requires unique key values. |
| Clustered | Optional behavior | Marks the index as clustered. |
| Primary key | Optional behavior | Marks the index as the table primary-key index. |
| Columnstore | Optional behavior | Marks the index as a columnstore index. |
| Columns | All indexes | Ordered table columns included in the index. |
| Sort and include settings | Index columns | Descending direction and include-only behavior for each column. |
How it is used in AnalyticsCreator
| Use case | Description |
|---|---|
| Define table keys | Implement the primary key or a supporting unique key. |
| Improve generated database performance | Create ordered or included columns that support expected access patterns. |
| Support analytical storage | Define columnstore indexing where applicable. |
| Keep index metadata in the model | Generate index definitions consistently with the table design. |
Relationships
| Related entity | Relationship |
|---|---|
| Table | An index belongs to one table. |
| Column | An index contains one or more table columns. |
| Schema | The owning table determines the schema in which the index is generated. |
Where to configure
Configure or review this entity from the matching AnalyticsCreator user-interface area.
