prorm API Reference
    Preparing search index...

    Interface DestroyOptions

    Options for deleting rows. On a paranoid model this soft-deletes unless force is set.

    interface DestroyOptions {
        transaction?: Transaction;
        hooks?: boolean;
        validate?: boolean;
        fields?: string[];
        skip?: string[];
        individualHooks?: boolean;
        bench?: boolean;
        model?: any;
        instances?: Model[];
        where: WhereOptions;
        limit?: number;
        truncate?: boolean;
        cascade?: boolean;
        force?: boolean;
        restartIdentity?: boolean;
        returning?: boolean | string[];
        paranoid?: boolean;
        logging?: boolean | ((sql: string, time?: number) => void);
        using?: string;
    }

    Hierarchy (View Summary)

    Index
    transaction? hooks? validate? fields? skip? individualHooks? bench? model? instances? where limit? truncate? cascade? force? restartIdentity? returning? paranoid? logging? using?
    transaction?: Transaction
    hooks?: boolean
    validate?: boolean
    fields?: string[]
    skip?: string[]
    individualHooks?: boolean
    bench?: boolean
    model?: any
    instances?: Model[]
    where: WhereOptions
    limit?: number
    truncate?: boolean
    cascade?: boolean
    force?: boolean
    restartIdentity?: boolean
    returning?: boolean | string[]
    paranoid?: boolean

    When false, performs a soft delete by setting deletedAt instead of actually deleting When true, actually deletes the record (bypasses paranoid mode)

    false
    logging?: boolean | ((sql: string, time?: number) => void)

    Logging options for the query

    using?: string

    Connection name to use for this query Allows querying a different database connection

    Settings
    Member Visibility

    On This Page
    Properties