CKTIS / JavaScript
IndexedDB: een index maken en records toevoegen, tellen en lezen
Maak een secundaire index, voeg records toe zonder ze te overschrijven en zoek op primaire sleutel of indexsleutel.
Versie: ECMAScript 2024 and the current web platform; runtime support varies
Syntax
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)Een IDBObjectStore is een objectopslag die aan een transactie is gekoppeld. Elk record heeft een primaire sleutel en een waarde. IndexedDB is een web-API, geen onderdeel van ECMAScript; de toegang volgt het same-originbeleid.
createIndex(name, keyPath, options) geeft meteen een IDBIndex terug, maar kan alleen in een actieve versionchange-transactie worden aangeroepen, meestal in upgradeneeded. Het sleutelpad bepaalt waar de indexsleutel vandaan komt; het voegt geen veld toe. unique: true verbiedt dubbele indexsleutels, terwijl multiEntry: true geldige array-elementen afzonderlijk indexeert. Beide zijn standaard false. multiEntry: true kan niet worden gecombineerd met een samengesteld sleutelpad dat als array van paden is opgegeven.
add(value, key) slaat een gestructureerde kopie op en geeft de nieuwe sleutel in request.result. Laat het tweede argument weg als de sleutel in de waarde zit; geef het op als de sleutel apart wordt opgeslagen en er geen sleutelgenerator is. Een dubbele primaire sleutel of een schending van een unieke index laat het verzoek mislukken met ConstraintError. Gebruik put() om op primaire sleutel in te voegen of te vervangen.
count(query) geeft een getal; getAll(query, count) geeft een array met kopieën van waarden, leeg als niets overeenkomt. Beide accepteren een primaire sleutel of IDBKeyRange en doorzoeken zonder filter de hele opslag. Een positieve count beperkt het aantal waarden uit getAll(). De standaardvolgorde is oplopend op primaire sleutel. De nieuwere vorm getAll({ query, count, direction }) ondersteunt bijvoorbeeld "prev"; controleer de ondersteuning in je doelbrowser.
index(name) geeft meteen een bestaande IDBIndex uit dezelfde transactie terug. Een onbekende naam veroorzaakt NotFoundError; hoofdletters en kleine letters tellen mee. store.getAll("sci-fi") zoekt op primaire sleutel, terwijl store.index("byGenre").getAll("sci-fi") recordwaarden selecteert op indexsleutel.
add(), count() en getAll() geven een IDBRequest terug, geen Promise. Lees result na success en handel error af. In een gewone transactie vereist schrijven readwrite. Zet verzoeken in de wachtrij terwijl de transactie actief is: wachten op ander asynchroon werk kan haar laten eindigen. Een geslaagd verzoek betekent nog geen commit; wacht op het complete-event van de transactie.
Voorbeelden
<!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>Resultaat
Added key: 3 Total: 3 All: Dunes, Herbs, Orbit Sci-fi: Dunes, Orbit
Bied dit HTML-document aan via HTTPS, open het in een browser en bekijk de ontwikkelaarsconsole. Het voorbeeld maakt een aparte tijdelijke database en verwijdert die achteraf. Het voegt drie boeken toe buiten de volgorde van hun primaire sleutels en toont na de commit alle titels op `id` en de titels die via de genre-index zijn geselecteerd.
Gerelateerde lessen
- JavaScript · Les 21 · Gemiddeld · Versie: 3
Bronnen
- 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