一、建立數(shù)據(jù)庫連接:createConnection(Object)方法
該方法接受一個對象作為參數(shù),該對象有四個常用的屬性host,user,password,database。與php中鏈接數(shù)據(jù)庫的參數(shù)相同。屬性列表如下:
host: 連接數(shù)據(jù)庫所在的主機(jī)名. (默認(rèn): localhost)
port: 連接端口. (默認(rèn): 3306)
localAddress: 用于TCP連接的IP地址. (可選)
socketPath: 鏈接到unix域的路徑。在使用host和port時該參數(shù)會被忽略.
user: MySQL用戶的用戶名.
password: MySQL用戶的密碼.
database: 鏈接到的數(shù)據(jù)庫名稱 (可選).
charset: 連接的字符集. (默認(rèn): 'UTF8_GENERAL_CI'.設(shè)置該值要使用大寫!)
timezone: 儲存本地時間的時區(qū). (默認(rèn): 'local')
stringifyObjects: 是否序列化對象. See issue #501. (默認(rèn): 'false')
insecureAuth: 是否允許舊的身份驗證方法連接到數(shù)據(jù)庫實例. (默認(rèn): false)
typeCast: 確定是否講column值轉(zhuǎn)換為本地JavaScript類型列值. (默認(rèn): true)
queryFormat: 自定義的查詢語句格式化函數(shù).
supportBigNumbers: 數(shù)據(jù)庫處理大數(shù)字(長整型和含小數(shù)),時應(yīng)該啟用 (默認(rèn): false).
bigNumberStrings: 啟用 supportBigNumbers和bigNumberStrings 并強(qiáng)制這些數(shù)字以字符串的方式返回(默認(rèn): false).
dateStrings: 強(qiáng)制日期類型(TIMESTAMP, DATETIME, DATE)以字符串返回,而不是一javascript Date對象返回. (默認(rèn): false)
debug: 是否開啟調(diào)試. (默認(rèn): false)
multipleStatements: 是否允許在一個query中傳遞多個查詢語句. (Default: false)
flags: 鏈接標(biāo)志.
還可以使用字符串連接數(shù)據(jù)庫例如:
代碼如下:
var connection = mysql.createConnection('mysql://user:pass@host/db?debug=true&charset=BIG5_CHINESE_CI&timezone=-0700');
二、結(jié)束數(shù)據(jù)庫連接end()和destroy()
end()接受一個回調(diào)函數(shù),并且會在query結(jié)束之后才觸發(fā),如果query出錯,仍然會終止鏈接,錯誤會傳遞到回調(diào)函數(shù)中處理。
destroy()立即終止數(shù)據(jù)庫連接,即使還有query沒有完成,之后的回調(diào)函數(shù)也不會在觸發(fā)。
三、創(chuàng)建連接池 createPool(Object)
Object和createConnection參數(shù)相同。
可以監(jiān)聽connection事件,并設(shè)置session值
pool.on('connection', function(connection) {
connection.query('SET SESSION auto_increment_increment=1')
});
connection.release()釋放鏈接到連接池。如果需要關(guān)閉連接并且刪除,需要使用connection.destroy()
pool除了接受和connection相同的參數(shù)外,還接受幾個擴(kuò)展的參數(shù)
createConnection: 用于創(chuàng)建鏈接的函數(shù). (Default: mysql.createConnection)
waitForConnections: 決定當(dāng)沒有連接池或者鏈接數(shù)打到最大值時pool的行為. 為true時鏈接會被放入隊列中在可用是調(diào)用,為false時會立即返回error. (Default: true)
connectionLimit: 最大連接數(shù). (Default: 10)
queueLimit: 連接池中連接請求的烈的最大長度,超過這個長度就會報錯,值為0時沒有限制. (Default: 0)
四、連接池集群
允許不同的host鏈接
// create
var poolCluster = mysql.createPoolCluster();
poolCluster.add(config); // anonymous group
poolCluster.add('MASTER', masterConfig);
poolCluster.add('SLAVE1', slave1Config);
poolCluster.add('SLAVE2', slave2Config);
// Target Group : ALL(anonymous, MASTER, SLAVE1-2), Selector : round-robin(default)
poolCluster.getConnection(function (err, connection) {});
// Target Group : MASTER, Selector : round-robin
poolCluster.getConnection('MASTER', function (err, connection) {});
// Target Group : SLAVE1-2, Selector : order
// If can't connect to SLAVE1, return SLAVE2. (remove SLAVE1 in the cluster)
poolCluster.on('remove', function (nodeId) {
console.log('REMOVED NODE : ' + nodeId); // nodeId = SLAVE1
});
poolCluster.getConnection('SLAVE*', 'ORDER', function (err, connection) {});
// of namespace : of(pattern, selector)
poolCluster.of('*').getConnection(function (err, connection) {});
var pool = poolCluster.of('SLAVE*', 'RANDOM');
pool.getConnection(function (err, connection) {});
pool.getConnection(function (err, connection) {});
// destroy
poolCluster.end();
鏈接集群的可選參數(shù)
canRetry: 值為true時,允許連接失敗時重試(Default: true)
removeNodeErrorCount: 當(dāng)連接失敗時 errorCount 值會增加. 當(dāng)errorCount 值大于 removeNodeErrorCount 將會從PoolCluster中刪除一個節(jié)點. (Default: 5)
1.defaultSelector: 默認(rèn)選擇器. (Default: RR)
2.RR: 循環(huán). (Round-Robin)
3.RANDOM: 通過隨機(jī)函數(shù)選擇節(jié)點.
4.ORDER: 無條件地選擇第一個可用節(jié)點.
五、切換用戶/改變連接狀態(tài)
Mysql允許在比斷開連接的的情況下切換用戶
connection.changeUser({user : 'john'}, function(err) {
if (err) throw err;
});
參數(shù)
1.user: 新的用戶 (默認(rèn)為早前的一個).
2.password: 新用戶的新密碼 (默認(rèn)為早前的一個).
3.charset: 新字符集 (默認(rèn)為早前的一個).
4.database: 新數(shù)據(jù)庫名稱 (默認(rèn)為早前的一個).
六、處理服務(wù)器連接斷開
var db_config = {
host: 'localhost',
user: 'root',
password: '',
database: 'example'
};
var connection;
function handleDisconnect() {
connection = mysql.createConnection(db_config); // Recreate the connection, since
// the old one cannot be reused.
connection.connect(function(err) { // The server is either down
if(err) { // or restarting (takes a while sometimes).
console.log('error when connecting to db:', err);
setTimeout(handleDisconnect, 2000); // We introduce a delay before attempting to reconnect,
} // to avoid a hot loop, and to allow our node script to
}); // process asynchronous requests in the meantime.
// If you're also serving http, display a 503 error.
connection.on('error', function(err) {
console.log('db error', err);
if(err.code === 'PROTOCOL_CONNECTION_LOST') { // Connection to the MySQL server is usually
handleDisconnect(); // lost due to either server restart, or a
} else { // connnection idle timeout (the wait_timeout
throw err; // server variable configures this)
}
});
}
handleDisconnect();
七、轉(zhuǎn)義查詢值
為了避免SQL注入攻擊,需要轉(zhuǎn)義用戶提交的數(shù)據(jù)??梢允褂胏onnection.escape() 或者 pool.escape()
例如:
var userId = 'some user provided value';
var sql = 'SELECT * FROM users WHERE id = ' + connection.escape(userId);
connection.query(sql, function(err, results) {
// ...
});
或者使用?作為占位符
connection.query('SELECT * FROM users WHERE id = ?', [userId], function(err, results) {
// ...
});
不同類型值的轉(zhuǎn)換結(jié)果
Numbers 不變
Booleans 轉(zhuǎn)換為字符串 'true' / 'false'
Date 對象轉(zhuǎn)換為字符串 'YYYY-mm-dd HH:ii:ss'
Buffers 轉(zhuǎn)換為是6進(jìn)制字符串
Strings 不變
Arrays => ['a', 'b'] 轉(zhuǎn)換為 'a', 'b'
嵌套數(shù)組 [['a', 'b'], ['c', 'd']] 轉(zhuǎn)換為 ('a', 'b'), ('c', 'd')
Objects 轉(zhuǎn)換為 key = 'val' pairs. 嵌套對象轉(zhuǎn)換為字符串.
undefined / null ===> NULL
NaN / Infinity 不變. MySQL 不支持這些值, 除非有工具支持,否則插入這些值會引起錯誤.
轉(zhuǎn)換實例:
var post = {id: 1, title: 'Hello MySQL'};
var query = connection.query('INSERT INTO posts SET ?', post, function(err, result) {
// Neat!
});
console.log(query.sql); // INSERT INTO posts SET `id` = 1, `title` = 'Hello MySQL'
或者手動轉(zhuǎn)換
var query = "SELECT * FROM posts WHERE title=" + mysql.escape("Hello MySQL");
console.log(query); // SELECT * FROM posts WHERE title='Hello MySQL'
八、轉(zhuǎn)換查詢標(biāo)識符
如果不能信任SQL標(biāo)識符(數(shù)據(jù)庫名、表名、列名),可以使用轉(zhuǎn)換方法mysql.escapeId(identifier);
var sorter = 'date';
var query = 'SELECT * FROM posts ORDER BY ' + mysql.escapeId(sorter);
console.log(query); // SELECT * FROM posts ORDER BY `date`
支持轉(zhuǎn)義多個
var sorter = 'date';
var query = 'SELECT * FROM posts ORDER BY ' + mysql.escapeId('posts.' + sorter);
console.log(query); // SELECT * FROM posts ORDER BY `posts`.`date`
可以使用??作為標(biāo)識符的占位符
var userId = 1;
var columns = ['username', 'email'];
var query = connection.query('SELECT ?? FROM ?? WHERE id = ?', [columns, 'users', userId], function(err, results) {
// ...
});
console.log(query.sql); // SELECT `username`, `email` FROM `users` WHERE id = 1
九、準(zhǔn)備查詢
可以使用mysql.format來準(zhǔn)備查詢語句,該函數(shù)會自動的選擇合適的方法轉(zhuǎn)義參數(shù)。
var sql = "SELECT * FROM ?? WHERE ?? = ?";
var inserts = ['users', 'id', userId];
sql = mysql.format(sql, inserts);
10、自定義格式化函數(shù)
connection.config.queryFormat = function (query, values) {
if (!values) return query;
return query.replace(/\:(\w+)/g, function (txt, key) {
if (values.hasOwnProperty(key)) {
return this.escape(values[key]);
}
return txt;
}.bind(this));
};
connection.query("UPDATE posts SET title = :title", { title: "Hello MySQL" });
十、獲取插入行的id
當(dāng)使用自增主鍵時獲取插入行id,如:
connection.query('INSERT INTO posts SET ?', {title: 'test'}, function(err, result) {
if (err) throw err;
console.log(result.insertId);
});
十一、流處理
有時你希望選擇大量的行并且希望在數(shù)據(jù)到達(dá)時就處理他們,你就可以使用這個方法
var query = connection.query('SELECT * FROM posts');
query
.on('error', function(err) {
// Handle error, an 'end' event will be emitted after this as well
})
.on('fields', function(fields) {
// the field packets for the rows to follow
})
.on('result', function(row) {
// Pausing the connnection is useful if your processing involves I/O
connection.pause();
processRow(row, function() {
connection.resume();
});
})
.on('end', function() {
// all rows have been received
});
十二、混合查詢語句(多語句查詢)
因為混合查詢?nèi)菀妆籗QL注入攻擊,默認(rèn)是不允許的,可以使用var connection = mysql.createConnection({multipleStatements: true});開啟該功能。
混合查詢實例:
connection.query('SELECT 1; SELECT 2', function(err, results) {
if (err) throw err;
// `results` is an array with one element for every statement in the query:
console.log(results[0]); // [{1: 1}]
console.log(results[1]); // [{2: 2}]
});
同樣可以使用流處理混合查詢結(jié)果:
var query = connection.query('SELECT 1; SELECT 2');
query
.on('fields', function(fields, index) {
// the fields for the result rows that follow
})
.on('result', function(row, index) {
// index refers to the statement this result belongs to (starts at 0)
});
如果其中一個查詢語句出錯,Error對象會包含err.index指示錯誤語句的id,整個查詢也會終止。
混合查詢結(jié)果的流處理方式是做實驗性的,不穩(wěn)定。
十三、事務(wù)處理
connection級別的簡單事務(wù)處理
connection.beginTransaction(function(err) {
if (err) { throw err; }
connection.query('INSERT INTO posts SET title=?', title, function(err, result) {
if (err) {
connection.rollback(function() {
throw err;
});
}
var log = 'Post ' + result.insertId + ' added';
connection.query('INSERT INTO log SET data=?', log, function(err, result) {
if (err) {
connection.rollback(function() {
throw err;
});
}
connection.commit(function(err) {
if (err) {
connection.rollback(function() {
throw err;
});
}
console.log('success!');
});
});
});
});
十四、錯誤處理
err.code = string
err.fatal => boolean
PS:使用mysql模塊時遇到的坑
之前寫了個小程序Node News,用到了MySQL數(shù)據(jù)庫,在本地測試均沒神馬問題。放上服務(wù)器運行一段時間后,偶然發(fā)現(xiàn)打開頁面的時候頁面一直處于等待狀態(tài),直到Nginx返回超時錯誤。于是上服務(wù)器檢查了遍,發(fā)現(xiàn)程序仍然在運行,且能正確記錄每次的請求,再修改代碼跟蹤調(diào)試,原來是在查詢數(shù)據(jù)庫的時候,回調(diào)一直沒有被執(zhí)行,程序就掛在那里了。
想了很久也想不明白為神馬mysql模塊沒有執(zhí)行回調(diào),最后突然想起來去看了下錯誤日志,才發(fā)現(xiàn)有個“No reconnection after connection lost”錯誤沒有被捕捉到,原來是連接丟失了,上github上看了下文檔和issues,上面說到連接丟失后不會自動重新連接,會觸發(fā)error事件。我趕緊給程序添加了斷線后自動重連功能,現(xiàn)在已正常運行了10多天。
MySQL中有一個名叫wait_timeout的變量,表示操作超時時間,當(dāng)連接超過一定時間沒有活動后,會自動關(guān)閉該連接,這個值默認(rèn)為28800(即8小時)。
自動重連數(shù)據(jù)庫的代碼:
function handleError (err) {
if (err) {
// 如果是連接斷開,自動重新連接
if (err.code === 'PROTOCOL_CONNECTION_LOST') {
connect();
} else {
console.error(err.stack || err);
}
}
}
// 連接數(shù)據(jù)庫
function connect () {
db = mysql.createConnection(config);
db.connect(handleError);
db.on('error', handleError);
}
var db;
connect();
網(wǎng)上流傳的大多數(shù)使用mysql模塊的代碼,往往忽略了這個問題,一不小心就讓一撥又一撥的人往坑里踩了。
有童鞋回復(fù)問使用pool又會怎樣,于是去看了下mysql模塊的源碼:目前可在npm中安裝到的最新版本為2.0.0-alpha7,使用mysql.createPool()來創(chuàng)建的pool沒辦法自動處理連接被關(guān)閉的問題,但是在github上的版本已經(jīng)修復(fù)了(應(yīng)該還沒發(fā)布到npm上),當(dāng)觸發(fā)了connection的error事件時,會把該connection對象從連接池中移除。(源碼:https://github.com/felixge/node-mysql/blob/master/lib/Pool.js#L119 )
使用pool的代碼:
var mysql = require('mysql');
var pool = mysql.createPool(config);
pool.getConnection(function(err, connection) {
// Use the connection
connection.query( 'SELECT something FROM sometable', function(err, rows) {
// And done with the connection.
connection.end();
// Don't use the connection here, it has been returned to the pool.
});
});