Type alias QueryDescription

QueryDescription: {
    bindVars: Record<string, any>;
    database: string;
    exitCode?: number;
    id: string;
    modificationQuery: boolean;
    peakMemoryUsage: number;
    query: string;
    runTime: number;
    started: string;
    state: "executing" | "finished" | "killed";
    stream: boolean;
    user: string;
}

Object describing a query.

Type declaration

  • bindVars: Record<string, any>

    Bind parameters used in the query.

  • database: string

    Name of the database the query runs in.

  • Optional exitCode?: number

    An error code (errorNum) that indicates why the query failed, or 0 on success. Only present in slow queries (finished queries), not in running queries.

  • id: string

    Unique identifier for this query.

  • modificationQuery: boolean

    Whether the query writes data (true) or only reads (false).

  • peakMemoryUsage: number

    Maximum memory usage in bytes of the query.

  • query: string

    Query string (potentially truncated).

  • runTime: number

    Query's running time in seconds.

  • started: string

    Date and time the query was started.

  • state: "executing" | "finished" | "killed"

    Query's current execution state.

  • stream: boolean

    Whether the query uses a streaming cursor.

  • user: string

    Name of the user that started the query.

Settings

Theme