Member Junction
    Preparing search index...

    Interface RenderContext

    Context passed to RenderPipeline.Run controlling each pipeline stage.

    interface RenderContext {
        ContextUser?: UserInfo;
        Dependencies?: QueryDependencySpec[];
        MaxRows?: number;
        OriginalSQL?: string;
        Paging?: { MaxRows: number; StartRow: number };
        ParameterDefinitions?: MJQueryParameterEntity[];
        Parameters?: Record<string, string>;
        Platform: DatabasePlatform;
        QueryInfo?: QueryTemplateInput;
        RequireReadStatement?: boolean;
        UsesTemplate?: boolean;
    }
    Index

    Properties

    ContextUser? Dependencies? MaxRows? OriginalSQL? Paging? ParameterDefinitions? Parameters? Platform QueryInfo? RequireReadStatement? UsesTemplate?

    Properties

    ContextUser?: UserInfo

    User context for permission checks on referenced queries

    Dependencies?: QueryDependencySpec[]

    Inline dependency specs for transient query testing

    MaxRows?: number

    MaxRows safety limit. Mutually exclusive with Paging.

    OriginalSQL?: string

    Original (pre-composition) SQL — used for template input metadata

    Paging?: { MaxRows: number; StartRow: number }

    Paging parameters (omit to skip paging). Mutually exclusive with MaxRows.

    ParameterDefinitions?: MJQueryParameterEntity[]

    Formal parameter definitions (for validation). Null = skip validation.

    Parameters?: Record<string, string>

    Parameter values from the caller

    Platform: DatabasePlatform

    Target database platform

    QueryInfo?: QueryTemplateInput

    Full query metadata object (saved query path). When provided, passed directly to processQueryTemplate for parameter validation. When omitted, a synthetic QueryTemplateInput is built from OriginalSQL + ParameterDefinitions.

    RequireReadStatement?: boolean

    Require the rendered SQL to be a single read query: one statement that starts with SELECT or WITH, reads in every CTE, and does not SELECT … INTO a table. Set it wherever the caller, not a saved query, supplies the SQL (ad-hoc SQL, transient test queries). Anything else is refused with an error that says why. Saved queries are admin-authored and are not held to it.

    UsesTemplate?: boolean

    Whether the outer query uses Nunjucks templates

    Settings

    Member Visibility

    On This Page

    Properties