IDBCursor

例項屬性

IDBCursor.source 只讀

返回遊標正在迭代的 IDBObjectStore 或 IDBIndex。即使遊標當前正在迭代、已迭代到末尾，或者其事務不活躍，此函式也永遠不會返回 null 或丟擲異常。

IDBCursor.direction 只讀

返回遊標的遍歷方向。

IDBCursor.key 只讀

返回遊標位置記錄的鍵。如果遊標超出了其範圍，則此值為 undefined。遊標的鍵可以是任何資料型別。

IDBCursor.primaryKey 只讀

返回遊標當前有效的首要鍵。如果遊標當前正在迭代或已迭代超出其範圍，則此值為 undefined。遊標的首要鍵可以是任何資料型別。

IDBCursor.request 只讀

返回用於獲取遊標的 IDBRequest。

例項方法

IDBCursor.advance()

設定遊標應向前移動其位置的次數。

IDBCursor.continue()

將遊標沿其方向移動到下一個位置，到鍵與可選的 key 引數匹配的項。

IDBCursor.continuePrimaryKey()

將遊標設定為給定的索引鍵和首要鍵（作為引數提供）。

IDBCursor.delete()

返回一個 IDBRequest 物件，並在單獨的執行緒中刪除遊標位置的記錄，而不改變遊標的位置。這可用於刪除特定記錄。

IDBCursor.update()

返回一個 IDBRequest 物件，並在單獨的執行緒中更新物件儲存中游標當前位置的值。這可用於更新特定記錄。

常量

• NEXT: "next" ：遊標顯示所有記錄，包括重複項。它從鍵範圍的下界開始，並向上移動（鍵順序單調遞增）。
• NEXTUNIQUE : "nextunique" ：遊標顯示所有記錄，但不包括重複項。如果存在具有相同鍵的多個記錄，則只檢索迭代到的第一個記錄。它從鍵範圍的下界開始，並向上移動。
• PREV: "prev" ：遊標顯示所有記錄，包括重複項。它從鍵範圍的上界開始，並向下移動（鍵順序單調遞減）。
• PREVUNIQUE: "prevunique" ：遊標顯示所有記錄，但不包括重複項。如果存在具有相同鍵的多個記錄，則只檢索迭代到的第一個記錄。它從鍵範圍的上界開始，並向下移動。

示例

在這個簡單的片段中，我們建立了一個事務，檢索了一個物件儲存，然後使用遊標遍歷物件儲存中的所有記錄。遊標不需要我們根據鍵選擇資料；我們可以直接獲取所有資料。另外請注意，在迴圈的每次迭代中，您可以使用 cursor.value.foo 從遊標物件下的當前記錄中獲取資料。有關完整的可執行示例，請參閱我們的 IDBCursor 示例（即時檢視示例）。

function displayData() {
  const transaction = db.transaction(["rushAlbumList"], "readonly");
  const objectStore = transaction.objectStore("rushAlbumList");

  objectStore.openCursor().onsuccess = (event) => {
    const cursor = event.target.result;
    if (cursor) {
      const listItem = document.createElement("li");
      listItem.textContent = `${cursor.value.albumTitle}, ${cursor.value.year}`;
      list.appendChild(listItem);

      cursor.continue();
    } else {
      console.log("Entries all displayed.");
    }
  };
}

規範

瀏覽器相容性

另見

• 使用 IndexedDB
• 開始事務：IDBDatabase
• 使用事務：IDBTransaction
• 設定鍵的範圍：IDBKeyRange
• 檢索和修改資料：IDBObjectStore
• 參考示例：待辦事項通知（即時檢視示例）。