VladPolskiy/mariadb-connector-nodejs
1
0
Fork 0
mirror of https://github.com/mariadb-corporation/mariadb-connector-nodejs.git synced 2025-07-25 16:02:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

[misc] Promise implementation for connect() and end() methods

Browse Source
This commit is contained in:
rusher
2018-06-01 17:02:53 +02:00
parent aaa9326673
commit caddb3f5c3
3 changed files with 187 additions and 127 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
documentation/readme.md
View File

@ -8,18 +8,22 @@ TODO have automatically generated table of contents
common API to mysql/mysql2:
* `connect(callback)`: Connect event with callback
* `changeUser(options, callback)`: change current connection user
* `beginTransaction(options, callback)`: begin transaction
* `commit(options, callback)`: commit current transaction if any
* `rollback(options, callback)`: rollback current transaction if any
* `ping(options, callback)`: send an empty packet to server to check that connection is active
* `connect([callback]) => Promise`: connect to database. <br/>
Callback parameter is for compatibility with existing drivers.<br/>
return Promise when no callback
* `changeUser([options][,callback])`: change current connection user
* `beginTransaction([options][,callback])`: begin transaction
* `commit([options][,callback])`: commit current transaction if any
* `rollback([options][,callback])`: rollback current transaction if any
* `ping([options][,callback])`: send an empty packet to server to check that connection is active
* `query(sql[, values][,callback])`: execute a [query](#query).
* `pause()`: pause socket output.
* `resume()`: resume socket output.
* `on(eventName, listener)`: register to connection event
* `once(eventName, listener)`: register to next connection event
* `end(callback)`: gracefully end connection
* `end([callback]) => Promise`: gracefully end connection<br/>
Callback parameter is for compatibility with existing drivers.<br/>
return Promise when no callback
* `destroy()`: force connection ending.