nodejs-mysql-native

Native mysql async client for node.js

Github stars Tracking Chart

Deprecated . If you are using it, please consider migrating to node-mysql2

About

Mysql client module for node.js, written in JavaScript. No other mysql runtime required.

Build Status

Install

npm install mysql-native

Community

Check out the google group http://groups.google.com/group/node-mysql-native for questions/answers from users of the driver.

Example

output is:
row: [ 2, 2, 3, "4", 5]
row: [ 2, 2, 3, "4", 5]

Highlights

  • commands are pipelined
  • types are converted mysql<->javascript according to field type
  • prepared statements are cached and auto-prepared
  • row packet ( query ) and binary row packet ( execute ) handled transparently equal

#API

Module Functions

  • createClient(socket) - create client from duplex stream (TODO: add default path to local server socket)
  • createTCPClient(host, port) - create tcp client, default host 127.0.0.1, port 3306
  • createUNIXClient(path) - connect to unix domain socket, default is /var/run/mysqld/mysqld.sock

Client Functions

All commands fire 'end'() event at the end of command executing.

  • auth(db, user, pass) - perform mysql connection handshake. Should be always a first command (TODO: add default user/pass if missing?).
    Events:
    'authorized'(serverStatus) event.

  • query(sql) - simple query.
    Events:
    'field'(field) - one for each field description
    'fields_eof'() - after last field
    'row'(rows) - array of field values, fired for each row in result set

  • client.prepre(sql) - prepare a statement and store result in client.pscache
    Events:
    'prepared'(preparedStatement)
    'parameter'(field) - input parameter description

  • execute(sql, parameters) - parameters is an array of values. Known types are sent in appropriate mysql binary type (TODO: currently this is not true, type is always string and input converted using param.toString() )
    Events:
    same as with query()

  • client.close - create and enqueue corresponding command

  • client.execute also adds prepare command if there is no cached statement and client.auto_prepare set to true (TODO: add better api than client.auto_prepare flag)

  • client.terminate - close conection immediately

TODO

  • buffers

LINKS

MySql protocol documentation:

Other node.js mysql clients:

Bitdeli Badge

Main metrics

Overview
Name With Ownersidorares/nodejs-mysql-native
Primary LanguageJavaScript
Program languageJavaScript (Language Count: 1)
Platform
License:MIT License
所有者活动
Created At2010-02-15 14:44:45
Pushed At2018-05-17 09:55:33
Last Commit At2014-02-22 07:57:02
Release Count8
Last Release Namev0.4.3 (Posted on )
First Release Namelist (Posted on )
用户参与
Stargazers Count245
Watchers Count14
Fork Count34
Commits Count200
Has Issues Enabled
Issues Count58
Issue Open Count21
Pull Requests Count16
Pull Requests Open Count4
Pull Requests Close Count3
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private