IDBTransaction
Baseline
広く利用可能
*
この機能は広く実装されており、多くのバージョンの端末やブラウザーで動作します。2015年7月以降、すべてのブラウザーで利用可能です。
* この機能の一部は、対応レベルにばらつきがある場合があります。
メモ: この機能はウェブワーカー内で利用可能です。
IDBTransaction は IndexedDB API のインターフェイスで、イベントハンドラー属性を使って、データベース上の静的かつ非同期なトランザクションを提供します。すべてのデータの読み書きはトランザクション内で行われます。IDBDatabase を使ってトランザクションを開始し、IDBTransaction でトランザクションのモード (例: readonly または readwrite) を設定します。また、IDBObjectStore にアクセスしてリクエストを作成します。IDBTransaction オブジェクトを使ってトランザクションを中止することもできます。
トランザクションは、最初のリクエストが発行された時ではなく、トランザクションが生成されたときに開始します。例えば、次のものを考えてください。
const trans1 = db.transaction("foo", "readwrite");
const trans2 = db.transaction("foo", "readwrite");
const objectStore2 = trans2.objectStore("foo");
const objectStore1 = trans1.objectStore("foo");
objectStore2.put("2", "key");
objectStore1.put("1", "key");
このコードが実行された後で、オブジェクトストアには "2" が含まれているはずであり、これは trans2 が trans1 の後に実行されるからです。
トランザクションは、イベントループのタスク間でアクティブ状態と非アクティブ状態を交互に取ります。作成されたタスクと、リクエストの success または error イベントハンドラーを実行する各タスクではアクティブです。それ以外のタスクでは非アクティブで、その間にリクエストを発行すると失敗します。トランザクションがアクティブな間に新しいリクエストが発行されず、ほかに未処理のリクエストもなければ、トランザクションは自動的にコミットされます。
トランザクションの失敗
トランザクションは決まった数の理由で失敗することがあり(ユーザーエージェントのクラッシュを除く)、いずれの場合も abort コールバックを起動します。
- 不正な要求による失敗。例えば、
add()で同じキーを 2 回追加しようとしたり、put()で一意性制約に反して同じインデックスキーを追加しようとした場合。これは要求のエラーを起こし、このエラーはトランザクションのエラーとして伝搬し、これによりトランザクションがアボートします。これは、要求のerrorイベントでpreventDefault()を用いることで回避できます。 - スクリプトによる明示的な
abort()の呼び出し。 - 要求の
success/errorハンドラー内で捕捉されない例外。 - I/O エラー (ディスクへの書き込みの失敗や、他の OS / ハードウェアのエラーなど)
- 制限の超過。
- ユーザーエージェントのクラッシュ。
Firefox における永続性の保証
Firefox 40 以降、IndexedDB のトランザクションはパフォーマンスを向上させるために永続性の保証が緩くなりました。(Firefox バグ 1112702 を参照してください) これまでは、readwrite のトランザクションでは complete イベントはすべてのデータがディスクに書き込まれたことが保証されてから発生していました。Firefox 40 以降では、complete イベントは OS にデータの書き込みを指示した後に発生しますが、データが実際にディスクに書き込まれる前である可能性があります。complete イベントは以前より早く通知されますが、データがディスクに書き込まれる前にシステムの電源が失われたり、OS がクラッシュしたりすると、わずかながらトランザクション全体が失われる可能性があります。このような壊滅的な事象はほとんど起こらないため、ほとんどの利用者は心配しなくていいでしょう。
何らかの理由で永続性を保証する必要がある場合 (たとえば、後で再計算できない重要なデータを保存しようとしている場合) 実験的な (標準でない) readwriteflush モードを利用してトランザクションを生成することで、complete イベントを通知する前にディスクへ書き込むことを強制することができます。(IDBDatabase.transaction を参照してください)
インスタンスプロパティ
IDBTransaction.db読取専用-
このトランザクションが紐づいているデータベースへの接続です。
IDBTransaction.durability読取専用-
トランザクションの作成時に指定された耐久性のヒントを返します。
IDBTransaction.error読取専用-
トランザクションが失敗したとき、発生したエラーの種類を表す
DOMExceptionを返します。トランザクションが完了していないとき、完了して正常にコミットしたとき、IDBTransaction.abort()関数によりアボートされたときはnullです。 IDBTransaction.mode読取専用-
トランザクションの対象のオブジェクトストア内のデータへのアクセスを隔離するためのモードです。デフォルト値は
readonlyです。 IDBTransaction.objectStoreNames読取専用-
トランザクションに関連付いた
IDBObjectStoreの名前を格納したDOMStringListを返します。
インスタンスメソッド
EventTarget から継承します。
IDBTransaction.abort()-
このトランザクションに関連付いたデータベース内のオブジェクトへの変更をロールバックします。このトランザクションがアボート済または完了済のときは、このメソッドは
errorイベントを発生させます。 IDBTransaction.objectStore()-
このトランザクションの対象に含まれるオブジェクトストアを表す
IDBObjectStoreオブジェクトを返します。 IDBTransaction.commit()-
進行中のトランザクションをコミットします。なお、このメソッドは通常呼ばれる 必要 はありません。進行中の要求が全て満たされ、新しい要求がなされなかったとき、トランザクションは自動的にコミットされます。
commit()は、進行中の要求からのイベントが処理されるのを待たずにコミット処理を開始するために使用できます。
イベント
addEventListener() を用いるか、このインターフェイスの oneventname プロパティにイベントリスナーを代入することにより、これらのイベントをリッスンします。
abort-
IndexedDBのトランザクションがアボートされたときに発生します。onabortプロパティからも利用でき、このイベントはIDBDatabaseにバブリングします。 complete-
トランザクションが正常に完了したときに発生します。
oncompleteプロパティからも利用できます。 error-
リクエストがエラーを返し、イベントがデータベース接続オブジェクト (
IDBDatabase) にバブリングしたときに発生します。onerrorプロパティからも利用できます。
モード定数
警告: これらの定数はもう利用可能ではありません。Gecko 25 で削除されました。かわりに、これらの文字列定数を直接使用するべきです。(Firefox バグ 888598)
トランザクションはこれらの 3 種類のモードのうち 1 個を持つことができます。
| 定数 | 値 | 説明 |
|---|---|---|
READ_ONLY
|
"readonly" (Chrome では 0) | データを読み取れますが、変更はできません。 |
READ_WRITE
|
"readwrite" (Chrome では 1) | 既存のデータストア内のデータを読み書きできます。 |
VERSION_CHANGE
|
"versionchange" (Chrome では 2) | オブジェクトストアやインデックスの作成・削除など、任意の操作ができます。 このモードのトランザクションは他のトランザクションと並行して実行できません。 このモードのトランザクションは「アップグレードトランザクション」と呼ばれます。 |
これらの定数は非推奨ですが、必要であれば後方互換性のために使用できます。オブジェクトが利用できなくなる場合に備え、以下のように保守的なコードを書くべきです。
const myIDBTransaction = window.IDBTransaction ||
window.webkitIDBTransaction || { READ_WRITE: "readwrite" };
例
次のコードスニペットでは、データベース上で読み書きトランザクションを開き、オブジェクトストアにデータを追加します。また、トランザクションの成功または失敗を知らせるため、トランザクションのイベントハンドラーに関数を割り当てている点にも注目してください。完全な動作例については、To-do Notifications アプリ (動作例を見る) を参照してください。
const note = document.getElementById("notifications");
// IDB データを保存するデータベースオブジェクト
let db;
// データベースを開く
const DBOpenRequest = window.indexedDB.open("toDoList", 4);
DBOpenRequest.onsuccess = (event) => {
note.appendChild(document.createElement("li")).textContent =
"Database initialized.";
// データベースを開いた結果を db に保存
// 以下で頻繁に使用
db = DBOpenRequest.result;
// データベースにデータを追加
addData();
};
function addData() {
// IDB に挿入するオブジェクトを作成
const newItem = [
{
taskTitle: "Walk dog",
hours: 19,
minutes: 30,
day: 24,
month: "December",
year: 2013,
notified: "no",
},
];
// 読み書きトランザクションを開いてデータ追加の準備
const transaction = db.transaction(["toDoList"], "readwrite");
// トランザクション開始の成功を報告
transaction.oncomplete = (event) => {
note.appendChild(document.createElement("li")).textContent =
"トランザクション完了 : データベースの変更が完了しました。";
};
transaction.onerror = (event) => {
note.appendChild(document.createElement("li")).textContent =
"トランザクションはエラーのため開けませんでした。重複するアイテムは許されません。";
};
// トランザクションにオブジェクトストアを作成
const objectStore = transaction.objectStore("toDoList");
// newItem をオブジェクトストアに追加
const objectStoreRequest = objectStore.add(newItem[0]);
objectStoreRequest.onsuccess = (event) => {
// リクエストの成功を報告 (DB への保存成功を意味するわけではない)
// 保存確認には transaction.oncomplete が必要
note.appendChild(document.createElement("li")).textContent =
"Request successful.";
};
}
仕様書
| 仕様書 |
|---|
| Indexed Database API 3.0> # transaction> |
ブラウザーの互換性
関連情報
- IndexedDB の使用
- トランザクションの開始 :
IDBDatabase - キーの範囲の設定 :
IDBKeyRange - データの受け取りや変更 :
IDBObjectStore - カーソルの使用 :
IDBCursor - リファレンスの例 : To-do Notifications (動く例を見る)