prorm API Reference
    Preparing search index...

    Interface ExplainOptions

    Explain options

    interface ExplainOptions {
        format?: ExplainFormat;
        analyze?: boolean;
        verbose?: boolean;
        costs?: boolean;
        buffers?: boolean;
        timing?: boolean;
        schema?: boolean;
        type?: "SELECT" | "INSERT" | "UPDATE" | "DELETE";
        [key: string]: any;
    }

    Indexable

    • [key: string]: any

      Custom options to pass to EXPLAIN

    Index
    format? analyze? verbose? costs? buffers? timing? schema? type?
    format?: ExplainFormat

    Output format (text, json, xml, yaml)

    analyze?: boolean

    For MySQL: ANALYZE the query

    verbose?: boolean

    For MySQL: show format JSON

    costs?: boolean

    For MySQL: show costs

    buffers?: boolean

    For MySQL: show buffers

    timing?: boolean

    For MySQL: timing information

    schema?: boolean

    For MySQL: show schema

    type?: "SELECT" | "INSERT" | "UPDATE" | "DELETE"

    For MySQL: type of statement (SELECT, INSERT, UPDATE, DELETE)

    Settings
    Member Visibility

    On This Page
    Properties