Member Junction
    Preparing search index...

    Interface AutoDocIndex

    An existing index on a table, as read from the database catalog. Primary-key indexes are included (IsPrimaryKey = true).

    interface AutoDocIndex {
        Columns: string[];
        FilterDefinition?: string;
        HasExpressions: boolean;
        IncludeColumns: string[];
        IndexName: string;
        IsPrimaryKey: boolean;
        IsUnique: boolean;
        Method: string;
        SchemaName: string;
        TableName: string;
    }
    Index

    Properties

    Columns FilterDefinition? HasExpressions IncludeColumns IndexName IsPrimaryKey IsUnique Method SchemaName TableName

    Properties

    Columns: string[]

    Key parts, in index order. An expression key part (PostgreSQL lower(code), MySQL functional key part) appears as AUTODOC_EXPRESSION_KEY_PART at its position, so the order of the named columns, and therefore which column leads the index, is preserved.

    FilterDefinition?: string

    Partial-index predicate (PostgreSQL WHERE / SQL Server filter), when present.

    HasExpressions: boolean

    True when some key parts are expressions rather than plain columns.

    IncludeColumns: string[]

    Non-key columns carried by the index (SQL Server INCLUDE / PostgreSQL INCLUDE).

    IndexName: string
    IsPrimaryKey: boolean
    IsUnique: boolean
    Method: string

    Access method or index type as the database names it (btree, gin, NONCLUSTERED, BTREE, …).

    SchemaName: string
    TableName: string

    Settings

    Member Visibility

    On This Page

    Properties