@photostructure/sqlite
    Preparing search index...

    Interface CreateModuleOptions

    Configuration for DatabaseSync.createModule(), which registers a SQLite virtual table module whose rows come from JavaScript.

    interface CreateModuleOptions {
        columns: readonly VirtualTableColumn[];
        directOnly?: boolean;
        rows: (
            ...parameters: any[],
        ) =>
            | Iterable<ArrayLike<unknown>, any, any>
            | Iterator<ArrayLike<unknown>, any, any>;
        useBigIntArguments?: boolean;
    }
    Index
    columns directOnly? rows useBigIntArguments?
    columns: readonly VirtualTableColumn[]

    The table's columns, in order. Must not be empty.

    directOnly?: boolean

    If true, the table can only be used in top-level SQL statements, not in triggers or views.

    false
    rows: (
        ...parameters: any[],
    ) =>
        | Iterable<ArrayLike<unknown>, any, any>
        | Iterator<ArrayLike<unknown>, any, any>

    Called each time SQLite scans the table. Receives one argument per hidden column, in the order the columns are defined, with null for any the query did not constrain. Returns an iterable or an iterator, such as an array or a generator, of rows. Each row is an array of the visible columns' values, in order.

    When SQLite stops reading early, for example for LIMIT, the iterator's return() method is called, so a generator's finally block runs.

    useBigIntArguments?: boolean

    If true, integer parameters are passed to rows as BigInts.

    false

    Settings
    Member Visibility

    On This Page
    Properties