Member Junction
    Preparing search index...

    Type Alias RunQueryResult

    Result of executing a saved query. Contains the query results and execution metadata.

    type RunQueryResult = {
        AppliedParameters?: Record<string, any>;
        CacheHit?: boolean;
        CacheKey?: string;
        CacheTTLRemaining?: number;
        ErrorMessage: string;
        ExecutionTime: number;
        PageNumber?: number;
        PageSize?: number;
        QueryID: string;
        QueryName: string;
        RenderedSQL?: string;
        Results: any[];
        RowCount: number;
        Success: boolean;
        TotalRowCount: number;
    }
    Index

    Properties

    AppliedParameters? CacheHit? CacheKey? CacheTTLRemaining? ErrorMessage ExecutionTime PageNumber? PageSize? QueryID QueryName RenderedSQL? Results RowCount Success TotalRowCount

    Properties

    AppliedParameters?: Record<string, any>

    Parameters that were applied to the query, including defaults

    CacheHit?: boolean

    Whether this result was served from cache

    CacheKey?: string

    Cache key used for this query

    CacheTTLRemaining?: number

    Time until cache expiration in milliseconds

    ErrorMessage: string
    ExecutionTime: number
    PageNumber?: number

    The page number returned (1-based). Derived from StartRow and MaxRows. Undefined when paging is not active.

    PageSize?: number

    The page size used for this result. Undefined when paging is not active.

    QueryID: string
    QueryName: string
    RenderedSQL?: string

    The fully rendered SQL that was actually executed against the database. On error, this reveals transformations applied by the render pipeline (composition, Nunjucks templates, MaxRows wrapping, paging) that may have caused the failure — e.g., an ORDER BY moved into a derived table.

    Results: any[]
    RowCount: number
    Success: boolean
    TotalRowCount: number

    Total number of rows that would be returned without pagination. Only differs from RowCount when StartRow or MaxRows are used.

    Settings

    Member Visibility

    On This Page

    Properties