///
import * as sqlite3 from 'sqlite3';
import { ISqlite, IMigrate } from './interfaces';
import { Statement } from './Statement';
import MigrationParams = IMigrate.MigrationParams;
/**
* Promisified wrapper for the sqlite3#Database interface.
*/
export declare class Database {
config: ISqlite.Config;
db: Driver;
constructor(config: ISqlite.Config);
/**
* Event handler when verbose mode is enabled.
* @see https://github.com/mapbox/node-sqlite3/wiki/Debugging
*/
on(event: string, listener: any): void;
/**
* Returns the underlying sqlite3 Database instance
*/
getDatabaseInstance(): Driver;
/**
* Opens the database
*/
open(): Promise;
/**
* Closes the database.
*/
close(): Promise;
/**
* @see https://github.com/mapbox/node-sqlite3/wiki/API#databaseconfigureoption-value
*/
configure(option: ISqlite.ConfigureOption, value: any): any;
/**
* Runs the SQL query with the specified parameters. It does not retrieve any result data.
* The function returns the Database object for which it was called to allow for function chaining.
*
* @param {string} sql The SQL query to run.
*
* @param {any} [params, ...] When the SQL statement contains placeholders, you
* can pass them in here. They will be bound to the statement before it is
* executed. There are three ways of passing bind parameters: directly in
* the function's arguments, as an array, and as an object for named
* parameters. This automatically sanitizes inputs.
*
* @see https://github.com/mapbox/node-sqlite3/wiki/API#databaserunsql-param--callback
*/
run(sql: ISqlite.SqlType, ...params: any[]): Promise>;
/**
* Runs the SQL query with the specified parameters and resolves with
* with the first result row afterwards. If the result set is empty, returns undefined.
*
* The property names correspond to the column names of the result set.
* It is impossible to access them by column index; the only supported way is by column name.
*
* @param {string} sql The SQL query to run.
*
* @param {any} [params, ...] When the SQL statement contains placeholders, you
* can pass them in here. They will be bound to the statement before it is
* executed. There are three ways of passing bind parameters: directly in
* the function's arguments, as an array, and as an object for named
* parameters. This automatically sanitizes inputs.
*
* @see https://github.com/mapbox/node-sqlite3/wiki/API#databasegetsql-param--callback
*/
get(sql: ISqlite.SqlType, ...params: any[]): Promise;
/**
* Runs the SQL query with the specified parameters and calls the callback once for each result
* row. The parameters are the same as the Database#run function, with the following differences:
*
* If the result set succeeds but is empty, the callback is never called.
* In all other cases, the callback is called once for every retrieved row.
* The order of calls correspond exactly to the order of rows in the result set.
*
* There is currently no way to abort execution!
*
* The last parameter to each() *must* be a callback function.
*
* @example await db.each('SELECT * FROM x WHERE y = ?', 'z', (err, row) => {
* // row contains the row data
* // each() resolves when there are no more rows to fetch
* })
*
* @see https://github.com/mapbox/node-sqlite3/wiki/API#databaseeachsql-param--callback-complete
* @returns Promise Number of rows returned
*/
each(sql: ISqlite.SqlType, callback: (err: any, row: T) => void): Promise;
each(sql: ISqlite.SqlType, param1: any, callback: (err: any, row: T) => void): Promise;
each(sql: ISqlite.SqlType, param1: any, param2: any, callback: (err: any, row: T) => void): Promise;
each(sql: ISqlite.SqlType, param1: any, param2: any, param3: any, callback: (err: any, row: T) => void): Promise;
each(sql: ISqlite.SqlType, ...params: any[]): Promise;
/**
* Runs the SQL query with the specified parameters. The parameters are the same as the
* Database#run function, with the following differences:
*
* If the result set is empty, it will be an empty array, otherwise it will
* have an object for each result row which
* in turn contains the values of that row, like the Database#get function.
*
* Note that it first retrieves all result rows and stores them in memory.
* For queries that have potentially large result sets, use the Database#each
* function to retrieve all rows or Database#prepare followed by multiple
* Statement#get calls to retrieve a previously unknown amount of rows.
*
* @param {string} sql The SQL query to run.
*
* @param {any} [params, ...] When the SQL statement contains placeholders, you
* can pass them in here. They will be bound to the statement before it is
* executed. There are three ways of passing bind parameters: directly in
* the function's arguments, as an array, and as an object for named
* parameters. This automatically sanitizes inputs.
*
* @see https://github.com/mapbox/node-sqlite3/wiki/API#databaseallsql-param--callback
*/
all(sql: ISqlite.SqlType, ...params: any[]): Promise;
/**
* Runs all SQL queries in the supplied string. No result rows are retrieved. If a query fails,
* no subsequent statements will be executed (wrap it in a transaction if you want all
* or none to be executed).
*
* Note: This function will only execute statements up to the first NULL byte.
* Comments are not allowed and will lead to runtime errors.
*
* @param {string} sql The SQL query to run.
* @see https://github.com/mapbox/node-sqlite3/wiki/API#databaseexecsql-callback
*/
exec(sql: ISqlite.SqlType): Promise;
/**
* Prepares the SQL statement and optionally binds the specified parameters.
* When bind parameters are supplied, they are bound to the prepared statement.
*
* @param {string} sql The SQL query to run.
* @param {any} [params, ...] When the SQL statement contains placeholders, you
* can pass them in here. They will be bound to the statement before it is
* executed. There are three ways of passing bind parameters: directly in
* the function's arguments, as an array, and as an object for named
* parameters. This automatically sanitizes inputs.
* @returns Promise Statement object
*/
prepare(sql: ISqlite.SqlType, ...params: any[]): Promise>;
/**
* Loads a compiled SQLite extension into the database connection object.
*
* @param {string} path Filename of the extension to load
*/
loadExtension(path: string): Promise;
/**
* Performs a database migration.
*/
migrate(config?: MigrationParams): Promise;
/**
* The methods underneath requires creative work to implement. PRs / proposals accepted!
*/
serialize(): void;
parallelize(): void;
}