diff --git a/lib/connection_config.js b/lib/connection_config.js index 0709e83695..eeb8a8d916 100644 --- a/lib/connection_config.js +++ b/lib/connection_config.js @@ -65,7 +65,8 @@ const validOptions = { idleTimeout: 1, Promise: 1, queueLimit: 1, - waitForConnections: 1 + waitForConnections: 1, + jsonStrings: 1 }; class ConnectionConfig { @@ -180,6 +181,7 @@ class ConnectionConfig { }; this.connectAttributes = { ...defaultConnectAttributes, ...(options.connectAttributes || {})}; this.maxPreparedStatements = options.maxPreparedStatements || 16000; + this.jsonStrings = options.jsonStrings || false; } static mergeFlags(default_flags, user_flags) { diff --git a/lib/parsers/binary_parser.js b/lib/parsers/binary_parser.js index 59d87bca32..bf0995d148 100644 --- a/lib/parsers/binary_parser.js +++ b/lib/parsers/binary_parser.js @@ -59,7 +59,7 @@ function readCodeFor(field, config, options, fieldNum) { // Since for JSON columns mysql always returns charset 63 (BINARY), // we have to handle it according to JSON specs and use "utf8", // see https://github.com/sidorares/node-mysql2/issues/409 - return 'JSON.parse(packet.readLengthCodedString("utf8"));'; + return config.jsonStrings ? 'packet.readLengthCodedString("utf8")' : 'JSON.parse(packet.readLengthCodedString("utf8"));'; case Types.LONGLONG: if (!supportBigNumbers) { return unsigned diff --git a/lib/parsers/text_parser.js b/lib/parsers/text_parser.js index acd75caca7..f66a185afe 100644 --- a/lib/parsers/text_parser.js +++ b/lib/parsers/text_parser.js @@ -63,7 +63,7 @@ function readCodeFor(type, charset, encodingExpr, config, options) { // Since for JSON columns mysql always returns charset 63 (BINARY), // we have to handle it according to JSON specs and use "utf8", // see https://github.com/sidorares/node-mysql2/issues/409 - return 'JSON.parse(packet.readLengthCodedString("utf8"))'; + return config.jsonStrings ? 'packet.readLengthCodedString("utf8")' : 'JSON.parse(packet.readLengthCodedString("utf8"))'; default: if (charset === Charsets.BINARY) { return 'packet.readLengthCodedBuffer()'; diff --git a/typings/mysql/lib/Connection.d.ts b/typings/mysql/lib/Connection.d.ts index ade871d1b7..2dabd960fc 100644 --- a/typings/mysql/lib/Connection.d.ts +++ b/typings/mysql/lib/Connection.d.ts @@ -326,6 +326,13 @@ export interface ConnectionOptions { authPlugins?: { [key: string]: AuthPlugin; }; + + /** + * Force JSON to be returned as string + * + * (Default: false) + */ + jsonStrings?: boolean; } declare class Connection extends QueryableBase(ExecutableBase(EventEmitter)) { diff --git a/website/docs/documentation/00-index.mdx b/website/docs/documentation/00-index.mdx index a2d3f2c2f5..b249a066a0 100644 --- a/website/docs/documentation/00-index.mdx +++ b/website/docs/documentation/00-index.mdx @@ -54,6 +54,14 @@ Please check these [examples](/docs/examples) for **MySQL2**. This option could lose precision on the number as Javascript Number is a Float! ::: +- By default, the `JSON` type is always returned parsed into an object. However, you can modify this behavior by specifying the following configuration: + +```js +{ + jsonStrings: true, +} +``` +
## Other Resources