prorm API Reference
    Preparing search index...

    Interface TableIndex

    An index declared alongside the table rather than in a separate statement.

    interface TableIndex {
        name?: string;
        unique?: boolean;
        type?: string;
        using?: string;
        fields: string[];
        where?: string | WhereOptions;
        expression?: string;
        include?: string[];
    }
    Index
    name? unique? type? using? fields where? expression? include?
    name?: string
    unique?: boolean
    type?: string
    using?: string
    fields: string[]
    where?: string | WhereOptions

    See IndexOptions.where.

    expression?: string

    Expression for expression-based indexes (e.g., LOWER(column))

    include?: string[]

    Include columns for covering index (PostgreSQL 11+, MySQL 8.0.17+)

    Settings
    Member Visibility

    On This Page
    Properties