mysql2 3.3.0 → 3.3.2

package/README.md

@@ -134,7 +134,9 @@ const pool = mysql.createPool({
   connectionLimit: 10,
   maxIdle: 10, // max idle connections, the default value is the same as `connectionLimit`
   idleTimeout: 60000, // idle connections timeout, in milliseconds, the default value 60000
-  queueLimit: 0
+  queueLimit: 0,
+  enableKeepAlive: true,
+  keepAliveInitialDelay: 0
 });
 ```
 The pool does not create all connections upfront but creates them on demand until the connection limit is reached.

package/index.d.ts

@@ -78,6 +78,7 @@ export interface Connection extends mysql.Connection {
   writeEof(warnings?: number, statusFlags?: number): void;
   writeTextResult(rows?: Array<any>, columns?: Array<any>): void;
   writePacket(packet: any): void;
+  promise(promiseImpl?: PromiseConstructor): PromiseConnection;
   sequenceId: number;
 }
 
@@ -157,7 +158,7 @@ export interface Pool extends mysql.Connection {
   on(event: 'enqueue', listener: () => any): this;
   unprepare(sql: string): mysql.PrepareStatementInfo;
   prepare(sql: string, callback?: (err: mysql.QueryError | null, statement: mysql.PrepareStatementInfo) => any): mysql.Prepare;
-
+  promise(promiseImpl?: PromiseConstructor): PromisePoolConnection;
   config: mysql.PoolOptions;
 }
 

package/lib/connection.js

@@ -22,7 +22,7 @@ const EventEmitter = require('events').EventEmitter;
 const Readable = require('stream').Readable;
 const Queue = require('denque');
 const SqlString = require('sqlstring');
-const LRU = require('lru-cache');
+const LRU = require('lru-cache').default;
 
 const PacketParser = require('./packet_parser.js');
 const Packets = require('./packets/index.js');
@@ -52,9 +52,10 @@ class Connection extends EventEmitter {
           opts.config.host
         );
 
-        // Enable keep-alive on the socket.  It's disabled by default, but the
-        // user can enable it and supply an initial delay.
-        this.stream.setKeepAlive(true, this.config.keepAliveInitialDelay);
+        // Optionally enable keep-alive on the socket.
+        if (this.config.enableKeepAlive) {
+          this.stream.setKeepAlive(true, this.config.keepAliveInitialDelay);
+        }
 
         // Enable TCP_NODELAY flag. This is needed so that the network packets
         // are sent immediately to the server

package/lib/connection_config.js

@@ -115,7 +115,7 @@ class ConnectionConfig {
     this.debug = options.debug;
     this.trace = options.trace !== false;
     this.stringifyObjects = options.stringifyObjects || false;
-    this.enableKeepAlive = !!options.enableKeepAlive;
+    this.enableKeepAlive = options.enableKeepAlive !== false;
     this.keepAliveInitialDelay = options.keepAliveInitialDelay || 0;
     if (
       options.timezone &&

package/lib/parsers/parser_cache.js

@@ -1,6 +1,6 @@
 'use strict';
 
-const LRU = require('lru-cache');
+const LRU = require('lru-cache').default;
 
 const parserCache = new LRU({
   max: 15000

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql2",
-  "version": "3.3.0",
+  "version": "3.3.2",
   "description": "fast mysql driver. Implements core protocol, prepared statements, ssl and compression in native JS",
   "main": "index.js",
   "directories": {

package/promise.d.ts

@@ -84,6 +84,7 @@ export interface Connection extends EventEmitter {
 
 export interface PoolConnection extends Connection {
   connection: Connection;
+  getConnection(): Promise<PoolConnection>;
   release(): void;
 }
 
@@ -153,6 +154,3 @@ export interface PreparedStatementInfo {
   execute(parameters: any[]): Promise<[RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader, FieldPacket[]]>;
 }
 
-export interface PromisePoolConnection extends Connection {
-  destroy(): any;
-} 

package/typings/mysql/index.d.ts

@@ -12,7 +12,7 @@ import BasePrepare = require('./lib/protocol/sequences/Prepare');
 import {QueryOptions, StreamOptions, QueryError} from './lib/protocol/sequences/Query';
 import {PrepareStatementInfo} from './lib/protocol/sequences/Prepare';
 import Server = require('./lib/Server');
-import { Pool as PromisePool } from '../../promise';
+import { Pool as PromisePool, Connection as PromiseConnection } from '../../promise';
 
 export function createConnection(connectionUri: string): Connection;
 export function createConnection(config: BaseConnection.ConnectionOptions): Connection;
@@ -41,7 +41,7 @@ export * from './lib/protocol/packets/index';
 
 // Expose class interfaces
 export interface Connection extends BaseConnection {
-  promise(promiseImpl?: PromiseConstructor): PromisePool;
+  promise(promiseImpl?: PromiseConstructor): PromiseConnection;
 }
 export interface PoolConnection extends BasePoolConnection {}
 export interface Pool extends BasePool {}

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

@@ -289,9 +289,11 @@ declare class Connection extends EventEmitter {
 
     rollback(callback: (err: Query.QueryError | null) => void): void;
 
-    execute(sql: string, callback?: (err: any, rows: Array<any>, fields: Array<any>) => any): any;
+    execute<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>(sql: string, callback?: (err: Query.QueryError | null, result: T, fields: FieldPacket[]) => any): Query;
+    execute<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;
+    execute<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>(options: Query.QueryOptions, callback?: (err: Query.QueryError | null, result: T, fields?: FieldPacket[]) => any): Query;
+    execute<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;
 
-    execute(sql: string, values: any | any[] | { [param: string]: any }, callback?: (err: any, rows: Array<any>, fields: Array<any>) => any): any;
 
     unprepare(sql: string): any;
 

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

@@ -4,6 +4,7 @@ import {OkPacket, RowDataPacket, FieldPacket, ResultSetHeader} from './protocol/
 import Connection = require('./Connection');
 import PoolConnection = require('./PoolConnection');
 import {EventEmitter} from 'events';
+import {PoolConnection as PromisePoolConnection} from '../../../promise';
 
 declare namespace Pool {
 
@@ -43,13 +44,12 @@ declare namespace Pool {
         queueLimit?: number;
 
         /**
-         * Enable keep-alive on the socket.  It's disabled by default, but the
-         * user can enable it and supply an initial delay.
+         * Enable keep-alive on the socket. (Default: true)
          */
         enableKeepAlive?: boolean;
 
         /**
-         * If keep-alive is enabled users can supply an initial delay.
+         * If keep-alive is enabled users can supply an initial delay. (Default: 0)
          */
         keepAliveInitialDelay?: number;
     }
@@ -66,12 +66,17 @@ declare class Pool extends EventEmitter {
     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;
 
+    execute<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>(sql: string, callback?: (err: Query.QueryError | null, result: T, fields: FieldPacket[]) => any): Query;
+    execute<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;
+    execute<T extends RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader>(options: Query.QueryOptions, callback?: (err: Query.QueryError | null, result: T, fields?: FieldPacket[]) => any): Query;
+    execute<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;
+    promise(promiseImpl?: PromiseConstructor): PromisePoolConnection;
 }
 
 export = Pool;