CKTIS / JavaScript
IndexedDB: een cursor uitlezen en verplaatsen met `value` en `continue()`
Lees de waarde van de huidige record via een IndexedDB-cursor en vraag vervolgens de volgende record op of spring verder met een sleutel.
Versie: ECMAScript 2024 and the current web platform; runtime support varies
Syntax
cursor.value // Read-only property of IDBCursorWithValue
cursor.continue() // Request the next eligible position; returns undefined
cursor.continue(key) // Request the next eligible position at or beyond key in the cursor's direction; returns undefinedIDBCursor.value/continue is een afkorting voor twee API-leden: de alleen-lezen eigenschap IDBCursorWithValue.value en de overgeërfde methode IDBCursor.continue(). Als een verzoek met openCursor() een cursor oplevert, geeft cursor.value de opgeslagen waarde van de huidige record. Velden van het opgehaalde object aanpassen slaat niets op. Gebruik daarvoor bijvoorbeeld cursor.update() in een readwrite-transactie. Een cursor uit openKeyCursor() heeft wel continue(), maar geen value.
cursor.continue() vraagt de volgende passende record in de cursorrichting op en retourneert undefined. cursor.continue(key) zoekt de eerste volgende positie met een sleutel >= key bij next of nextunique, of <= key bij prev of prevunique. De doelsleutel hoeft niet te bestaan en het oorspronkelijke bereik blijft gelden. Bij een object store wordt de primaire sleutel vergeleken; bij een index is dat de indexsleutel (cursor.key).
Lees request.result bij elk success-event van hetzelfde verzoek. null betekent dat er geen passende records zijn of dat de cursor het einde heeft bereikt. Lees de waarde en roep continue() hoogstens één keer aan voordat je de controle overdraagt aan een latere taak, zoals een timer-callback. Een ongeldige sleutel of een sleutel die niet strikt verderop ligt in de gekozen richting veroorzaakt DataError. Nogmaals aanroepen vóór het volgende resultaat, geen huidige positie hebben of een verwijderde bron kan InvalidStateError veroorzaken. Een inactieve transactie veroorzaakt TransactionInactiveError.
IndexedDB is een web-API en maakt geen deel uit van ECMAScript 2024. De beschikbaarheid hangt af van de runtime en context; toegang tot gegevens volgt het same-originbeleid.
Voorbeelden
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IndexedDB cursor example</title>
</head>
<body>
<script>
(() => {
const name = `cktis-cursor-${crypto.randomUUID()}`;
const open = indexedDB.open(name, 1);
open.onupgradeneeded = () => {
const store = open.result.createObjectStore('items');
store.add({ name: 'Ada' }, 1);
store.add({ name: 'Bo' }, 2);
store.add({ name: 'Lin' }, 4);
};
open.onerror = () => console.error(open.error);
open.onsuccess = () => {
const db = open.result;
const tx = db.transaction('items', 'readonly');
const request = tx.objectStore('items').openCursor();
const cleanup = () => {
db.close();
const deletion = indexedDB.deleteDatabase(name);
deletion.onerror = () => console.error(deletion.error);
};
tx.oncomplete = cleanup;
tx.onabort = () => {
console.error(tx.error);
cleanup();
};
request.onsuccess = () => {
const cursor = request.result;
if (cursor === null) {
console.log('Done');
return;
}
console.log(`${cursor.key}: ${cursor.value.name}`);
if (cursor.key === 1) {
cursor.continue(3);
} else {
cursor.continue();
}
};
};
})();
</script>
</body>
</html>Resultaat
1: Ada 4: Lin Done
Open dit HTML-document via HTTPS als pagina op het hoogste niveau in een browser waarin IndexedDB en `crypto.randomUUID()` beschikbaar zijn. Bekijk de uitvoer in de ontwikkelaarsconsole. Het voorbeeld maakt een aparte testdatabase en vraagt aan het eind om verwijdering. `continue(3)` slaat sleutel `2` over en komt uit bij `4`, omdat `3` ontbreekt. De volgende `continue()` geeft een resultaat van `null`, waarna de handler `Done` afdrukt.
Gerelateerde lessen
- JavaScript · Les 21 · Gemiddeld · Versie: 3
Bronnen
- IDBCursorWithValue: value property
- IDBCursor: continue() method
- IDBObjectStore: openCursor() method
- IDBIndex: openCursor() method
- IDBObjectStore: openKeyCursor() method
- IDBCursor: update() method
- IDBTransaction
- IndexedDB API
- Crypto: randomUUID() method
- IDBFactory: deleteDatabase() method
- ECMAScript 2024 Language Specification: Hosts and Implementations