CKTIS / JavaScript
IndexedDB: tworzenie indeksu, dodawanie, zliczanie i odczyt rekordów
Utwórz indeks pomocniczy, dodawaj rekordy bez nadpisywania i odczytuj dane według klucza głównego lub klucza indeksu.
Wersja: ECMAScript 2024 and the current web platform; runtime support varies
Składnia
store.createIndex(name, keyPath)
store.createIndex(name, keyPath, options)
store.count()
store.count(query)
store.add(value)
store.add(value, key)
store.getAll()
store.getAll(query)
store.getAll(query, count)
store.getAll(options)
store.index(name)IDBObjectStore reprezentuje magazyn obiektów powiązany z transakcją. Każdy rekord ma klucz główny i wartość. IndexedDB to interfejs platformy WWW, a nie część ECMAScript; dostęp do bazy podlega zasadzie tego samego źródła.
createIndex(name, keyPath, options) od razu zwraca IDBIndex, ale wolno go wywołać tylko w aktywnej transakcji versionchange, zwykle w obsłudze upgradeneeded. Ścieżka klucza wskazuje, skąd pobrać klucz indeksu; nie dodaje pola do rekordu. unique: true zabrania powtarzania kluczy indeksu, a multiEntry: true indeksuje poprawne elementy tablicy osobno. Obie opcje domyślnie mają wartość false. multiEntry: true nie działa ze złożoną ścieżką klucza podaną jako tablica ścieżek.
add(value, key) zapisuje strukturalną kopię wartości i daje klucz nowego rekordu w request.result. Przy kluczu zapisanym w wartości nie podawaj drugiego argumentu; przy kluczu przechowywanym osobno, bez generatora, musisz go podać. Powtórzony klucz główny lub naruszenie unikalności indeksu powoduje błąd żądania ConstraintError. Do wstawiania lub zastępowania według klucza głównego służy put().
count(query) zwraca przez żądanie liczbę rekordów, a getAll(query, count) — tablicę kopii wartości, pustą przy braku dopasowań. Obie metody przyjmują klucz główny lub IDBKeyRange i bez filtra obejmują cały magazyn. Dodatni count w getAll() ogranicza liczbę wyników. Domyślna kolejność jest rosnąca według klucza głównego. Nowszy wariant getAll({ query, count, direction }) pozwala wybrać np. "prev"; sprawdź obsługę w docelowej przeglądarce.
index(name) od razu zwraca istniejący IDBIndex z tej samej transakcji. Jeśli nazwa nie istnieje, zgłasza NotFoundError; wielkość liter ma znaczenie. store.getAll("sci-fi") szuka według klucza głównego, a store.index("byGenre").getAll("sci-fi") zwraca wartości rekordów pasujących według klucza indeksu.
add(), count() i getAll() zwracają IDBRequest, nie Promise. Odczytuj result po success i obsługuj error. W zwykłej transakcji zapis wymaga trybu readwrite. Kolejkuj żądania, gdy transakcja jest aktywna: oczekiwanie na operację niezwiązaną z IndexedDB może sprawić, że transakcja zdąży się zakończyć. Sukces żądania nie oznacza zatwierdzenia zapisu — potwierdza je dopiero complete transakcji.
Przykłady
<!doctype html>
<meta charset="utf-8">
<title>IndexedDB object store methods</title>
<script>
(() => {
const dbName = `cktis-books-${crypto.randomUUID()}`;
const open = indexedDB.open(dbName, 1);
open.onupgradeneeded = () => {
const store = open.result.createObjectStore('books', { keyPath: 'id' });
store.createIndex('byGenre', 'genre');
};
open.onerror = () => console.error(open.error);
open.onsuccess = () => {
const db = open.result;
const tx = db.transaction('books', 'readwrite');
const store = tx.objectStore('books');
const cleanup = () => {
db.close();
const deletion = indexedDB.deleteDatabase(dbName);
deletion.onerror = () => console.error(deletion.error);
};
tx.onabort = () => {
console.error(tx.error);
cleanup();
};
const added = store.add({ id: 3, title: 'Orbit', genre: 'sci-fi' });
store.add({ id: 1, title: 'Dunes', genre: 'sci-fi' });
store.add({ id: 2, title: 'Herbs', genre: 'guide' });
const total = store.count();
const all = store.getAll();
const matches = store.index('byGenre').getAll('sci-fi');
tx.oncomplete = () => {
const titles = (request) => request.result.map((book) => book.title).join(', ');
console.log(`Added key: ${added.result}`);
console.log(`Total: ${total.result}`);
console.log(`All: ${titles(all)}`);
console.log(`Sci-fi: ${titles(matches)}`);
cleanup();
};
};
})();
</script>Wynik
Added key: 3 Total: 3 All: Dunes, Herbs, Orbit Sci-fi: Dunes, Orbit
Udostępnij dokument HTML przez HTTPS, otwórz go w przeglądarce i sprawdź jej konsolę. Przykład tworzy osobną bazę tymczasową i usuwa ją po użyciu. Zapisuje trzy książki poza kolejnością kluczy głównych, a po zatwierdzeniu wypisuje wszystkie tytuły według `id` oraz tytuły wybrane przez indeks gatunku.
Powiązane lekcje
- JavaScript · Lekcja 21 · Średniozaawansowany · Wersja: 3
Źródła
- IDBObjectStore: createIndex() method
- IDBObjectStore: count() method
- IDBObjectStore: add() method
- IDBObjectStore: getAll() method
- IDBObjectStore: index() method
- IDBIndex: getAll() method
- IDBTransaction
- IDBTransaction: complete event
- IndexedDB key characteristics and basic terminology
- Using IndexedDB
- Crypto: randomUUID() method