Baza wiedzyCentrum egzaminacyjne
PLPolski
Wybierz język13

CKTIS / JavaScript

IDBCursor — iterowanie po rekordach IndexedDB

IDBCursor pozwala odczytywać rekordy IndexedDB kolejno według kluczy. Kursor z wartością udostępnia cursor.value, a cursor.continue() asynchronicznie przechodzi do następnego rekordu.

Wersja: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Składnia

const request = store.openCursor();
request.onsuccess = () => {
  const cursor = request.result;
  if (!cursor) return;
  const value = cursor.value;
  cursor.continue();
};

IDBCursor reprezentuje pozycję podczas przeglądania magazynu obiektów lub indeksu IndexedDB. openCursor() zwraca IDBRequest, nie kursor. Odczytuj request.result w onsuccess; brak kursora kończy iterację. Domyślny kierunek next oznacza rosnącą kolejność kluczy, nie kolejność zapisu.

Nazwa IDBCursor.value jest skrótem opisowym: właściwość value jest zdefiniowana w interfejsie IDBCursorWithValue, który dziedziczy po IDBCursor. openCursor() udostępnia taki kursor; openKeyCursor() nie udostępnia value. Zmiana obiektu zwróconego przez cursor.value nie zapisuje zmian w bazie; do zapisu służy update() w transakcji readwrite.

IDBCursor.continue, wywoływane jako cursor.continue(), zleca następny krok i zwraca undefined, nie Promise. Wynik pojawia się w kolejnym zdarzeniu success tego samego żądania. Wywołuj metodę raz na krok w aktywnej transakcji: ponowne wywołanie przed wynikiem powoduje InvalidStateError, a nieaktywna transakcja — TransactionInactiveError. Nie czekaj między krokami na niezależne operacje asynchroniczne.

To Web API, nie część ECMAScript; obecność Node 24 nie potwierdza obsługi. Opisane operacje są określone w Indexed Database API 2.0 i 3.0. Sprawdź obsługę oraz dostępność magazynu w docelowej przeglądarce.

Przykłady

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Iterating records with IDBCursor</title>
</head>
<body>
<script>
  (() => {
    // This disposable name does not require a secure-context API.
    const name = `cktis-cursor-${Date.now()}-${Math.random()}`;
    const unavailable = () => console.log('IndexedDB unavailable in this context.');
    let open;
    try {
      open = indexedDB.open(name, 1);
    } catch {
      unavailable();
      return;
    }
    open.onerror = unavailable;
    open.onupgradeneeded = () => {
      const store = open.result.createObjectStore('items');
      store.put('Beta', 2);
      store.put('Alpha', 1);
    };
    open.onsuccess = () => {
      const db = open.result;
      const rows = [];
      const tx = db.transaction('items', 'readonly');
      const request = tx.objectStore('items').openCursor();
      request.onsuccess = () => {
        const cursor = request.result;
        if (cursor === null) return;
        rows.push(`${cursor.key}: ${cursor.value}`);
        cursor.continue();
      };
      function cleanup() {
        db.close();
        indexedDB.deleteDatabase(name);
      }
      tx.oncomplete = () => {
        for (const row of rows) console.log(row);
        cleanup();
      };
      tx.onabort = () => {
        cleanup();
        console.log('Cursor transaction aborted.');
      };
    };
  })();
</script>
</body>
</html>

Wynik

1: Alpha
2: Beta

Po udanej iteracji przykład wypisuje w konsoli `1: Alpha`, a następnie `2: Beta`. Jeśli nie można otworzyć bazy IndexedDB, przykład wypisuje `IndexedDB unavailable in this context.` i nie otwiera kursora.

Źródła