Web SQL 資料庫 API 其實並未包含在 HTML5 規範之中,它是一份獨立規範,引入了一套以 SQL 操作客戶端資料庫的 API。如果你是一名優秀的 Web 開發者,理應對 SQL 與資料庫概念已經很熟悉;若不熟悉,建議先補一補 SQL 基礎再往下讀。
當時最新版本的 Chrome、Safari 與 Opera 瀏覽器都支援 Web SQL 資料庫。
一、openDatabase:使用既有資料庫或建立新資料庫,取得資料庫物件。
二、transaction:讓我們能依情況控制交易提交或回滾。
三、executeSql:執行真正的 SQL 查詢。
openDatabase 會開啟一個已存在的資料庫;若不存在,則順手建立。語法如下:
var db = openDatabase('mydb', '1.0', 'Test DB', 2 * 1024 * 1024);
這裡用到了五個參數:資料庫名(mydb)、版本號(1.0)、描述(Test DB)、資料庫大小(2MB)、以及建立回呼。
最後一個參數「建立回呼」會在資料庫被建立時呼叫;但即使不提供它,一樣可以在執行時順利建立資料庫。
執行查詢使用 db.transaction(),它只需要一個參數:
var db = openDatabase('mydb', '1.0', 'Test DB', 2 * 1024 * 1024);
db.transaction(function (tx) {
tx.executeSql('CREATE TABLE IF NOT EXISTS LOGS (id unique, log)');
});
這段查詢會在 mydb 資料庫中建立一個 LOGS 表。
在同一個交易中追加 SQL 即可插入新記錄:
var db = openDatabase('mydb', '1.0', 'Test DB', 2 * 1024 * 1024);
db.transaction(function (tx) {
tx.executeSql('CREATE TABLE IF NOT EXISTS LOGS (id unique, log)');
tx.executeSql('INSERT INTO LOGS (id, log) VALUES (1, "foobar")');
tx.executeSql('INSERT INTO LOGS (id, log) VALUES (2, "logmsg")');
});
若要插入動態值,可用問號佔位並傳入參數陣列:
db.transaction(function (tx) {
tx.executeSql('INSERT INTO LOGS (id, log) VALUES (?, ?)', [e_id, e_log]);
});
這裡的 e_id 與 e_log 是外部變數,executeSql 會把陣列中的每個項目依序對應到問號。
讀取既有記錄時,透過回呼函數捕獲結果:
db.transaction(function (tx) {
tx.executeSql('SELECT * FROM LOGS', [], function (tx, results) {
var len = results.rows.length, i;
msg = "<p>Found rows: " + len + "</p>";
document.querySelector('#status').innerHTML += msg;
for (i = 0; i < len; i++){
alert(results.rows.item(i).log);
}
}, null);
});
把前面內容放進一份完整的 HTML5 文件裡:
<!DOCTYPE html>
<html>
<head>
<script type="text/javascript">
var db = openDatabase('mydb', '1.0', 'Test DB', 2 * 1024 * 1024);
var msg;
db.transaction(function (tx) {
tx.executeSql('CREATE TABLE IF NOT EXISTS LOGS (id unique, log)');
tx.executeSql('INSERT INTO LOGS (id, log) VALUES (1, "foobar")');
tx.executeSql('INSERT INTO LOGS (id, log) VALUES (2, "logmsg")');
msg = '<p>Log message created and row inserted.</p>';
document.querySelector('#status').innerHTML = msg;
});
db.transaction(function (tx) {
tx.executeSql('SELECT * FROM LOGS', [], function (tx, results) {
var len = results.rows.length, i;
msg = "<p>Found rows: " + len + "</p>";
document.querySelector('#status').innerHTML += msg;
for (i = 0; i < len; i++){
msg = "<p><b>" + results.rows.item(i).log + "</b></p>";
document.querySelector('#status').innerHTML += msg;
}
}, null);
});
</script>
</head>
<body>
<div id="status" name="status">Status Message</div>
</body>
</html>
在最新版本的 Safari 或 Opera 中執行,輸出結果如下:
Log message created and row inserted.
Found rows: 2
foobar
logmsg
實務上要提醒的是:Web SQL Database 這份規範後來的推進並不順利,主流觀點逐漸轉向 IndexedDB。因此新專案若要以 HTML5 做客戶端資料儲存,建議優先評估 IndexedDB,Web SQL 則適合作為既有系統的維護對象。