Member Junction
    Preparing search index...

    Type Alias RunViewGenericParams

    type RunViewGenericParams = {
        afterKey?: CompositeKey;
        aggregates?: AggregateExpression[];
        alternateBaseView?: string;
        auditLogDescription?: string;
        bypassCache?: boolean;
        dataSource?: "Live" | "Materialized";
        excludeDataFromAllPriorViewRuns?: boolean;
        excludeUserViewRunID?: string;
        extraFilter: string;
        fields?: string[];
        forceAuditLog?: boolean;
        ignoreMaxRows?: boolean;
        includeBinaryFields?: boolean;
        maxRows?: number;
        orderBy: string;
        overrideExcludeFilter?: string;
        properties?: ViewPropertyValues;
        provider: DatabaseProviderBase;
        resultType?: string;
        saveViewResults?: boolean;
        skipTotalRowCount?: boolean;
        startRow?: number;
        userPayload?: UserPayload;
        userSearchString: string;
        viewInfo: MJUserViewEntityExtended;
    }
    Index

    Properties

    afterKey? aggregates? alternateBaseView? auditLogDescription? bypassCache? dataSource? excludeDataFromAllPriorViewRuns? excludeUserViewRunID? extraFilter fields? forceAuditLog? ignoreMaxRows? includeBinaryFields? maxRows? orderBy overrideExcludeFilter? properties? provider resultType? saveViewResults? skipTotalRowCount? startRow? userPayload? userSearchString viewInfo

    Properties

    afterKey?: CompositeKey

    Keyset (seek) pagination cursor — see RunViewParams.AfterKey. When set, the entity must have a single-column PK; throws AfterKeyNotSupportedError otherwise.

    aggregates?: AggregateExpression[]
    alternateBaseView?: string

    Optional registered Alternate Base View logical Name (from EntityAlternateBaseView.Name) for this entity. Propagated to RunViewParams.AlternateBaseView.

    auditLogDescription?: string
    bypassCache?: boolean

    When true, the server-side cache layer is bypassed for this view run — neither the pre-check cache lookup nor the post-query cache write happens. Propagated to RunViewParams.BypassCache.

    dataSource?: "Live" | "Materialized"

    Optional source-of-truth selector for entities that have a base-view materialization. 'Materialized' routes the read to the entity's materialized wrapper view; defaults to 'Live'. Propagated to RunViewParams.DataSource.

    excludeDataFromAllPriorViewRuns?: boolean
    excludeUserViewRunID?: string
    extraFilter: string
    fields?: string[]
    forceAuditLog?: boolean
    ignoreMaxRows?: boolean
    includeBinaryFields?: boolean

    When true, binary fields (varbinary / bytea, as base64 strings) are returned. Propagated to RunViewParams.IncludeBinaryFields.

    maxRows?: number
    orderBy: string
    overrideExcludeFilter?: string
    properties?: ViewPropertyValues

    The client's values for a stored view's properties. Propagated to RunViewParams.Properties. There is deliberately no server-properties field: those are set only by server code.

    provider: DatabaseProviderBase
    resultType?: string
    saveViewResults?: boolean
    skipTotalRowCount?: boolean

    When true, no count runs to populate TotalRowCount, which comes back undefined. Propagated to RunViewParams.SkipTotalRowCount.

    startRow?: number
    userPayload?: UserPayload
    userSearchString: string
    viewInfo: MJUserViewEntityExtended

    Settings

    Member Visibility

    On This Page

    Properties