CKTIS / JavaScript
IndexedDB: tworzenie indeksu, wstawianie rekordu i odczyt przez indeks
Utwórz indeks podczas zmiany wersji bazy, wstaw rekord bez nadpisywania i wyszukaj go po kluczu indeksu zamiast po kluczu głównym.
Wersja: Current web platform; runtime support varies
Składnia
store.createIndex(name, keyPath)
store.createIndex(name, keyPath, { unique, multiEntry })
store.add(value)
store.add(value, key)
store.index(name)createIndex(), add() i index() to metody instancji IDBObjectStore w IndexedDB, a nie elementy ECMAScript. IndexedDB przestrzega zasady tego samego pochodzenia (same-origin); dostęp zależy też od środowiska wykonawczego i ustawień pamięci przeglądarki.
store.createIndex(name, keyPath, options) od razu zwraca IDBIndex, ale zmiana schematu utrwala się dopiero po zatwierdzeniu transakcji. Wywołaj tę metodę w aktywnej transakcji versionchange, zwykle w obsłudze upgradeneeded podczas tworzenia bazy lub podnoszenia jej wersji. Nazwa identyfikuje indeks, a ścieżka klucza określa, skąd w rekordzie pobrać klucz indeksu; nie dodaje pola do rekordu. IndexedDB indeksuje istniejące rekordy i automatycznie aktualizuje indeks.
unique i multiEntry mają domyślnie wartość false. Opcja unique: true zabrania powtarzania kluczy indeksu między rekordami; istniejące duplikaty mogą przerwać aktualizację. multiEntry: true indeksuje poszczególne poprawne elementy wartości tablicowej zamiast całej tablicy jako jednego klucza. Nie można łączyć tej opcji z tablicą ścieżek tworzących klucz złożony (InvalidAccessError). Zajęta nazwa indeksu powoduje natychmiastowy ConstraintError.
store.add(value[, key]) wstawia klon strukturalny bez nadpisywania. Wymaga aktywnej transakcji readwrite lub versionchange. Przy kluczu głównym zapisanym w wartości nie przekazuj argumentu key; przy kluczu zewnętrznym bez generatora musisz go podać. Sukces żądania IDBRequest daje klucz główny w result, ale zatwierdzenie potwierdza dopiero complete transakcji. Konflikt klucza głównego lub unikatowego klucza indeksu zgłasza ConstraintError przez żądanie; put() może zastąpić rekord, lecz także musi przestrzegać unikatowości indeksu.
store.index(name) zwraca istniejący IDBIndex powiązany z tą samą transakcją. Nie tworzy indeksu ani nie czyta rekordu. Brak pasującej nazwy (z uwzględnieniem wielkości liter) powoduje NotFoundError. W aktywnej transakcji index.get(key) zleca wyszukanie pierwszego pasującego rekordu po kluczu indeksu, nie po kluczu głównym. Nie używaj tego uchwytu do odczytu po zakończeniu transakcji.
Przykłady
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IndexedDB: insert and look up a contact</title>
</head>
<body>
<script>
(async () => {
const { indexedDB, crypto } = window;
const name = `cktis-index-${crypto.randomUUID()}`;
const resultOf = (request) => new Promise((resolve, reject) => {
request.onsuccess = () => resolve(request.result);
request.onerror = () => reject(request.error);
});
const committed = (tx) => new Promise((resolve, reject) => {
tx.oncomplete = () => resolve();
tx.onabort = () => reject(tx.error ?? new Error('Transaction aborted'));
});
const open = indexedDB.open(name, 1);
open.onupgradeneeded = () => {
const store = open.result.createObjectStore('contacts', { keyPath: 'id' });
store.createIndex('byEmail', 'email', { unique: true });
};
const db = await resultOf(open);
let contact;
try {
const write = db.transaction('contacts', 'readwrite');
write.objectStore('contacts').add({ id: 7, email: 'ada@example.test' });
await committed(write);
const read = db.transaction('contacts', 'readonly');
const lookup = read.objectStore('contacts').index('byEmail').get('ada@example.test');
await committed(read);
contact = lookup.result;
} finally {
db.close();
await resultOf(indexedDB.deleteDatabase(name));
}
console.log(JSON.stringify(contact));
})().catch((error) => console.error(error));
</script>
</body>
</html>Wynik
{"id":7,"email":"ada@example.test"}Udostępnij plik HTML pod zaufanym adresem HTTPS i otwórz go w przeglądarce z dostępem do IndexedDB i `crypto.randomUUID()`. Przykład tworzy osobną bazę, po zatwierdzeniu zapisu wyszukuje rekord po `email`, a następnie zamyka i usuwa bazę przed wypisaniem wyniku w konsoli przeglądarki.
Powiązane lekcje
- JavaScript · Lekcja 31 · Zaawansowany · Wersja: 4