CKTIS / JavaScript
IndexedDB: vytvoření indexu, vložení, počítání a čtení záznamů
Vytvořte sekundární index, vkládejte záznamy bez přepsání a vyhledávejte podle primárního nebo indexového klíče.
Verze: ECMAScript 2024 and the current web platform; runtime support varies
Syntaxe
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 představuje úložiště objektů svázané s transakcí. Každý záznam má primární klíč a hodnotu. IndexedDB je webové API, nikoli součást ECMAScriptu; přístup se řídí zásadou stejného původu.
createIndex(name, keyPath, options) ihned vrací IDBIndex, ale lze jej volat pouze v aktivní transakci versionchange, obvykle v obsluze upgradeneeded. Cesta ke klíči určuje, odkud se získá klíč indexu; do záznamu nepřidává žádné pole. unique: true zakazuje duplicitní klíče indexu a multiEntry: true indexuje platné prvky pole jednotlivě. Obě volby mají výchozí hodnotu false. multiEntry: true nelze spojit se složenou cestou ke klíči zadanou jako pole cest.
add(value, key) uloží strukturovanou kopii a nový klíč poskytne v request.result. Pokud je klíč součástí hodnoty, druhý argument vynechte; u samostatného klíče bez generátoru jej zadejte. Duplicitní primární klíč nebo porušení jedinečnosti indexu způsobí chybu požadavku ConstraintError. Pro vložení nebo nahrazení podle primárního klíče použijte put().
count(query) dává číslo, zatímco getAll(query, count) dává pole kopií hodnot, prázdné bez shod. Obě metody přijímají primární klíč nebo IDBKeyRange a bez filtru zahrnují celé úložiště. Kladný count omezuje počet hodnot z getAll(). Výchozí pořadí je vzestupné podle primárního klíče. Novější varianta getAll({ query, count, direction }) umožňuje například "prev"; ověřte podporu v cílovém prohlížeči.
index(name) ihned vrátí existující IDBIndex ze stejné transakce. Neznámý název vyvolá NotFoundError; na velikosti písmen záleží. store.getAll("sci-fi") hledá podle primárního klíče, kdežto store.index("byGenre").getAll("sci-fi") vrátí hodnoty záznamů odpovídající klíči indexu.
add(), count() a getAll() vracejí IDBRequest, nikoli Promise. Čtěte result po success a ošetřete error. Zápis v běžné transakci vyžaduje režim readwrite. Požadavky zadávejte, dokud je transakce aktivní: čekání na jinou asynchronní operaci jí může umožnit skončit. Úspěch požadavku ještě nepotvrzuje transakci; vyčkejte na její událost complete.
Příklady
<!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>Výsledek
Added key: 3 Total: 3 All: Dunes, Herbs, Orbit Sci-fi: Dunes, Orbit
Zpřístupněte tento dokument HTML přes HTTPS, otevřete jej v prohlížeči a podívejte se do vývojářské konzole. Příklad vytvoří samostatnou dočasnou databázi a poté ji odstraní. Vloží tři knihy mimo pořadí primárních klíčů a po potvrzení transakce vypíše všechny názvy podle `id` i názvy vybrané indexem žánru.
Související lekce
- JavaScript · Lekce 21 · Středně pokročilá · Verze: 3
Zdroje
- 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