Merge branch 'develop'

Author: rusher

documentation/changelog.md renamed to CHANGELOG.md

@@ -1,4 +1,24 @@
-#### 2.1.1 - 06-09-2019 
+# Change Log
+
+## [2.1.2](https://github.com/MariaDB/mariadb-connector-nodejs/tree/2.1.2) (17 Oct. 2019)
+[Full Changelog](https://github.com/MariaDB/mariadb-connector-nodejs/compare/2.1.1...2.1.2)
+
+Implemented enhancements:
+* CONJS-101	Escape functions API
+* CONJS-100	Improve performance using reusable Object type for column definition result
+* CONJS-102 Expose library version to API
+
+Use milestone to specify in which version bug was fixed #22
+Fixed bugs:
+* CONJS-96	TypeScript definition typecast correction
+* CONJS-95	Pool idle maintainer error
+* CONJS-98	Missing collation option in typescript definition
+* CONJS-99	Improve documentation for best practice concerning credential
+* CONJS-97	Remove coverage comment on github pull request
+
+## [2.1.1](https://github.com/MariaDB/mariadb-connector-nodejs/tree/2.1.1) (06 Sep. 2019)
+
+[Full Changelog](https://github.com/MariaDB/mariadb-connector-nodejs/compare/2.1.0...2.1.1)
 
 * node.je v12 CI testing
 * cluster ordered selector bug fix on failover (thanks to @kkx)
@@ -7,7 +27,9 @@
 * connection.reset() error message improvement (and documentation)
 * small performance improvement when debug not enable
 
-#### 2.1.0 - 11-07-2019 
+## [2.1.0](https://github.com/MariaDB/mariadb-connector-nodejs/tree/2.1.0) (11 Jul. 2019)
+
+[Full Changelog](https://github.com/MariaDB/mariadb-connector-nodejs/compare/2.0.5...2.1.0)
 
 * [CONJS-19]	implement Ed25519 plugin		
 * [CONJS-57]	Multiple alternative authentication methods for the same user		
@@ -31,11 +53,15 @@ New Options
 | **`permitConnectionWhenExpired`** | Permit a user with expired password to connect. Only possible operation in this case will be to change password ('SET PASSWORD=PASSWORD('XXX')')|*boolean* |false|
 
 
-#### 2.0.5 - 10-05-2019 
+## [2.0.5](https://github.com/MariaDB/mariadb-connector-nodejs/tree/2.0.5) (10 May 2019)
+
+[Full Changelog](https://github.com/MariaDB/mariadb-connector-nodejs/compare/2.0.4...2.0.5)
 
 * [CONJS-71] TypeScript definition is not exported
 
-#### 2.0.4 - 07-05-2019 
+## [2.0.4](https://github.com/MariaDB/mariadb-connector-nodejs/tree/2.0.4) (07 May 2019)
+
+[Full Changelog](https://github.com/MariaDB/mariadb-connector-nodejs/compare/2.0.3...2.0.4)
 
 * [CONJS-69] permit set numeric parameter bigger than javascript 2^53-1 limitation
 * [CONJS-68] error when reading datetime data and timezone option is set
@@ -46,7 +72,7 @@ New Options
 * [CONJS-66] SET datatype handling (returning array)
 * [CONJS-67] Changing user does not takes in account connector internal state (transaction status)
 
-##### Pool improvement
+#### Pool improvement
 
 New Options
 
@@ -62,7 +88,9 @@ Pool handle connection creation automatically, with now some delayed after faili
 Authentication error in pool have now a better handling.
 
 
-#### 2.0.3 - 30-01-2019 
+## [2.0.3](https://github.com/MariaDB/mariadb-connector-nodejs/tree/2.0.3) (30 Jan. 2019)
+
+[Full Changelog](https://github.com/MariaDB/mariadb-connector-nodejs/compare/2.0.2-rc...2.0.3)
 
 * [CONJS-56] TypeError: Cannot read property 'totalConnections' of undefined
 * [CONJS-59] pool now throw `ER_ACCESS_DENIED_ERROR` in place of basic timeout error
@@ -71,6 +99,9 @@ Authentication error in pool have now a better handling.
 
 
 #### 2.0.2-rc - 11-12-2018 
+## [2.0.2-rc](https://github.com/MariaDB/mariadb-connector-nodejs/tree/2.0.2-rc) (30 Jan. 2019)
+
+[Full Changelog](https://github.com/MariaDB/mariadb-connector-nodejs/compare/2.0.1-beta...2.0.2-rc)
 
 ##### Changes
 
@@ -93,7 +124,7 @@ Authentication error in pool have now a better handling.
 * pool end() now correctly wait for all connections ending
 
 
-#### 2.0.1-alpha - 15-11-2018 
+#### 2.0.1-alpha - 15 Nov. 2018 
 
 * [CONJS-52] (Bug) Commit not executed when in transaction and autocommit is enabled
 * [CONJS-50] (Bug) race condition when using authentication plugins
@@ -104,7 +135,7 @@ Authentication error in pool have now a better handling.
 * [CONJS-51] Permit use of connection string to provide options
 * [CONJS-48] Add option to permit query command when establishing a connection
 
-#### 2.0.0-alpha - 20-09-2018 
+#### 2.0.0-alpha - 20 Sep. 2018 
 
 * [CONJS-42] check other connections in pool when an unexpected connection error occur
 * [CONJS-44] Create option to permit setting Object to one prepareStatement parameter
@@ -116,6 +147,6 @@ Authentication error in pool have now a better handling.
 * [misc] change pool implementation to permit node 6 compatibility (removal of async await)
 
 
-#### 0.7.0 - 18-07-2018 
+#### 0.7.0 - 18 Jul. 2018 
 
 * First alpha version 

README.md

@@ -6,19 +6,27 @@
 
 # MariaDB Node.js connector
 
-[![Linux Build](https://travis-ci.org/MariaDB/mariadb-connector-nodejs.svg?branch=master)](https://travis-ci.org/MariaDB/mariadb-connector-nodejs)
-[![Windows status](https://ci.appveyor.com/api/projects/status/bcg7yy4iy9viq08t/branch/master?svg=true)](https://ci.appveyor.com/project/rusher/mariadb-connector-nodejs)
-[![License (LGPL version 2.1)](https://img.shields.io/badge/license-GNU%20LGPL%20version%202.1-green.svg?style=flat-square)](http://opensource.org/licenses/LGPL-2.1)
-[![codecov](https://codecov.io/gh/MariaDB/mariadb-connector-nodejs/branch/master/graph/badge.svg)](https://codecov.io/gh/MariaDB/mariadb-connector-nodejs)
+[![npm package][npm-image]][npm-url] 
+[![Linux Build][travis-image]][travis-url]
+[![Windows status][appveyor-image]][appveyor-url]
+[![License (LGPL version 2.1)][licence-image]][licence-url]
+[![codecov][codecov-image]][codecov-url]
 
 **Non-blocking MariaDB and MySQL client for Node.js.**
 
 MariaDB and MySQL client, 100% JavaScript, with TypeScript definition, compatible with Node.js 6+, with the Promise API.
 
+
+## Documentation
+
+See [promise documentation](https://github.com/MariaDB/mariadb-connector-nodejs/blob/master/documentation/promise-api.md) for detailed API. 
+
+[Callback documentation](https://github.com/MariaDB/mariadb-connector-nodejs/blob/master/documentation/callback-api.md) describe the callback wrapper for compatibility with existing drivers.
+   
 ## Why a New Client?
 
 While there are existing MySQL clients that work with MariaDB, (such as the [`mysql`](https://www.npmjs.com/package/mysql) and [`mysql2`](https://www.npmjs.com/package/mysql2) clients), the MariaDB Node.js Connector offers new functionality, like [Insert Streaming](#insert-streaming), [Pipelining](#pipelining), [ed25519 plugin authentication](https://mariadb.org/history-of-mysql-mariadb-authentication-protocols/) while making no compromises on performance.
- 
+
 
 ### Insert Streaming 
 
@@ -82,22 +90,19 @@ Using ECMAScript < 2017:
 
 ```js
 const mariadb = require('mariadb');
-const pool = mariadb.createPool({host: 'mydb.com', user: 'myUser', connectionLimit: 5});
+const pool = mariadb.createPool({host: process.env.DB_HOST, user: process.env.DB_USER, connectionLimit: 5});
 pool.getConnection()
     .then(conn => {
 
       conn.query("SELECT 1 as val")
-        .then((rows) => {
-          console.log(rows); //[ {val: 1}, meta: ... ]
+        .then(rows => { // rows: [ {val: 1}, meta: ... ]
           return conn.query("INSERT INTO myTable value (?, ?)", [1, "mariadb"]);
         })
-        .then((res) => {
-          console.log(res); // { affectedRows: 1, insertId: 1, warningStatus: 0 }
-          conn.end();
+        .then(res => { // res: { affectedRows: 1, insertId: 1, warningStatus: 0 }
+          conn.release(); // release to pool
         })
         .catch(err => {
-          //handle error
-          conn.end();
+          conn.release(); // release to pool
         })
 
     }).catch(err => {
@@ -109,37 +114,41 @@ Using ECMAScript 2017:
 
 ```js
 const mariadb = require('mariadb');
-const pool = mariadb.createPool({host: 'mydb.com', user: 'myUser', connectionLimit: 5});
+const pool = mariadb.createPool({host: process.env.DB_HOST, user: process.env.DB_USER, connectionLimit: 5});
 
 async function asyncFunction() {
   let conn;
   try {
+
 	conn = await pool.getConnection();
 	const rows = await conn.query("SELECT 1 as val");
-	console.log(rows); //[ {val: 1}, meta: ... ]
+	// rows: [ {val: 1}, meta: ... ]
+
 	const res = await conn.query("INSERT INTO myTable value (?, ?)", [1, "mariadb"]);
-	console.log(res); // { affectedRows: 1, insertId: 1, warningStatus: 0 }
+	// res: { affectedRows: 1, insertId: 1, warningStatus: 0 }
 
   } catch (err) {
 	throw err;
   } finally {
-	if (conn) return conn.end();
+	if (conn) conn.release(); //release to pool
   }
 }
 ```
 
-## Documentation
-
-The MariaDB Node.js Connector can use different APIs on the back-end: Promise and Callback.  
-The default API is [Promise API](https://github.com/MariaDB/mariadb-connector-nodejs/blob/master/documentation/promise-api.md).  
-
-[Callback API](https://github.com/MariaDB/mariadb-connector-nodejs/blob/master/documentation/callback-api.md) is provided for compatibility with the `mysql` and `mysql2` APIs.
-  
-
 ## Contributing 
 
 If you would like to contribute to the MariaDB Node.js Connector, please follow the instructions given in the [Developers Guide.](/documentation/developers-guide.md)
 
 To file an issue or follow the development, see [JIRA](https://jira.mariadb.org/projects/CONJS/issues/).
 
 
+[travis-image]:https://travis-ci.org/MariaDB/mariadb-connector-nodejs.svg?branch=master
+[travis-url]:https://travis-ci.org/MariaDB/mariadb-connector-nodejs
+[npm-image]:https://img.shields.io/npm/v/mariadb.svg
+[npm-url]:http://npmjs.org/package/mariadb
+[appveyor-image]:https://ci.appveyor.com/api/projects/status/bcg7yy4iy9viq08t/branch/master?svg=true
+[appveyor-url]:https://ci.appveyor.com/project/rusher/mariadb-connector-nodejs
+[licence-image]:https://img.shields.io/badge/license-GNU%20LGPL%20version%202.1-green.svg?style=flat-square
+[licence-url]:http://opensource.org/licenses/LGPL-2.1
+[codecov-image]:https://codecov.io/gh/MariaDB/mariadb-connector-nodejs/branch/master/graph/badge.svg
+[codecov-url]:https://codecov.io/gh/MariaDB/mariadb-connector-nodejs

benchmarks/benchs/bench_promise_select_one_user.js

@@ -1,59 +1,11 @@
 const assert = require('assert');
 
-module.exports.title = 'select one mysql.user and 1 integer using promise';
-module.exports.displaySql = 'select <all mysql.user fields>, 1 from mysql.user u LIMIT 1';
+module.exports.title = 'select one mysql.user using promise';
+module.exports.displaySql = 'select <all mysql.user fields> from mysql.user u LIMIT 1';
 module.exports.promise = true;
 module.exports.benchFct = function(conn, deferred) {
   conn
-    .query(
-      'select u.Host,\n' +
-        'u.User,\n' +
-        'u.Password,\n' +
-        'u.Select_priv,\n' +
-        'u.Insert_priv,\n' +
-        'u.Update_priv,\n' +
-        'u.Delete_priv,\n' +
-        'u.Create_priv,\n' +
-        'u.Drop_priv,\n' +
-        'u.Reload_priv,\n' +
-        'u.Shutdown_priv,\n' +
-        'u.Process_priv,\n' +
-        'u.File_priv,\n' +
-        'u.Grant_priv,\n' +
-        'u.References_priv,\n' +
-        'u.Index_priv,\n' +
-        'u.Alter_priv,\n' +
-        'u.Show_db_priv,\n' +
-        'u.Super_priv,\n' +
-        'u.Create_tmp_table_priv,\n' +
-        'u.Lock_tables_priv,\n' +
-        'u.Execute_priv,\n' +
-        'u.Repl_slave_priv,\n' +
-        'u.Repl_client_priv,\n' +
-        'u.Create_view_priv,\n' +
-        'u.Show_view_priv,\n' +
-        'u.Create_routine_priv,\n' +
-        'u.Alter_routine_priv,\n' +
-        'u.Create_user_priv,\n' +
-        'u.Event_priv,\n' +
-        'u.Trigger_priv,\n' +
-        'u.Create_tablespace_priv,\n' +
-        'u.ssl_type,\n' +
-        'u.ssl_cipher,\n' +
-        'u.x509_issuer,\n' +
-        'u.x509_subject,\n' +
-        'u.max_questions,\n' +
-        'u.max_updates,\n' +
-        'u.max_connections,\n' +
-        'u.max_user_connections,\n' +
-        'u.plugin,\n' +
-        'u.authentication_string,\n' +
-        'u.password_expired,\n' +
-        'u.is_role,\n' +
-        'u.default_role,\n' +
-        'u.max_statement_time , 50000000 as t' +
-        ' from mysql.user u LIMIT 1'
-    )
+    .query('select * from mysql.user u LIMIT 1')
     .then(rows => {
       // assert.equal(50000000, rows[0]["t"]);
 

callback.js

@@ -8,6 +8,8 @@ const ConnOptions = require('./lib/config/connection-options');
 const PoolOptions = require('./lib/config/pool-options');
 const PoolClusterOptions = require('./lib/config/pool-cluster-options');
 
+module.exports.version = require('./package.json').version;
+
 module.exports.createConnection = function createConnection(opts) {
   return new ConnectionCallback(new ConnOptions(opts));
 };

codecov.yml

@@ -0,0 +1,23 @@
+codecov:
+  notify:
+    require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: "90...100"
+
+  status:
+    project: yes
+    patch: yes
+    changes: no
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment: off