sql-switch - v1.0.1
    Preparing search index...

    Interface EngineSwapOptions

    Options for engineSwap. Everything except direction has a default.

    interface EngineSwapOptions {
        direction: SwapDirection;
        connectionString?: string;
        dataDir?: string;
        keepLocalFiles?: boolean;
        onConflict?: ConflictHandler;
        onProgress?: (message: string) => void;
    }

    Hierarchy (View Summary)

    Index
    direction connectionString? dataDir? keepLocalFiles? onConflict? onProgress?
    direction: SwapDirection

    'up' = SQLite to Postgres, 'down' = Postgres to SQLite.

    connectionString?: string

    Postgres connection string.

    process.env.DATABASE_URL

    dataDir?: string

    Directory holding the SQLite .db files. Created if missing.

    './data/databases'

    keepLocalFiles?: boolean

    Upward only: keep the local .db files after a successful migration.

    false (files are deleted, same as the CLI without --keep)

    onConflict?: ConflictHandler

    How to handle a target that already has data in it.

    'skip' => nothing gets clobbered unless you say so

    onProgress?: (message: string) => void

    Called with human readable progress lines. Handy for piping into your own logger.

    Settings
    Member Visibility

    On This Page
    Properties