prorm API Reference
    Preparing search index...

    Interface ModelOptions

    Model options type

    interface ModelOptions {
        tableName?: string;
        schema?: string;
        schemaDelimiter?: string;
        engine?: string;
        modelName?: string;
        hooks?: boolean;
        underscored?: boolean;
        freezeTableName?: boolean;
        indexes?: IndexOptions[];
        comment?: string;
        collate?: string;
        validate?: Record<string, any>;
        timestamps?: boolean;
        createdAt?: string | false;
        updatedAt?: string | false;
        deletedAt?: string | false;
        primaryKey?: boolean;
        columnNames?: Record<string, string>;
    }
    Index
    tableName? schema? schemaDelimiter? engine? modelName? hooks? underscored? freezeTableName? indexes? comment? collate? validate? timestamps? createdAt? updatedAt? deletedAt? primaryKey? columnNames?
    tableName?: string

    Table name

    schema?: string

    Schema name

    schemaDelimiter?: string

    Schema delimiter

    engine?: string

    Engine (for MySQL)

    modelName?: string

    Model name

    hooks?: boolean

    Enable hooks

    underscored?: boolean

    Override default timestamp columns

    freezeTableName?: boolean

    Use pluralized table name

    indexes?: IndexOptions[]

    Indexes

    comment?: string

    Comment

    collate?: string

    Default collation (MySQL)

    validate?: Record<string, any>

    Validation

    timestamps?: boolean

    Timestamps

    createdAt?: string | false

    CreatedAt column name

    updatedAt?: string | false

    UpdatedAt column name

    deletedAt?: string | false

    DeletedAt column name (paranoid)

    primaryKey?: boolean

    Primary key option

    columnNames?: Record<string, string>

    Column names

    Settings
    Member Visibility

    On This Page
    Properties