@opscogs/octools
    Preparing search index...

    Interface TabularEnvelope

    Columns and rows for results whose shape is only known at run time.

    interface TabularEnvelope {
        column_descriptions?: (string | null)[];
        column_kinds?: (
            | "number"
            | "boolean"
            | "mac"
            | "integer"
            | "text"
            | "timestamp"
            | "ip"
            | "fqdn"
            | "ip_block"
            | "big_integer"
        )[];
        column_scales?: ("linear" | "log10" | "log2" | null)[];
        columns: string[];
        next_cursor?: string;
        resumable?: boolean;
        row_count: number;
        rows: Cell[][];
        source?: SourceRef;
        stop_reason?: string;
        total_count?: string | number;
        truncated: boolean;
        warnings?: string[];
    }

    Hierarchy (View Summary)

    Index
    column_descriptions? column_kinds? column_scales? columns next_cursor? resumable? row_count rows source? stop_reason? total_count? truncated warnings?
    column_descriptions?: (string | null)[]

    One short description per column; null where a column has none.

    column_kinds?: (
        | "number"
        | "boolean"
        | "mac"
        | "integer"
        | "text"
        | "timestamp"
        | "ip"
        | "fqdn"
        | "ip_block"
        | "big_integer"
    )[]

    Per-column kind, one per column.

    column_scales?: ("linear" | "log10" | "log2" | null)[]

    Per-column chart scale hint, one per column; null for no hint.

    columns: string[]

    Column names, in row order.

    next_cursor?: string

    Opaque token that resumes the read; present only when resumable.

    resumable?: boolean

    Whether following next_cursor reads more; present only when truncated.

    row_count: number

    Number of rows returned, after any cap; equals rows.length.

    rows: Cell[][]

    Rows of scalar cells; each row has one cell per column.

    source?: SourceRef

    Which instance and snapshot answered; left out when unset.

    stop_reason?: string

    Why the read stopped early.

    total_count?: string | number

    Exact size of the full result, as an integer or a decimal string.

    truncated: boolean

    True when a cap, a stop or an interrupted read cut the result short.

    warnings?: string[]

    Non-fatal problems the caller should relay; left out when empty.

    Settings
    Member Visibility

    On This Page
    Properties