mysql2 3.4.5 → 3.5.1

package/README.md

@@ -53,6 +53,14 @@ MySQL2 is free from native bindings and can be installed on Linux, Mac OS or Win
 npm install --save mysql2
 ```
 
+If you are using TypeScript, you will need to install `@types/node`.
+
+```bash
+npm install --save-dev @types/node
+```
+
+> For TypeScript documentation and examples, see [here](./documentation/en/TypeScript-Examples.md).
+
 ## First Query
 ```js
 // get the client

package/lib/connection.js

@@ -355,62 +355,43 @@ class Connection extends EventEmitter {
     });
     const rejectUnauthorized = this.config.ssl.rejectUnauthorized;
     const verifyIdentity = this.config.ssl.verifyIdentity;
-    const host = this.config.host;
+    const servername = this.config.host;
 
     let secureEstablished = false;
-    const secureSocket = new Tls.TLSSocket(this.stream, {
-      rejectUnauthorized: rejectUnauthorized,
-      requestCert: true,
-      secureContext: secureContext,
-      isServer: false
+    this.stream.removeAllListeners('data');
+    const secureSocket = Tls.connect({
+      rejectUnauthorized,
+      requestCert: rejectUnauthorized,
+      secureContext,
+      isServer: false,
+      socket: this.stream,
+      servername
+    }, () => {
+      secureEstablished = true;
+      if (rejectUnauthorized) {
+        if (typeof servername === 'string' && verifyIdentity) {
+          const cert = secureSocket.getPeerCertificate(true);
+          const serverIdentityCheckError = Tls.checkServerIdentity(servername, cert);
+          if (serverIdentityCheckError) {
+            onSecure(serverIdentityCheckError);
+            return;
+          }
+        }
+      }
+      onSecure();
     });
-    if (typeof host === 'string') {
-      secureSocket.setServername(host);
-    }
     // error handler for secure socket
-    secureSocket.on('_tlsError', err => {
+    secureSocket.on('error', err => {
       if (secureEstablished) {
         this._handleNetworkError(err);
       } else {
         onSecure(err);
       }
     });
-    secureSocket.on('secure', () => {
-      secureEstablished = true;
-      let callbackValue = null;
-      if (rejectUnauthorized) {
-        callbackValue = secureSocket.ssl.verifyError()
-        if (!callbackValue && typeof host === 'string' && verifyIdentity) {
-          const cert = secureSocket.ssl.getPeerCertificate(true);
-          callbackValue = Tls.checkServerIdentity(host, cert)
-        }
-      }
-      onSecure(callbackValue);
-    });
     secureSocket.on('data', data => {
       this.packetParser.execute(data);
     });
-    this.write = buffer => {
-      secureSocket.write(buffer);
-    };
-    // start TLS communications
-    secureSocket._start();
-  }
-
-  pipe() {
-    if (this.stream instanceof Net.Stream) {
-      this.stream.ondata = (data, start, end) => {
-        this.packetParser.execute(data, start, end);
-      };
-    } else {
-      this.stream.on('data', data => {
-        this.packetParser.execute(
-          data.parent,
-          data.offset,
-          data.offset + data.length
-        );
-      });
-    }
+    this.write = buffer => secureSocket.write(buffer);
   }
 
   protocolError(message, code) {
@@ -948,48 +929,4 @@ class Connection extends EventEmitter {
   }
 }
 
-if (Tls.TLSSocket) {
-  // not supported
-} else {
-  Connection.prototype.startTLS = function _startTLS(onSecure) {
-    if (this.config.debug) {
-      // eslint-disable-next-line no-console
-      console.log('Upgrading connection to TLS');
-    }
-    const crypto = require('crypto');
-    const config = this.config;
-    const stream = this.stream;
-    const rejectUnauthorized = this.config.ssl.rejectUnauthorized;
-    const credentials = crypto.createCredentials({
-      key: config.ssl.key,
-      cert: config.ssl.cert,
-      passphrase: config.ssl.passphrase,
-      ca: config.ssl.ca,
-      ciphers: config.ssl.ciphers
-    });
-    const securePair = Tls.createSecurePair(
-      credentials,
-      false,
-      true,
-      rejectUnauthorized
-    );
-
-    if (stream.ondata) {
-      stream.ondata = null;
-    }
-    stream.removeAllListeners('data');
-    stream.pipe(securePair.encrypted);
-    securePair.encrypted.pipe(stream);
-    securePair.cleartext.on('data', data => {
-      this.packetParser.execute(data);
-    });
-    this.write = function(buffer) {
-      securePair.cleartext.write(buffer);
-    };
-    securePair.on('secure', () => {
-      onSecure(rejectUnauthorized ? securePair.ssl.verifyError() : null);
-    });
-  };
-}
-
 module.exports = Connection;

package/lib/packets/column_definition.js

@@ -66,14 +66,162 @@ class ColumnDefinition {
       table: this.table,
       orgTable: this.orgTable,
       characterSet: this.characterSet,
+      encoding: this.encoding,
       columnLength: this.columnLength,
-      columnType: this.columnType,
       type: this.columnType,
       flags: this.flags,
       decimals: this.decimals
     };
   }
 
+  [Symbol.for('nodejs.util.inspect.custom')](depth, inspectOptions, inspect) {
+    const Types = require('../constants/types.js');
+    const typeNames = [];
+    for (const t in Types) {
+      typeNames[Types[t]] = t;
+    }
+    const fiedFlags = require('../constants/field_flags.js');
+    const flagNames = [];
+    // TODO: respect inspectOptions.showHidden
+    //const inspectFlags = inspectOptions.showHidden ? this.flags : this.flags & ~fiedFlags.PRI_KEY;
+    const inspectFlags = this.flags;
+    for (const f in fiedFlags) {
+      if (inspectFlags & fiedFlags[f]) {
+        if (f === 'PRI_KEY') {
+          flagNames.push('PRIMARY KEY');
+        } else if (f === 'NOT_NULL') {
+          flagNames.push('NOT NULL'); 
+        } else if (f === 'BINARY') {
+          // ignore flag for now
+        } else if (f === 'MULTIPLE_KEY') {
+          // not sure if that should be part of inspection.
+          // in the schema usually this is part of index definition
+          // example: UNIQUE KEY `my_uniq_id` (`id_box_elements`,`id_router`)
+          // note that only first column has MULTIPLE_KEY flag set in this case
+          // so there is no good way of knowing that this is part of index just 
+          // by looking at indifidual field flags
+        } else if (f === 'NO_DEFAULT_VALUE') {
+          // almost the same as NOT_NULL?
+        } else if (f === 'BLOB') {
+          // included in the type
+        } else if (f === 'UNSIGNED') {
+          // this should be first after type
+        } else if (f === 'TIMESTAMP') {
+          // timestamp flag is redundant for inspection - already included in type
+        } else if (f === 'ON_UPDATE_NOW') {
+          flagNames.push('ON UPDATE CURRENT_TIMESTAMP');
+        } else {
+          flagNames.push(f);
+        }
+      }
+    }
+
+    if (depth > 1) {
+      return inspect({
+        ...this.inspect(),
+        typeName: typeNames[this.columnType],
+        flags: flagNames,
+      });
+    }
+
+    const isUnsigned = this.flags & fiedFlags.UNSIGNED;
+
+    let typeName = typeNames[this.columnType];
+    if (typeName === 'BLOB') {
+      // TODO: check for non-utf8mb4 encoding
+      if (this.columnLength === 4294967295) {
+        typeName = 'LONGTEXT';
+      } else if (this.columnLength === 67108860) {
+        typeName = 'MEDIUMTEXT';
+      } else if (this.columnLength === 262140) {
+        typeName = 'TEXT';
+      } else if (this.columnLength === 1020) { // 255*4
+        typeName = 'TINYTEXT';
+      } else {
+        typeName = `BLOB(${this.columnLength})`;
+      }
+    } else if (typeName === 'VAR_STRING') {
+      // TODO: check for non-utf8mb4 encoding
+      typeName = `VARCHAR(${Math.ceil(this.columnLength/4)})`;
+    } else if (typeName === 'TINY') {
+      if (
+        (this.columnLength === 3 && isUnsigned) ||
+        (this.columnLength === 4 && !isUnsigned) ) {
+        typeName = 'TINYINT';
+      } else {
+        typeName = `TINYINT(${this.columnLength})`;
+      }
+    } else if (typeName === 'LONGLONG') {
+      if (this.columnLength === 20) {
+        typeName = 'BIGINT';
+      } else {
+        typeName = `BIGINT(${this.columnLength})`;
+      }
+    } else if (typeName === 'SHORT') {
+      if (isUnsigned && this.columnLength === 5) {
+        typeName = 'SMALLINT';
+      } else if (!isUnsigned && this.columnLength === 6) {
+        typeName = 'SMALLINT';
+      } else {
+        typeName = `SMALLINT(${this.columnLength})`;
+      }
+
+    } else if (typeName === 'LONG') {
+      if (isUnsigned &&  this.columnLength === 10) {
+        typeName = 'INT';
+      } else if (!isUnsigned && this.columnLength === 11) {
+        typeName = 'INT';
+      } else {
+        typeName = `INT(${this.columnLength})`;
+      }
+    } else if (typeName === 'INT24') {
+      if (isUnsigned && this.columnLength === 8) {
+        typeName = 'MEDIUMINT';
+      } else if (!isUnsigned && this.columnLength === 9) {
+        typeName = 'MEDIUMINT';
+      } else {
+        typeName = `MEDIUMINT(${this.columnLength})`;
+      }
+    } else if (typeName === 'DOUBLE') {
+      // DOUBLE without modifiers is reported as DOUBLE(22, 31)
+      if (this.columnLength === 22 && this.decimals === 31) {
+        typeName = 'DOUBLE';
+      } else {
+        typeName = `DOUBLE(${this.columnLength},${this.decimals})`;
+      }
+    } else if (typeName === 'FLOAT') {
+      // FLOAT without modifiers is reported as FLOAT(12, 31)
+      if (this.columnLength === 12 && this.decimals === 31) {
+        typeName = 'FLOAT';
+      } else {
+        typeName = `FLOAT(${this.columnLength},${this.decimals})`;
+      }
+    } else if (typeName === 'NEWDECIMAL') {
+      if (this.columnLength === 11 && this.decimals === 0) {
+        typeName = 'DECIMAL';
+      } else if (this.decimals === 0) {
+        // not sure why, but DECIMAL(13) is reported as DECIMAL(14, 0)
+        // and DECIMAL(13, 9) is reported as NEWDECIMAL(15, 9)
+        if (isUnsigned) {
+          typeName = `DECIMAL(${this.columnLength})`;
+        } else {
+          typeName = `DECIMAL(${this.columnLength - 1})`;
+        }
+      } else {
+        typeName = `DECIMAL(${this.columnLength - 2},${this.decimals})`;
+      }
+    } else {
+      typeName = `${typeNames[this.columnType]}(${this.columnLength})`;
+    }
+
+    if (isUnsigned) {
+      typeName += ' UNSIGNED';
+    }
+
+    // TODO respect colors option
+    return `\`${this.name}\` ${[typeName, ...flagNames].join(' ')}`;
+  }
+
   static toPacket(column, sequenceId) {
     let length = 17; // = 4 padding + 1 + 12 for the rest
     fields.forEach(field => {

package/lib/packets/resultset_header.js

@@ -94,6 +94,8 @@ class ResultSetHeader {
     const m = this.info.match(/\schanged:\s*(\d+)/i);
     if (m !== null) {
       this.changedRows = parseInt(m[1], 10);
+    } else {
+      this.changedRows = 0;
     }
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mysql2",
-  "version": "3.4.5",
+  "version": "3.5.1",
   "description": "fast mysql driver. Implements core protocol, prepared statements, ssl and compression in native JS",
   "main": "index.js",
   "directories": {
@@ -81,7 +81,7 @@
     "husky": "^8.0.2",
     "lint-staged": "^13.0.3",
     "portfinder": "^1.0.28",
-    "prettier": "^2.4.1",
+    "prettier": "^3.0.0",
     "progress": "^2.0.3",
     "typescript": "^5.0.2",
     "urun": "0.0.8",

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

@@ -1,9 +1,17 @@
+/**
+ * @deprecated
+ * `OkPacket` is deprecated and might be removed in the future major release. Please use `ResultSetHeader` instead.
+ */
 declare interface OkPacket {
   constructor: {
     name: 'OkPacket';
   };
   fieldCount: number;
   affectedRows: number;
+  /**
+   * @deprecated
+   * `changedRows` is deprecated and might be removed in the future major release. Please use `affectedRows` property instead.
+   */
   changedRows: number;
   insertId: number;
   serverStatus: number;

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

@@ -3,16 +3,11 @@ import { ResultSetHeader } from './ResultSetHeader.js';
 import { RowDataPacket } from './RowDataPacket.js';
 
 declare type ProcedureCallPacket<
-  T = RowDataPacket[] | RowDataPacket[][] | ResultSetHeader
+  T = [RowDataPacket[], ResultSetHeader] | ResultSetHeader,
 > = T extends RowDataPacket[]
-  ? [...T, ResultSetHeader]
-  : T extends RowDataPacket[][]
-  ? [...T, ResultSetHeader]
-  : T extends ResultSetHeader | OkPacket | OkPacket[]
+  ? [T, ResultSetHeader]
+  : T extends ResultSetHeader | OkPacket
   ? ResultSetHeader
-  :
-      | [...RowDataPacket[], ResultSetHeader]
-      | [...RowDataPacket[][], ResultSetHeader]
-      | ResultSetHeader;
+  : [RowDataPacket[], ResultSetHeader] | ResultSetHeader;
 
 export { ProcedureCallPacket };

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

@@ -8,7 +8,11 @@ declare interface ResultSetHeader {
   insertId: number;
   serverStatus: number;
   warningStatus: number;
-  changedRows?: number;
+  /**
+   * @deprecated
+   * `changedRows` is deprecated and might be removed in the future major release. Please use `affectedRows` property instead.
+   */
+  changedRows: number;
 }
 
 export { ResultSetHeader };

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

@@ -20,6 +20,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -34,6 +35,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -49,6 +51,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -63,6 +66,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]

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

@@ -20,6 +20,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -34,6 +35,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -49,6 +51,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -63,6 +66,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]

package/typings/mysql/lib/protocol/sequences/promise/ExecutableBase.d.ts

@@ -15,6 +15,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -26,6 +27,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -38,6 +40,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -49,6 +52,7 @@ export declare function ExecutableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]

package/typings/mysql/lib/protocol/sequences/promise/QueryableBase.d.ts

@@ -15,6 +15,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -26,6 +27,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -38,6 +40,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]
@@ -49,6 +52,7 @@ export declare function QueryableBase<T extends QueryableConstructor>(
       T extends
         | OkPacket
         | ResultSetHeader
+        | ResultSetHeader[]
         | RowDataPacket[]
         | RowDataPacket[][]
         | OkPacket[]