Type alias SingleExplainResult

SingleExplainResult: {
    cacheable: boolean;
    plan: ExplainPlan;
    stats: {
        plansCreated: number;
        rulesExecuted: number;
        rulesSkipped: number;
    };
    warnings: {
        code: number;
        message: string;
    }[];
}

Result of explaining a query with a single plan.

Type declaration

  • cacheable: boolean

    Whether it would be possible to cache the query.

  • plan: ExplainPlan

    Query plan.

  • stats: {
        plansCreated: number;
        rulesExecuted: number;
        rulesSkipped: number;
    }

    Statistical information about the query plan generation.

    • plansCreated: number

      Total number of plans created.

    • rulesExecuted: number

      Total number of rules executed for this query.

    • rulesSkipped: number

      Number of rules skipped for this query.

  • warnings: {
        code: number;
        message: string;
    }[]

    Warnings encountered while planning the query execution.

Settings

Theme

Generated using TypeDoc