68 lines
3.1 KiB
TypeScript
68 lines
3.1 KiB
TypeScript
|
|
||
|
|
import Query = require('./protocol/sequences/Query');
|
||
|
|
import {OkPacket, RowDataPacket, FieldPacket, ResultSetHeader} from './protocol/packets/index';
|
||
|
|
import Connection = require('./Connection');
|
||
|
|
import PoolConnection = require('./PoolConnection');
|
||
|
|
import {EventEmitter} from 'events';
|
||
|
|
|
||
|
|
declare namespace Pool {
|
||
|
|
|
||
|
|
export interface PoolOptions extends Connection.ConnectionOptions {
|
||
|
|
/**
|
||
|
|
* The milliseconds before a timeout occurs during the connection acquisition. This is slightly different from connectTimeout,
|
||
|
|
* because acquiring a pool connection does not always involve making a connection. (Default: 10 seconds)
|
||
|
|
*/
|
||
|
|
acquireTimeout?: number;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Determines the pool's action when no connections are available and the limit has been reached. If true, the pool will queue
|
||
|
|
* the connection request and call it when one becomes available. If false, the pool will immediately call back with an error.
|
||
|
|
* (Default: true)
|
||
|
|
*/
|
||
|
|
waitForConnections?: boolean;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The maximum number of connections to create at once. (Default: 10)
|
||
|
|
*/
|
||
|
|
connectionLimit?: number;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The maximum number of connection requests the pool will queue before returning an error from getConnection. If set to 0, there
|
||
|
|
* is no limit to the number of queued connection requests. (Default: 0)
|
||
|
|
*/
|
||
|
|
queueLimit?: number;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Enable keep-alive on the socket. It's disabled by default, but the
|
||
|
|
* user can enable it and supply an initial delay.
|
||
|
|
*/
|
||
|
|
enableKeepAlive?: boolean;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* If keep-alive is enabled users can supply an initial delay.
|
||
|
|
*/
|
||
|
|
keepAliveInitialDelay?: number;
|
||
|
|
}
|
||
|
|
}
|
||
|
|
|
||
|
|
declare class Pool extends EventEmitter {
|
||
|
|
|
||
|
|
config: Pool.PoolOptions;
|
||
|
|
|
||
|
|
getConnection(callback: (err: NodeJS.ErrnoException | null, connection: PoolConnection) => any): void;
|
||
|
|
|
||
|
|
query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>(sql: string, callback?: (err: Query.QueryError | null, result: T, fields: FieldPacket[]) => any): Query;
|
||
|
|
query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>(sql: string, values: any | any[] | { [param: string]: any }, callback?: (err: Query.QueryError | null, result: T, fields: FieldPacket[]) => any): Query;
|
||
|
|
query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>(options: Query.QueryOptions, callback?: (err: Query.QueryError | null, result: T, fields?: FieldPacket[]) => any): Query;
|
||
|
|
query<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>(options: Query.QueryOptions, values: any | any[] | { [param: string]: any }, callback?: (err: Query.QueryError | null, result: T, fields: FieldPacket[]) => any): Query;
|
||
|
|
|
||
|
|
end(callback?: (err: NodeJS.ErrnoException | null, ...args: any[]) => any): void;
|
||
|
|
|
||
|
|
on(event: string, listener: Function): this;
|
||
|
|
on(event: 'connection', listener: (connection: PoolConnection) => any): this;
|
||
|
|
|
||
|
|
promise(promiseImpl?: any): any;
|
||
|
|
}
|
||
|
|
|
||
|
|
export = Pool;
|