Libraries v5.0.0
    Preparing search index...

    Interface ReadColumn<S, K>

    A typed SQL column; selectors receive descriptions, not row values.

    interface ReadColumn<S extends ReadSchema, K extends string = string> {
        __leftJoined?: boolean;
        __property?: K;
        __readSource?: S;
        __value?: InferType<S>;
        "[COLUMN]": { alias: string; column: string; schema: any };
        "[JSON_PATH]"?: readonly string[];
        "[READ_COLUMN]": ReadNode;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    __leftJoined? __property? __readSource? __value? [COLUMN] [JSON_PATH]? [READ_COLUMN]

    Optional Readonly__leftJoined

    __leftJoined?: boolean

    Type-only join nullability, independent of the stored column schema.

    Optional Readonly__property

    __property?: K

    Type-only property identity for column-list projections.

    Optional Readonly__readSource

    __readSource?: S

    Type-only source schema used by projection metadata.

    Optional Readonly__value

    __value?: InferType<S>

    Type-only marker carrying column nullability and value type; not a runtime row value.

    "[COLUMN]": { alias: string; column: string; schema: any }
    "[JSON_PATH]"?: readonly string[]

    Captured JSON path beneath a storage column.

    "[READ_COLUMN]": ReadNode

    Decoding and projection metadata shared by the query compiler.

    Settings
    Member Visibility

    On This Page
    Properties