CKTIS / JavaScript
IndexedDB: odczyt i przesuwanie kursora za pomocą `value` i `continue()`
Odczytaj wartość bieżącego rekordu kursora IndexedDB, a następnie zażądaj przejścia do kolejnego rekordu lub do pozycji wyznaczonej przez klucz.
Wersja: ECMAScript 2024 and the current web platform; runtime support varies
Składnia
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 to skrót obejmujący dwa elementy API: właściwość tylko do odczytu IDBCursorWithValue.value i metodę IDBCursor.continue(), którą kursor z wartością dziedziczy. Gdy openCursor() zwróci kursor w wyniku żądania, cursor.value zawiera zapisaną wartość bieżącego rekordu. Zmiana pól odczytanego obiektu nie zapisuje zmian w bazie; do zapisu użyj np. cursor.update() w transakcji readwrite. Kursor z openKeyCursor() ma continue(), ale nie ma value.
Wywołanie cursor.continue() zleca przejście do następnego pasującego rekordu w ustalonym kierunku i zwraca undefined. Wariant cursor.continue(key) przechodzi do pierwszej następnej pozycji z kluczem >= key dla next lub nextunique, albo <= key dla prev lub prevunique. Klucz docelowy nie musi istnieć, a pierwotny zakres nadal obowiązuje. W magazynie obiektów porównywany jest klucz główny, a w indeksie — klucz indeksu (cursor.key).
Obsłuż każdy wynik request.result w zdarzeniu success tego samego żądania: null oznacza, że nie ma pasujących rekordów lub że iteracja dobiegła końca. Odczytaj wartość i wywołaj continue() co najwyżej raz, zanim oddasz sterowanie, np. do wywołania zwrotnego timera. Nieprawidłowy klucz lub klucz nieleżący ściśle dalej w kierunku iteracji powoduje DataError. Ponowne przesunięcie przed otrzymaniem wyniku, brak bieżącej pozycji lub usunięcie źródła może spowodować InvalidStateError; nieaktywna transakcja powoduje TransactionInactiveError.
IndexedDB to API platformy webowej, a nie część ECMAScript 2024. Dostępność zależy od środowiska wykonawczego i kontekstu; dostęp do danych podlega zasadzie tego samego pochodzenia.
Przykłady
<!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>Wynik
1: Ada 4: Lin Done
Otwórz ten dokument HTML przez HTTPS jako stronę najwyższego poziomu w przeglądarce, w której dostępne są IndexedDB i `crypto.randomUUID()`. Wynik zobaczysz w konsoli deweloperskiej. Przykład tworzy osobną bazę testową i po zakończeniu zleca jej usunięcie. `continue(3)` pomija klucz `2` i trafia na `4`, ponieważ klucza `3` nie ma. Następne `continue()` prowadzi do wyniku `null` i wypisania `Done`.
Powiązane lekcje
- JavaScript · Lekcja 21 · Średniozaawansowany · Wersja: 3
Źródła
- 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