Skip to content
This repository

Asynchronous MySQL binding for Node.js

README.markdown

Node-mysql-libmysqlclient

MySQL bindings for Node.js using libmysqlclient.
Check out the Github repo for the source code.
Visit module site for API docs and examples.
Extra information available in wiki.

Master (development) branch build status: Build Status

Dependencies

This module tested with Node.js version 0.4.12 (@v1.2.5) and 0.6.11 (@v1.2.10).

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. To install these dependencies, you can use the console.

For CentOS:

#> yum install mysql-devel

For openSUSE:

#> zypper install libmysqlclient-devel

For Debian/Ubuntu:

#> apt-get install libmysqlclient-dev

Yes, you would use aptitude if you want.

Installation

You can install this module via NPM:

$> npm install mysql-libmysqlclient

Also you can build latest source code from repository, see below.

Build and use

To get source code:

$> git clone git://github.com/Sannis/node-mysql-libmysqlclient.git
$> cd node-mysql-libmysqlclient

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:

$> node-waf configure build

To rebuild:

$> node-waf distclean configure build

To run tests:

$> npm install nodeunit
$> node-waf test

To lint code:

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

The two files required to use these bindings are ./mysql-libmysqlclient.js and ./mysql_bindings.node (build/default/mysql_bindings.node). Put module directory in your NODE_PATH or copy those two files where you need them.

Contributing

I will be happy to hear tips from the more experienced programmers. If you are interested in wide MySQL usage in Node.JS applications, leave your comments to the code. I'll be glad to see your forks and commits in them :)

To contribute any patches, simply fork this repository using GitHub and send a pull request to me. Thanks!

You can find other information about contributing and code style guide in wiki.

Contributors

Full contributors list.

License

MIT license. See license text in file LICENSE.

Something went wrong with that request. Please try again.