mysql2 2.2.2 → 2.3.0

package/typings/mysql/lib/Pool.d.ts

@@ -0,0 +1,65 @@
+
+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?: true;
+
+        /**
+         * 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, 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;
+}
+
+export = Pool;

package/typings/mysql/lib/PoolCluster.d.ts

@@ -0,0 +1,56 @@
+
+import Connection = require('./Connection');
+import PoolConnection = require('./PoolConnection');
+import {EventEmitter} from 'events';
+
+declare namespace PoolCluster {
+
+    export interface PoolClusterOptions {
+        /**
+         * If true, PoolCluster will attempt to reconnect when connection fails. (Default: true)
+         */
+        canRetry?: boolean;
+
+        /**
+         * If connection fails, node's errorCount increases. When errorCount is greater than removeNodeErrorCount,
+         * remove a node in the PoolCluster. (Default: 5)
+         */
+        removeNodeErrorCount?: number;
+
+        /**
+         * If connection fails, specifies the number of milliseconds before another connection attempt will be made.
+         * If set to 0, then node will be removed instead and never re-used. (Default: 0)
+         */
+        restoreNodeTimeout?: number;
+
+        /**
+         * The default selector. (Default: RR)
+         * RR: Select one alternately. (Round-Robin)
+         * RANDOM: Select the node by random function.
+         * ORDER: Select the first node available unconditionally.
+         */
+        defaultSelector?: string;
+    }
+}
+
+declare class PoolCluster extends EventEmitter {
+
+    config: PoolCluster.PoolClusterOptions;
+
+    add(config: PoolCluster.PoolClusterOptions): void;
+    add(group: string, config: PoolCluster.PoolClusterOptions): void;
+
+    end(): void;
+
+    getConnection(callback: (err: NodeJS.ErrnoException | null, connection: PoolConnection) => void): void;
+    getConnection(group: string, callback: (err: NodeJS.ErrnoException | null, connection: PoolConnection) => void): void;
+    getConnection(group: string, selector: string, callback: (err: NodeJS.ErrnoException | null, connection: PoolConnection) => void): void;
+
+    of(pattern: string, selector?: string): PoolCluster;
+
+    on(event: string, listener: Function): this;
+    on(event: 'remove', listener: (nodeId: number) => void): this;
+    on(event: 'connection', listener: (connection: PoolConnection) => void): this;
+}
+
+export = PoolCluster;

package/typings/mysql/lib/PoolConnection.d.ts

@@ -0,0 +1,8 @@
+
+import Connection = require('./Connection');
+
+declare class PoolConnection extends Connection {
+    release(): void;
+}
+
+export = PoolConnection;

package/typings/mysql/lib/protocol/packets/Field.d.ts

@@ -0,0 +1,16 @@
+
+declare interface Field {
+    constructor: {
+        name: 'Field'
+    };
+    db: string;
+    table: string;
+    name: string;
+    type: string;
+    length: number;
+    string: Function;
+    buffer: Function;
+    geometry: Function;
+}
+
+export = Field;

package/typings/mysql/lib/protocol/packets/FieldPacket.d.ts

@@ -0,0 +1,22 @@
+
+declare interface FieldPacket {
+    constructor: {
+        name: 'FieldPacket'
+    };
+    catalog: string;
+    charsetNr: number;
+    db: string;
+    decimals: number;
+    default: any;
+    flags: number;
+    length: number;
+    name: string;
+    orgName: string;
+    orgTable: string;
+    protocol41: boolean;
+    table: string;
+    type: number;
+    zerofill: boolean;
+}
+
+export = FieldPacket;

package/typings/mysql/lib/protocol/packets/OkPacket.d.ts

@@ -0,0 +1,16 @@
+
+declare interface OkPacket {
+    constructor: {
+        name: 'OkPacket'
+    };
+    fieldCount: number;
+    affectedRows: number;
+    changedRows: number;
+    insertId: number;
+    serverStatus: number;
+    warningCount: number;
+    message: string;
+    procotol41: boolean;
+}
+
+export = OkPacket;

package/typings/mysql/lib/protocol/packets/ResultSetHeader.d.ts

@@ -0,0 +1,14 @@
+
+declare interface ResultSetHeader {
+    constructor: {
+        name: 'ResultSetHeader'
+    };
+    affectedRows: number;
+    fieldCount: number;
+    info: string;
+    insertId: number;
+    serverStatus: number;
+    warningStatus: number;
+}
+
+export = ResultSetHeader;

package/typings/mysql/lib/protocol/packets/RowDataPacket.d.ts

@@ -0,0 +1,10 @@
+
+declare interface RowDataPacket {
+    constructor: {
+        name: 'RowDataPacket'
+    };
+    [column: string]: any;
+    [column: number]: any;
+}
+
+export = RowDataPacket;

package/typings/mysql/lib/protocol/packets/index.d.ts

@@ -0,0 +1,14 @@
+
+import OkPacket = require('./OkPacket');
+import RowDataPacket = require('./RowDataPacket');
+import FieldPacket = require('./FieldPacket');
+import Field = require('./Field');
+import ResultSetHeader = require('./ResultSetHeader');
+
+export {
+    OkPacket,
+    RowDataPacket,
+    FieldPacket,
+    Field,
+    ResultSetHeader
+};

package/typings/mysql/lib/protocol/sequences/Query.d.ts

@@ -0,0 +1,138 @@
+
+import Sequence = require('./Sequence');
+import {OkPacket, RowDataPacket, FieldPacket} from '../packets/index';
+import {Readable} from 'stream';
+
+declare namespace Query {
+
+    export interface QueryOptions {
+        /**
+         * The SQL for the query
+         */
+        sql: string;
+
+        /**
+         * The values for the query
+         */
+        values?: any | any[] | { [param: string]: any };
+
+        /**
+         * Every operation takes an optional inactivity timeout option. This allows you to specify appropriate timeouts for
+         * operations. It is important to note that these timeouts are not part of the MySQL protocol, and rather timeout
+         * operations through the client. This means that when a timeout is reached, the connection it occurred on will be
+         * destroyed and no further operations can be performed.
+         */
+        timeout?: number;
+
+        /**
+         * Either a boolean or string. If true, tables will be nested objects. If string (e.g. '_'), tables will be
+         * nested as tableName_fieldName
+         */
+        nestTables?: any;
+
+        /**
+         * Determines if column values should be converted to native JavaScript types. It is not recommended (and may go away / change in the future)
+         * to disable type casting, but you can currently do so on either the connection or query level. (Default: true)
+         *
+         * You can also specify a function (field: any, next: () => void) => {} to do the type casting yourself.
+         *
+         * WARNING: YOU MUST INVOKE the parser using one of these three field functions in your custom typeCast callback. They can only be called once.
+         *
+         * field.string()
+         * field.buffer()
+         * field.geometry()
+         *
+         * are aliases for
+         *
+         * parser.parseLengthCodedString()
+         * parser.parseLengthCodedBuffer()
+         * parser.parseGeometryValue()
+         *
+         * You can find which field function you need to use by looking at: RowDataPacket.prototype._typeCast
+         */
+        typeCast?: any;
+
+        /**
+         * This overrides the same option set at the connection level.
+         * 
+         */
+        rowsAsArray?: boolean
+    }
+
+    export interface StreamOptions {
+        /**
+         * Sets the max buffer size in objects of a stream
+         */
+        highWaterMark?: number;
+
+        /**
+         * The object mode of the stream (Default: true)
+         */
+        objectMode?: any;
+    }
+
+    export interface QueryError extends NodeJS.ErrnoException {
+        /**
+         * Either a MySQL server error (e.g. 'ER_ACCESS_DENIED_ERROR'),
+         * a node.js error (e.g. 'ECONNREFUSED') or an internal error
+         * (e.g. 'PROTOCOL_CONNECTION_LOST').
+         */
+        code: string;
+
+        /**
+         * The sql state marker
+         */
+        sqlStateMarker?: string;
+
+        /**
+         * The sql state
+         */
+        sqlState?: string;
+
+        /**
+         * The field count
+         */
+        fieldCount?: number;
+
+        /**
+         * Boolean, indicating if this error is terminal to the connection object.
+         */
+        fatal: boolean;
+    }
+}
+
+declare class Query extends Sequence {
+
+    /**
+     * The SQL for a constructed query
+     */
+    sql: string;
+
+    /**
+     * Emits a query packet to start the query
+     */
+    start(): void;
+
+    /**
+     * Determines the packet class to use given the first byte of the packet.
+     *
+     * @param firstByte The first byte of the packet
+     * @param parser The packet parser
+     */
+    determinePacket(firstByte: number, parser: any): any;
+
+    /**
+     * Creates a Readable stream with the given options
+     *
+     * @param options The options for the stream.
+     */
+    stream(options: Query.StreamOptions): Readable;
+
+    on(event: string, listener: Function): this;
+    on(event: 'error', listener: (err: Query.QueryError) => any): this;
+    on(event: 'fields', listener: (fields: FieldPacket, index: number) => any): this;
+    on(event: 'result', listener: (result: RowDataPacket | OkPacket, index: number) => any): this;
+    on(event: 'end', listener: () => any): this;
+}
+
+export = Query;

package/typings/mysql/lib/protocol/sequences/Sequence.d.ts

@@ -0,0 +1,5 @@
+
+import {EventEmitter} from 'events';
+
+declare class Sequence extends EventEmitter { }
+export = Sequence;