View Source

Class IndexDefinition

Represents the definition and properties of a database index, including its columns and constraints.

Inheritance
object
Namespace: Umbraco.Cms.Infrastructure.Persistence.DatabaseModelDefinitions
Assembly: Umbraco.Infrastructure.dll
Syntax
public class IndexDefinition

Constructors

View Source

IndexDefinition()

Declaration
public IndexDefinition()

Properties

View Source

ColumnName

Gets or sets the name of the database column to which this index applies.

Declaration
public virtual string? ColumnName { get; set; }
Property Value
Type Description
string
View Source

Columns

Gets or sets the collection of IndexColumnDefinition objects that define the columns included in this index.

Declaration
public virtual ICollection<IndexColumnDefinition> Columns { get; set; }
Property Value
Type Description
ICollection<IndexColumnDefinition>
View Source

IncludeColumns

Gets or sets the collection of columns that are included in the index definition, but are not key columns. These columns are typically used to improve query performance by covering additional columns in the index.

Declaration
public virtual ICollection<IndexColumnDefinition> IncludeColumns { get; set; }
Property Value
Type Description
ICollection<IndexColumnDefinition>
View Source

IndexType

Gets or sets the type of the database index, as defined by the IndexTypes enumeration.

Declaration
public IndexTypes IndexType { get; set; }
Property Value
Type Description
IndexTypes
View Source

Name

Gets or sets the name of the index.

Declaration
public virtual string? Name { get; set; }
Property Value
Type Description
string
View Source

SchemaName

Gets or sets the schema name associated with the index.

Declaration
public virtual string? SchemaName { get; set; }
Property Value
Type Description
string
View Source

TableName

Gets or sets the name of the database table to which this index definition applies.

Declaration
public virtual string? TableName { get; set; }
Property Value
Type Description
string