mysql2 3.4.0 → 3.4.2

package/index.d.ts

@@ -1,225 +1 @@
-import * as mysql from './typings/mysql/index.js';
-import {
-  Connection as PromiseConnection,
-  Pool as PromisePool,
-  PoolConnection as PromisePoolConnection,
-} from './promise.js';
-
 export * from './typings/mysql/index.js';
-
-export interface Connection extends mysql.Connection {
-  execute<
-    T extends
-      | mysql.RowDataPacket[][]
-      | mysql.RowDataPacket[]
-      | mysql.OkPacket
-      | mysql.OkPacket[]
-      | mysql.ResultSetHeader
-  >(
-    sql: string,
-    callback?: (
-      err: mysql.QueryError | null,
-      result: T,
-      fields: mysql.FieldPacket[]
-    ) => any
-  ): mysql.Query;
-  execute<
-    T extends
-      | mysql.RowDataPacket[][]
-      | mysql.RowDataPacket[]
-      | mysql.OkPacket
-      | mysql.OkPacket[]
-      | mysql.ResultSetHeader
-  >(
-    sql: string,
-    values: any | any[] | { [param: string]: any },
-    callback?: (
-      err: mysql.QueryError | null,
-      result: T,
-      fields: mysql.FieldPacket[]
-    ) => any
-  ): mysql.Query;
-  execute<
-    T extends
-      | mysql.RowDataPacket[][]
-      | mysql.RowDataPacket[]
-      | mysql.OkPacket
-      | mysql.OkPacket[]
-      | mysql.ResultSetHeader
-  >(
-    options: mysql.QueryOptions,
-    callback?: (
-      err: mysql.QueryError | null,
-      result: T,
-      fields?: mysql.FieldPacket[]
-    ) => any
-  ): mysql.Query;
-  execute<
-    T extends
-      | mysql.RowDataPacket[][]
-      | mysql.RowDataPacket[]
-      | mysql.OkPacket
-      | mysql.OkPacket[]
-      | mysql.ResultSetHeader
-  >(
-    options: mysql.QueryOptions,
-    values: any | any[] | { [param: string]: any },
-    callback?: (
-      err: mysql.QueryError | null,
-      result: T,
-      fields: mysql.FieldPacket[]
-    ) => any
-  ): mysql.Query;
-  ping(callback?: (err: mysql.QueryError | null) => any): void;
-  unprepare(sql: string): mysql.PrepareStatementInfo;
-  prepare(
-    sql: string,
-    callback?: (
-      err: mysql.QueryError | null,
-      statement: mysql.PrepareStatementInfo
-    ) => any
-  ): mysql.Prepare;
-  serverHandshake(args: any): any;
-  writeOk(args?: mysql.OkPacketParams): void;
-  writeError(args?: mysql.ErrorPacketParams): void;
-  writeEof(warnings?: number, statusFlags?: number): void;
-  writeTextResult(rows?: Array<any>, columns?: Array<any>): void;
-  writePacket(packet: any): void;
-  promise(promiseImpl?: PromiseConstructor): PromiseConnection;
-  sequenceId: number;
-}
-
-export interface PoolConnection extends mysql.PoolConnection {
-  promise(promiseImpl?: PromiseConstructor): PromisePool;
-}
-
-export interface Pool extends mysql.Connection {
-  execute<
-    T extends
-      | mysql.RowDataPacket[][]
-      | mysql.RowDataPacket[]
-      | mysql.OkPacket
-      | mysql.OkPacket[]
-      | mysql.ResultSetHeader
-  >(
-    sql: string,
-    callback?: (
-      err: mysql.QueryError | null,
-      result: T,
-      fields: mysql.FieldPacket[]
-    ) => any
-  ): mysql.Query;
-  execute<
-    T extends
-      | mysql.RowDataPacket[][]
-      | mysql.RowDataPacket[]
-      | mysql.OkPacket
-      | mysql.OkPacket[]
-      | mysql.ResultSetHeader
-  >(
-    sql: string,
-    values: any | any[] | { [param: string]: any },
-    callback?: (
-      err: mysql.QueryError | null,
-      result: T,
-      fields: mysql.FieldPacket[]
-    ) => any
-  ): mysql.Query;
-  execute<
-    T extends
-      | mysql.RowDataPacket[][]
-      | mysql.RowDataPacket[]
-      | mysql.OkPacket
-      | mysql.OkPacket[]
-      | mysql.ResultSetHeader
-  >(
-    options: mysql.QueryOptions,
-    callback?: (
-      err: mysql.QueryError | null,
-      result: T,
-      fields?: mysql.FieldPacket[]
-    ) => any
-  ): mysql.Query;
-  execute<
-    T extends
-      | mysql.RowDataPacket[][]
-      | mysql.RowDataPacket[]
-      | mysql.OkPacket
-      | mysql.OkPacket[]
-      | mysql.ResultSetHeader
-  >(
-    options: mysql.QueryOptions,
-    values: any | any[] | { [param: string]: any },
-    callback?: (
-      err: mysql.QueryError | null,
-      result: T,
-      fields: mysql.FieldPacket[]
-    ) => any
-  ): mysql.Query;
-  getConnection(
-    callback: (err: NodeJS.ErrnoException, connection: PoolConnection) => any
-  ): void;
-  releaseConnection(connection: PoolConnection | PromisePoolConnection): void;
-  on(event: string, listener: (args: any[]) => void): this;
-  on(event: 'connection', listener: (connection: PoolConnection) => any): this;
-  on(event: 'acquire', listener: (connection: PoolConnection) => any): this;
-  on(event: 'release', listener: (connection: PoolConnection) => any): this;
-  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): PromisePool;
-  config: mysql.PoolOptions;
-}
-
-export interface ConnectionOptions extends mysql.ConnectionOptions {
-  charsetNumber?: number;
-  compress?: boolean;
-  authSwitchHandler?: (data: any, callback: () => void) => any;
-  connectAttributes?: { [param: string]: any };
-  decimalNumbers?: boolean;
-  isServer?: boolean;
-  maxPreparedStatements?: number;
-  namedPlaceholders?: boolean;
-  nestTables?: boolean | string;
-  passwordSha1?: string;
-  pool?: any;
-  rowsAsArray?: boolean;
-  stream?: any;
-  uri?: string;
-  connectionLimit?: number;
-  maxIdle?: number;
-  idleTimeout?: number;
-  Promise?: any;
-  queueLimit?: number;
-  waitForConnections?: boolean;
-  authPlugins?: {
-    [key: string]: mysql.AuthPlugin;
-  };
-}
-
-export interface ConnectionConfig extends ConnectionOptions {
-  mergeFlags(defaultFlags: string[], userFlags: string[] | string): number;
-  getDefaultFlags(options?: ConnectionOptions): string[];
-  getCharsetNumber(charset: string): number;
-  getSSLProfile(name: string): { ca: string[] };
-  parseUrl(url: string): {
-    host: string;
-    port: number;
-    database: string;
-    user: string;
-    password: string;
-    [key: string]: any;
-  };
-}
-
-export interface PoolOptions extends mysql.PoolOptions, ConnectionOptions {}
-
-export function createConnection(connectionUri: string): Connection;
-export function createConnection(config: ConnectionOptions): Connection;
-export function createPool(config: PoolOptions): Pool;

package/package.json

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

package/promise.d.ts

@@ -8,15 +8,23 @@ import {
   QueryOptions,
   ConnectionOptions,
   PoolOptions,
+  PoolClusterOptions,
   Pool as CorePool,
 } from './index.js';
+import { ExecutableBase as ExecutableBaseClass } from './typings/mysql/lib/protocol/sequences/promise/ExecutableBase.js';
+import { QueryableBase as QueryableBaseClass } from './typings/mysql/lib/protocol/sequences/promise/QueryableBase.js';
 
 export * from './index.js';
 
+// Expose class interfaces
+declare class QueryableAndExecutableBase extends QueryableBaseClass(
+  ExecutableBaseClass(EventEmitter)
+) {}
+
 export interface PreparedStatementInfo {
   close(): Promise<void>;
   execute(
-    parameters: any[]
+    paramaters: any | any[] | { [param: string]: any }
   ): Promise<
     [
       (
@@ -31,93 +39,7 @@ export interface PreparedStatementInfo {
   >;
 }
 
-export interface Connection extends EventEmitter {
-  query<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    sql: string
-  ): Promise<[T, FieldPacket[]]>;
-  query<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    sql: string,
-    values: any | any[] | { [param: string]: any }
-  ): Promise<[T, FieldPacket[]]>;
-  query<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    options: QueryOptions
-  ): Promise<[T, FieldPacket[]]>;
-  query<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    options: QueryOptions,
-    values: any | any[] | { [param: string]: any }
-  ): Promise<[T, FieldPacket[]]>;
-
-  execute<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    sql: string
-  ): Promise<[T, FieldPacket[]]>;
-  execute<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    sql: string,
-    values: any | any[] | { [param: string]: any }
-  ): Promise<[T, FieldPacket[]]>;
-  execute<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    options: QueryOptions
-  ): Promise<[T, FieldPacket[]]>;
-  execute<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    options: QueryOptions,
-    values: any | any[] | { [param: string]: any }
-  ): Promise<[T, FieldPacket[]]>;
-
+export interface Connection extends QueryableAndExecutableBase {
   config: ConnectionOptions;
 
   threadId: number;
@@ -159,93 +81,7 @@ export interface PoolConnection extends Connection {
   connection: Connection;
 }
 
-export interface Pool extends EventEmitter, Connection {
-  query<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    sql: string
-  ): Promise<[T, FieldPacket[]]>;
-  query<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    sql: string,
-    values: any | any[] | { [param: string]: any }
-  ): Promise<[T, FieldPacket[]]>;
-  query<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    options: QueryOptions
-  ): Promise<[T, FieldPacket[]]>;
-  query<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    options: QueryOptions,
-    values: any | any[] | { [param: string]: any }
-  ): Promise<[T, FieldPacket[]]>;
-
-  execute<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    sql: string
-  ): Promise<[T, FieldPacket[]]>;
-  execute<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    sql: string,
-    values: any | any[] | { [param: string]: any }
-  ): Promise<[T, FieldPacket[]]>;
-  execute<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    options: QueryOptions
-  ): Promise<[T, FieldPacket[]]>;
-  execute<
-    T extends
-      | RowDataPacket[][]
-      | RowDataPacket[]
-      | OkPacket
-      | OkPacket[]
-      | ResultSetHeader
-  >(
-    options: QueryOptions,
-    values: any | any[] | { [param: string]: any }
-  ): Promise<[T, FieldPacket[]]>;
-
+export interface Pool extends Connection {
   getConnection(): Promise<PoolConnection>;
 
   releaseConnection(connection: PoolConnection): void;
@@ -257,14 +93,31 @@ export interface Pool extends EventEmitter, Connection {
 
   end(): Promise<void>;
 
-  escape(value: any): string;
+  pool: CorePool;
+}
 
-  escapeId(value: string): string;
-  escapeId(values: string[]): string;
+export interface PoolNamespace extends QueryableAndExecutableBase {
+  getConnection(): Promise<PoolConnection>;
+}
 
-  format(sql: string, values?: any | any[] | { [param: string]: any }): string;
+export interface PoolCluster extends EventEmitter {
+  config: PoolClusterOptions;
 
-  pool: CorePool;
+  add(config: PoolOptions): void;
+  add(group: string, connectionUri: string): void;
+  add(group: string, config: PoolOptions): void;
+
+  end(): Promise<void>;
+
+  getConnection(): Promise<PoolConnection>;
+  getConnection(group: string): Promise<PoolConnection>;
+  getConnection(group: string, selector: string): Promise<PoolConnection>;
+
+  of(pattern: string, selector?: string): PoolNamespace;
+
+  on(event: string, listener: (args: any[]) => void): this;
+  on(event: 'remove', listener: (nodeId: number) => void): this;
+  on(event: 'connection', listener: (connection: PoolConnection) => void): this;
 }
 
 export function createConnection(connectionUri: string): Promise<Connection>;
@@ -274,3 +127,5 @@ export function createConnection(
 
 export function createPool(connectionUri: string): Pool;
 export function createPool(config: PoolOptions): Pool;
+
+export function createPoolCluster(config?: PoolClusterOptions): PoolCluster;

package/promise.js

@@ -2,6 +2,7 @@
 
 const core = require('./index.js');
 const EventEmitter = require('events').EventEmitter;
+const parserCache = require('./lib/parsers/parser_cache.js');
 
 function makeDoneCb(resolve, reject, localErr) {
   return function (err, rows, fields) {
@@ -563,3 +564,21 @@ exports.raw = core.raw;
 exports.PromisePool = PromisePool;
 exports.PromiseConnection = PromiseConnection;
 exports.PromisePoolConnection = PromisePoolConnection;
+
+exports.__defineGetter__('Types', () => require('./lib/constants/types.js'));
+
+exports.__defineGetter__('Charsets', () =>
+  require('./lib/constants/charsets.js')
+);
+
+exports.__defineGetter__('CharsetToEncoding', () =>
+  require('./lib/constants/charset_encodings.js')
+);
+
+exports.setMaxParserCache = function(max) {
+  parserCache.setMaxCache(max);
+};
+
+exports.clearParserCache = function() {
+  parserCache.clearCache();
+};

package/typings/mysql/index.d.ts

@@ -1,4 +1,3 @@
-import { RsaPublicKey, RsaPrivateKey, KeyLike } from 'crypto';
 import { Pool as BasePool, PoolOptions } from './lib/Pool.js';
 import {
   Connection as BaseConnection,
@@ -13,6 +12,7 @@ import {
 import {
   PoolCluster as BasePoolCluster,
   PoolClusterOptions,
+  PoolNamespace,
 } from './lib/PoolCluster.js';
 import { PoolConnection as BasePoolConnection } from './lib/PoolConnection.js';
 import {
@@ -20,61 +20,35 @@ import {
   PrepareStatementInfo,
 } from './lib/protocol/sequences/Prepare.js';
 import { Server } from './lib/Server.js';
-import { Connection as PromiseConnection } from '../../promise.js';
 
 export {
   ConnectionOptions,
   SslOptions,
   PoolOptions,
   PoolClusterOptions,
+  PoolNamespace,
   QueryOptions,
   QueryError,
   PrepareStatementInfo,
 };
 
 export * from './lib/protocol/packets/index.js';
+export * from './lib/Auth.js';
+export * from './lib/constants/index.js';
+export * from './lib/parsers/index.js';
 
 // Expose class interfaces
-export interface Connection extends BaseConnection {
-  promise(promiseImpl?: PromiseConstructor): PromiseConnection;
-}
+export interface Connection extends BaseConnection {}
 export interface Pool extends BasePool {}
 export interface PoolConnection extends BasePoolConnection {}
 export interface PoolCluster extends BasePoolCluster {}
 export interface Query extends BaseQuery {}
 export interface Prepare extends BasePrepare {}
 
-export type AuthPlugin = (pluginMetadata: {
-  connection: Connection;
-  command: string;
-}) => (
-  pluginData: Buffer
-) => Promise<string> | string | Buffer | Promise<Buffer> | null;
-
-type AuthPluginDefinition<T> = (pluginOptions?: T) => AuthPlugin;
-
-export const authPlugins: {
-  caching_sha2_password: AuthPluginDefinition<{
-    overrideIsSecure?: boolean;
-    serverPublicKey?: RsaPublicKey | RsaPrivateKey | KeyLike;
-    jonServerPublicKey?: (data: Buffer) => void;
-  }>;
-  mysql_clear_password: AuthPluginDefinition<{
-    password?: string;
-  }>;
-  mysql_native_password: AuthPluginDefinition<{
-    password?: string;
-    passwordSha1?: string;
-  }>;
-  sha256_password: AuthPluginDefinition<{
-    serverPublicKey?: RsaPublicKey | RsaPrivateKey | KeyLike;
-    joinServerPublicKey?: (data: Buffer) => void;
-  }>;
-};
-
-export function createConnection(connectionUri: string): Connection;
-export function createConnection(config: ConnectionOptions): Connection;
+export function createConnection(connectionUri: string): BaseConnection;
+export function createConnection(config: ConnectionOptions): BaseConnection;
 
+export function createPool(connectionUri: string): BasePool;
 export function createPool(config: PoolOptions): BasePool;
 
 export function createPoolCluster(config?: PoolClusterOptions): PoolCluster;
@@ -102,4 +76,19 @@ export function raw(sql: string): {
   toSqlString: () => string;
 };
 
+export interface ConnectionConfig extends ConnectionOptions {
+  mergeFlags(defaultFlags: string[], userFlags: string[] | string): number;
+  getDefaultFlags(options?: ConnectionOptions): string[];
+  getCharsetNumber(charset: string): number;
+  getSSLProfile(name: string): { ca: string[] };
+  parseUrl(url: string): {
+    host: string;
+    port: number;
+    database: string;
+    user: string;
+    password: string;
+    [key: string]: any;
+  };
+}
+
 export function createServer(handler: (conn: BaseConnection) => any): Server;

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

@@ -0,0 +1,30 @@
+import { RsaPublicKey, RsaPrivateKey, KeyLike } from 'crypto';
+import { Connection } from './Connection.js';
+
+export type AuthPlugin = (pluginMetadata: {
+  connection: Connection;
+  command: string;
+}) => (
+  pluginData: Buffer
+) => Promise<string> | string | Buffer | Promise<Buffer> | null;
+
+type AuthPluginDefinition<T> = (pluginOptions?: T) => AuthPlugin;
+
+export const authPlugins: {
+  caching_sha2_password: AuthPluginDefinition<{
+    overrideIsSecure?: boolean;
+    serverPublicKey?: RsaPublicKey | RsaPrivateKey | KeyLike;
+    jonServerPublicKey?: (data: Buffer) => void;
+  }>;
+  mysql_clear_password: AuthPluginDefinition<{
+    password?: string;
+  }>;
+  mysql_native_password: AuthPluginDefinition<{
+    password?: string;
+    passwordSha1?: string;
+  }>;
+  sha256_password: AuthPluginDefinition<{
+    serverPublicKey?: RsaPublicKey | RsaPrivateKey | KeyLike;
+    joinServerPublicKey?: (data: Buffer) => void;
+  }>;
+};