prorm API Reference
    Preparing search index...

    Interface IndexBuilderOptions

    Index options

    interface IndexBuilderOptions {
        name?: string;
        type?: string;
        unique?: boolean;
        ifNotExists?: boolean;
        where?: WhereCondition;
        nullsFirst?: boolean;
    }
    Index
    name? type? unique? ifNotExists? where? nullsFirst?
    name?: string

    Index name

    type?: string

    Index type: BTREE, HASH, GIN, GiST, BRIN, etc.

    unique?: boolean

    Unique index

    ifNotExists?: boolean

    Index if not exists

    where?: WhereCondition

    Partial index WHERE clause

    nullsFirst?: boolean

    NULLS FIRST/LAST (PostgreSQL)

    Settings
    Member Visibility

    On This Page
    Properties