prorm API Reference
    Preparing search index...

    Interface IndexFieldDefinition

    Index definition for addIndex

    interface IndexFieldDefinition {
        name: string;
        length?: string | number;
        order?: "ASC" | "DESC";
        collate?: string;
        expression?: SqlExpression;
    }
    Index
    name length? order? collate? expression?
    name: string
    length?: string | number
    order?: "ASC" | "DESC"
    collate?: string
    expression?: SqlExpression

    Expression for expression-based indexes. Prefer the expression helpers, which quote identifiers for the target dialect:

    { expression: fn('LOWER', col('email')) }   // LOWER("email")

    A raw SQL string is still accepted.

    Settings
    Member Visibility

    On This Page
    Properties