sqlite/build/interfaces.d.ts

/// <reference types="./vendor-typings/sql-template-strings" />
/// <reference types="./vendor-typings/sqlite3" />
import * as sqlite3 from 'sqlite3';
import { SQLStatement } from 'sql-template-strings';
import { Statement } from './Statement';
export declare namespace ISqlite {
    interface SqlObj {
        sql: string;
        params?: any[];
    }
    /**
     * Allows for input of a normal SQL string or
     * `sql-template-strings` object
     */
    type SqlType = SQLStatement | string;
    interface Config {
        /**
         * Valid values are filenames, ":memory:" for an anonymous in-memory
         * database and an empty string for an anonymous disk-based database.
         * Anonymous databases are not persisted and when closing the database
         * handle, their contents are lost.
         */
        filename: string;
        /**
         * One or more of sqlite3.OPEN_READONLY, sqlite3.OPEN_READWRITE and
         * sqlite3.OPEN_CREATE. The default value is OPEN_READWRITE | OPEN_CREATE.
         */
        mode?: number;
        /**
         * The database driver. Most will install `sqlite3` and use the `Database` class from it.
         * As long as the library you are using conforms to the `sqlite3` API, you can use it as
         * the driver.
         *
         * @example
         *
         * ```
         * import sqlite from 'sqlite3'
         *
         * const driver = sqlite.Database
         * ```
         */
        driver: any;
    }
    type ConfigureOption = 'trace' | 'profile' | 'busyTimeout';
    interface RunResult<Stmt extends sqlite3.Statement = sqlite3.Statement> {
        /**
         * Statement object.
         *
         * It is not possible to run the statement again because it is
         * automatically finalized after running for the first time.
         * Any subsequent attempts to run the statement again will fail.
         */
        stmt: Statement<Stmt>;
        /**
         * Row id of the inserted row.
         *
         * Only contains valid information when the query was a successfully
         * completed INSERT statement.
         */
        lastID?: number;
        /**
         * Number of rows changed.
         *
         * Only contains valid information when the query was a
         * successfully completed UPDATE or DELETE statement.
         */
        changes?: number;
    }
}
export declare namespace IMigrate {
    interface MigrationParams {
        /**
         * If true, will force the migration API to rollback and re-apply the latest migration over
         * again each time when Node.js app launches.
         */
        force?: boolean;
        /**
         * Migrations table name. Default is 'migrations'
         */
        table?: string;
        /**
         * Path to the migrations folder. Default is `path.join(process.cwd(), 'migrations')`
         */
        migrationsPath?: string;
        /**
         * Migration data read from migrations folder. `migrationsPath` will be ignored if this is
         * provided.
         */
        migrations?: readonly MigrationData[];
    }
    interface MigrationFile {
        id: number;
        name: string;
        filename: string;
    }
    interface MigrationData {
        id: number;
        name: string;
        up: string;
        down: string;
    }
}