Skip to content

Commit

Permalink
Update README and CHANGELOG
Browse files Browse the repository at this point in the history
  • Loading branch information
Sannis committed Mar 31, 2012
1 parent 3cee05e commit 879b50e
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 9 deletions.
29 changes: 29 additions & 0 deletions CHANGELOG.markdown
Original file line number Diff line number Diff line change
@@ -1,6 +1,17 @@
Changelog (revision history) for node-mysql-libmysqlclient,
the full MySQL bindings for Node.js using libmysqlclient.

### In next version

* Improvements:
* Add binding.gyp sypport for node v0.6.x and newer, refs #111
* Introduce node_async_shim.h for transparent eio_custom()/uv_queue_work() support
* Add some new tests with proper CALL results handling, refs #108
* Merge statements branch withpart of prepared statements supports (unstable)
* Uncompatible changes:
* Return BIGINT/DECIMAL/NUMERIC fields as strings to JavaScript land, fixes #110
* Remove libmysqlclient_r support

## Version 1.2.10

* Fix bug with wrong 1194 erro handling, #109
Expand Down Expand Up @@ -43,11 +54,13 @@ the full MySQL bindings for Node.js using libmysqlclient.
Special thanks to Vitaly Puzrin

## Version 1.2.1

* Fix wrong gmt_delta calculation in datetime casting, closes #72
* Revert "build: add check for ev library before adding it to link line"
* Revert "link libev for 'ev_default_loop_ptr' symbol"

## Version 1.2.0

* Improvements:
* Use Buffer(v0.2.x)/FastBuffer(v0.3.x) instead of V8 strings to encode binary data, closes #30
* Free result object after res.fetchAll() callback, closes #60
Expand All @@ -60,6 +73,7 @@ Special thanks to Roman Shtylman
Thanks for Krists Krīgers first buffers implementation, 6826022fb8a34f48d0c4e51a6cd1af487293e89d

## Version 1.1.1

* Fixes:
* Fix mysql_options() recall after mysql_real_connect(), closes #71 part 1
* Fix logic error in res.fetchAll(), closes #71 past 2
Expand All @@ -70,6 +84,7 @@ Thanks for Krists Krīgers first buffers implementation, 6826022fb8a34f48d0c4e51
Special thanks to Krists Krīgers

## Version 1.1.0

* Fixes:
* Don't ignore connect arguments after any null, closes #63
* Reset connect_error in MysqlConnection::Close()
Expand Down Expand Up @@ -104,17 +119,20 @@ Special thanks to Pavel Ponomarenko and Surendra Singhi
Thanks to Michael Pearson, who pointed out the problem with stored procedures

## Version 1.0.3

* Update nodeunit from cf2f529 to d4949a4
* Add HTML documentation into repo
* Add .npmignore file, closes #54

## Version 1.0.2

* Tested with Node version v0.2.3
* Some changes to make the module build with specific libmysqlclient path, closes #50

Special thanks to Benjmain Reesman

## Version 1.0.1

* Change node-gc to Sannis' fork with some fixes
* Improve simple.conn.ConnectWithError test, tests cleanup
* Add gh_pages.sh to simplify docs update
Expand All @@ -124,6 +142,7 @@ Special thanks to Benjmain Reesman
Special thanks to Surendra Singhi and http://fallen.habrahabr.ru

## Version 1.0.0

* Fixes:
* Rewrite fetchAll function, move V8 stuff to EIO\_After\_FetchAll, closes #34
* Rewrite MysqlResult::SetFieldValue() procedure to GetFieldValue() function
Expand All @@ -149,6 +168,7 @@ Special thanks to Surendra Singhi and http://fallen.habrahabr.ru
Special thanks to Ben Noordhuis

## Version 0.0.10

* Add JSDocs into bindings code
* Add API documentation page
* Add examples.js and Dox-generated examples.html
Expand All @@ -157,6 +177,7 @@ Special thanks to Ben Noordhuis
* Other cleanup in tests and files

## Version 0.0.9

* Add MYSQL\_TYPE\_TIME and MYSQL\_TYPE\_SET handling
* Rename MysqlConn to MysqlConnection
* Change some methods to read-only properties:
Expand All @@ -176,6 +197,7 @@ Special thanks to Ben Noordhuis
Special thanks to Akzhan Abdulin and Surendra Singhi

## Version 0.0.8

* Make asynchronous connect and fetchAll
* Tested with Node version v0.2.0
* Small improves in tests, README
Expand All @@ -187,6 +209,7 @@ Special thanks to Akzhan Abdulin and Surendra Singhi
Special thanks to Surendra Singhi

## Version 0.0.7

* Make asynchronous querying work
* Simplify javascript logic of createConnection()
* Allow reconnecting after failed connect
Expand All @@ -200,6 +223,7 @@ Special thanks to Surendra Singhi
Special thanks to Surendra Singhi

## Version 0.0.6

* Update package.json and make small fixes in docs and README
* Rename MysqlResult::FetchResult method to FetchAll
* Implemented methods:
Expand All @@ -218,6 +242,7 @@ Special thanks to Surendra Singhi
* MysqlResult class finished

## Version 0.0.5

* Remove 'Sync' from classes names,
rename main module file to mysql-libmysqlclient.js
* Add example MysqlConn::queryAsync() and MysqlConn::async() methods
Expand All @@ -226,6 +251,7 @@ Special thanks to Surendra Singhi
* Add speedtest

## Version 0.0.4

* Split source code into separate files for database connection,
query result and prepared statements
* Add nodeunit as the test framework for project
Expand Down Expand Up @@ -253,6 +279,7 @@ Special thanks to Surendra Singhi
* Decrease number of cpplint warnings (dirty hack? maybe)

## Version 0.0.3

* Add 'lint' target for node-waf
* Add docs dir, docs/examples.md,
docs/api\_php\_mysqli.md and docs/api\_node\_mysql\_sync.md
Expand All @@ -270,11 +297,13 @@ Special thanks to Surendra Singhi
* Improve MysqlSyncConn::Connect() functionality, see d2d9ae2

## Version 0.0.2

* Split MysqlDbSync into MysqlSyncConn and MysqlSyncRes
* Add unit tests suite
* Query() API is more clear to PHP MySQLi

## Version 0.0.1

* Basic functionality: connect/close/query/fenchAll/getInfo/error/etc.
* Implemented methods:
* MysqlDbSync::AffectedRows()
Expand Down
21 changes: 12 additions & 9 deletions README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Master (development) branch build status:
Dependencies
------------

This module tested with Node.js version 0.4.12 (@v1.2.5) and 0.6.11 (@v1.2.10).
This module tested with Node.js stable versions 0.4.12 and 0.6.12, and with unstable 0.7.6.

To build it you must install libmysqlclient library and development files for it.
Node-waf use mysql_config to determine the paths to the library and header files.
Expand Down Expand Up @@ -61,23 +61,26 @@ If you want to build specific version of node-mysql-libmysqlclient, checkout it:

$> git checkout v1.0.2

To build the bindings you should run:
To build the binding using `node-waf` you should run:

$> node-waf configure build
$> make waf

To rebuild:
To build the binding using `node-gyp` you should run:

$> node-waf distclean configure build
$> make gyp

To cleanup:

$> make clean

To run tests:

$> npm install nodeunit
$> node-waf test
$> make test

To lint code:

$> npm install nodelint
$> # install cpplint.py
$> make lint

The two files required to use these bindings are ./mysql-libmysqlclient.js and
./mysql\_bindings.node (build/default/mysql\_bindings.node).
Expand Down Expand Up @@ -181,7 +184,7 @@ Contributors

* **Zhiqiang Zhao** ( [E-mail](mailto:zzqvincent@gmail.com), [GitHub](https://github.com/vincent-zhao) \)

Fix bug with wrong 1194 erro handling.
Fix bug with wrong 1194 error handling.
[All commits](https://github.com/Sannis/node-mysql-libmysqlclient/commits/master?author=vincent-zhao).

[Full contributors list](https://github.com/Sannis/node-mysql-libmysqlclient/contributors).
Expand Down

0 comments on commit 879b50e

Please sign in to comment.