-
Notifications
You must be signed in to change notification settings - Fork 34
Native mysql async client for node.js
License
sidorares/nodejs-mysql-native
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Mysql client module for node.js, written in JavaScript. No other mysql runtime required. simple example: var db = require("mysql/client").createTCPClient(); // localhost:3306 by default db.auto_prepare = true; function dump_rows(cmd) { cmd.addListener('row', function(r) { sys.puts("row: " + sys.inspect(r)); } ); } db.auth("test", "testuser", "testpass"); dump_rows(db.query("select 1+1,2,3,'4',length('hello')")); dump_rows(db.execute("select 1+1,2,3,'4',length(?)", ["hello"])); db.close(); otput 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: mysql/client: 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 client.auth client.query client.prepare client.execute 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 === commands: All commands fire 'done'() event at the end of command executing. - auth(user, pass, db) - perform mysql connection handshake. Should be always a first command (TODO: add default user/pass if missing?). Events: 'authirized'(serverStatus) event. - query(sql) - sumple 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() === connection pool pool(createNewConnectionCallback, minConnections) - create a new pool, spawn minConnections at start using createNewConnectionCallback. One should usually call auth command on a new connection before returning it. pool.get( connectionAvailableCallback ) - calls connectionAvailableCallback when there is connection with queue length < pool.maxQueue. parameters: pool.minConnections pool.maxConnections pool.maxQueue pool.maxWaiters TODO: - buffers LINKS: Mysql protocol documentation: http://forge.mysql.com/wiki/MySQL_Internals_ClientServer_Protocol Other node.js mysql clients: http://github.com/masuidrive/node-mysql http://github.com/Sannis/node-mysql-libmysqlclient http://github.com/Guille/node.dbslayer.js/
About
Native mysql async client for node.js
Resources
License
Stars
Watchers
Forks
Packages 0
No packages published