Interface RenderResult

Result returned by RenderPipeline.Run.

interface RenderResult {
    AppliedParameters: Record<string, string>;
    ContextValues: Record<string, string>;
    CTEs: CompositionCTEInfo[];
    FinalSQL: string;
    HasCompositions: boolean;
    PagingResult: PagingWrappedSQL | null;
    RowCap: RowCapOutcome | null;
    Trace: RenderTrace;
}

Properties

AppliedParameters: Record<string, string>

Parameters that were applied during template processing

ContextValues: Record<string, string>

The Context members the template read, with their values. Empty when it read none. A cached result depends on exactly these.

Metadata about each CTE generated during composition

FinalSQL: string

The final SQL ready for execution

HasCompositions: boolean

Whether composition tokens were found and resolved

PagingResult: PagingWrappedSQL | null

Paging result (if paging was applied)

RowCap: RowCapOutcome | null

Whether the RenderContext.MaxRows cap holds for FinalSQL, and how it was applied; null when no MaxRows cap was requested.

Pipeline trace for error diagnosis