Mysql Module
Mysql module for gracenode framework.
This is designed to function within gracenode framework.
How to include it in my project
To add this package as your gracenode module, add the following to your package.json:
"dependencies": {
"gracenode": "",
"gracenode-mysql": ""
}
To use this module in your application, add the following to your gracenode bootstrap code:
var gracenode = require('gracenode');
// this tells gracenode to load the module
gracenode.use('gracenode-mysql');
To access the module:
// the prefix gracenode- will be removed automatically
gracenode.mysql
Access
gracenode.mysql
Configurations
"modules": "mysql": "configNameOfYourChoice": "read": "database": "databaseName" "host": "host or IP address" "user": "databaseUser" "password": "databasePassword" "poolSize": <int optional> "options": {} // optional "write": "database": "databaseName" "host": "host or IP address" "user": "databaseUser" "password": "databasePassword" "poolSize": <int optional> "options": {} // optional ...
Optional Configurations:
gracenode-mysql
supports connection options. To add options, add options
in your configurations.
API: create
MySql create(String configName)
Returns an instance of MySqlGroup class
MySqlGroup class
getOne
void getOne(String sql, Array params, Function callback)
Executes a "select" SQL query and passes a result to callback.
If no result is found, the funtion will throw an error.
var mysql = gracenodemysql;mysql;
getOneFromMaster
Reads from "write-only" database.
getMany
void getMany(String sql, Array params, Function callback)
Executes a "select" SQL query and passes results to callback
If no result is found, the function will throw an error.
getManyFromMaster
Reads from "write-only" database.
searchOne
void searchOne(String sql, Array params, Function callback)
Executes a "select" SQL query and passes a result to callback
No result will NOT throw an error.
searchOneFromMaster
Reads from "write-only" database.
searchMany
void searchMany(String sql, Array params, Function callback)
Executes a "select" SQL query and passes results to callback
No result will NOT throw an error.
searchManyFromMaster
Reads from "write-only" database.
write
void write(String sql, Array params, Function callback)
Executes "insert/update/delete/truncate/alter/create/drop/" SQL query
Can NOT be executed if the type is "ro"
transaction
void transaction(Function taskCallback, Function callback)
Creates Mysql transaction and allows you to execute transactional SQL queries in taskCallback.
Commit will be executed automatically on successful execution of taskCallback
An error in taskCallback will cause auto-rollback and ends the transaction.
Can NOT be executed if the type is "ro"
var mysql = gracenodemysql;mysql;
placeHolder
Array placeHolder(Array params)
Creates and returns an array of ? based on params given.
var mysql = gracenode;var params = 'jenny' 'ben' 'krista' 'ken';mysql;