IDBObjectStore: autoIncrement プロパティ

IDBObjectStore インターフェイスの読み取り専用プロパティ autoIncrement は、このオブジェクトストアのオートインクリメントフラグの値を返します。

なお、各オブジェクトストアにそれぞれ別のオートインクリメントカウンターがあります。

メモ: この機能はウェブワーカー内で利用可能です。

値

以下の論理値です。

値 意味
true オブジェクトストアはオートインクリメントを行います。
false オブジェクトストアはオートインクリメントを行いません。

例

以下のコード断片では、データベースの読み書きトランザクションを開き、add() を用いてデータをオブジェクトストアに追加します。オブジェクトストアの生成後、コンソールに objectStore.autoIncrement を記録します。動く例全体は、To-do Notifications アプリケーションを参照してください。(動く例を見る)

js
// データベースを開く
const DBOpenRequest = window.indexedDB.open("toDoList", 4);

DBOpenRequest.onsuccess = (event) => {
  note.innerHTML += "<li>データベースを初期化しました。</li>";

  // データベースを開いた結果を変数 db に格納する
  // これは後でよく使う
  db = DBOpenRequest.result;

  // addData() 関数を実行し、データをデータベースに追加する
  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.innerHTML += "<li>トランザクションが完了しました。</li>";
  };

  transaction.onerror = (event) => {
    note.innerHTML +=
      "<li>トランザクションはエラーのため開けませんでした。アイテムは重複させられません。</li>";
  };

  // トランザクション上でオブジェクトストアを生成する
  const objectStore = transaction.objectStore("toDoList");
  console.log(objectStore.autoIncrement);

  // オブジェクトストアに newItem オブジェクトを追加する要求を行う
  const objectStoreRequest = objectStore.add(newItem[0]);

  objectStoreRequest.onsuccess = (event) => {
    // 要求の成功を報告する
    note.innerHTML += "<li>要求に成功しました。</li>";
  };
}

仕様書

Specification
Indexed Database API 3.0
# ref-for-dom-idbobjectstore-autoincrement①

ブラウザーの互換性

BCD tables only load in the browser

関連情報