CKTIS / JavaScript
IDBObjectStore — een IndexedDB-recordstore
IDBObjectStore biedt toegang tot IndexedDB-records via een aan een transactie gebonden verwijzing. Je kunt er gegevens mee toevoegen, vervangen, lezen, verwijderen en tellen, en secundaire indexen gebruiken.
Versie: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Syntax
const store = transaction.objectStore(name);
store.createIndex(name, keyPath, options); // upgrade transaction only
store.add(value, key); // key may be omitted
store.put(value, key); // key may be omitted
store.getAll(query, count); // query and count are optional
store.delete(query);
store.count(query); // query is optional
store.index(name);IDBObjectStore is een verwijzing naar een IndexedDB-recordstore die aan een specifieke transactie is gebonden. Elk record heeft een primaire sleutel en een waarde die via structured cloning wordt gekopieerd. keyPath: "id" haalt de sleutel uit het veld id; geef bij deze configuratie geen aparte sleutel mee aan add() of put().
add() voegt een record toe; een dubbele sleutel veroorzaakt ConstraintError. put() voegt een record toe of vervangt de volledige waarde bij een bestaande sleutel — velden worden niet samengevoegd. delete(query) verwijdert records op basis van de primaire sleutel of een sleutelbereik. Voor deze bewerkingen is een transactie nodig die schrijfbewerkingen toestaat. getAll(query?, count?) haalt waarden op, standaard gesorteerd op oplopende primaire sleutel; count(query?) telt overeenkomende records. Als je de query weglaat, geldt de bewerking voor de hele store.
createIndex(name, keyPath, options) maakt alleen een index aan tijdens een transactie voor een schema-upgrade, meestal in onupgradeneeded; unique: true dwingt unieke indexsleutels af. index(name) geeft een bestaande IDBIndex terug voor zoekopdrachten op basis van een secundaire sleutel. Beide methoden geven synchroon verwijzingen terug; de overige genoemde methoden geven IDBRequest terug, geen Promise.
Een geslaagde aanvraag betekent niet dat de transactie is vastgelegd: wacht op complete en handel abort af. Plan bewerkingen terwijl de transactie actief is; wachten op niet-gerelateerd asynchroon werk kan de transactie inactief maken. Het voorbeeld gebruikt API-vormen uit IndexedDB 2.0, zonder de nieuwere overload van getAll() met een optiesobject. Dit is een Web API en geen onderdeel van ECMAScript; Node 24 toont geen browserondersteuning aan. Controleer of indexedDB beschikbaar is in de doelomgeving.
Referentie-identificatoren die in dit item worden behandeld: IDBObjectStore.createIndex, IDBObjectStore.add, IDBObjectStore.getAll, IDBObjectStore.delete, IDBObjectStore.put, IDBObjectStore.count, IDBObjectStore.index.
Voorbeelden
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IDBObjectStore: working with records</title>
</head>
<body>
<h1>Working with an IndexedDB object store</h1>
<script>
(() => {
const name = 'cktis-store-' + crypto.getRandomValues(new Uint32Array(4)).join('-');
const report = error => console.log(error.name === 'SecurityError'
? 'IndexedDB unavailable: SecurityError' : `IndexedDB error: ${error.name}`);
let factory, opening;
try {
factory = window.indexedDB;
if (!factory) {
console.log('IndexedDB unavailable: API missing');
return;
}
opening = factory.open(name, 1);
} catch (error) {
report(error);
return;
}
let created = false;
opening.onerror = () => report(opening.error);
opening.onupgradeneeded = () => {
created = true;
const store = opening.result.createObjectStore('items', { keyPath: 'id' });
store.createIndex('byLabel', 'label', { unique: true });
};
opening.onsuccess = () => {
const db = opening.result;
if (!created) {
db.close();
console.log('Fixture name already in use');
return;
}
const tx = db.transaction('items', 'readwrite');
const store = tx.objectStore('items');
store.add({ id: 1, label: 'draft' });
store.add({ id: 2, label: 'spare' });
store.put({ id: 1, label: 'final' });
store.delete(2);
const all = store.getAll();
const count = store.count();
const indexed = store.index('byLabel').get('final');
const cleanup = () => {
db.close();
factory.deleteDatabase(name);
};
tx.oncomplete = () => {
console.log(JSON.stringify({ items: all.result, count: count.result, indexedId: indexed.result.id }));
cleanup();
};
tx.onabort = () => {
report(tx.error);
cleanup();
};
};
})();
</script>
</body>
</html>Resultaat
Successful browser run (IndexedDB access permitted):
{"items":[{"id":1,"label":"final"}],"count":1,"indexedId":1}
If the browser blocks IndexedDB access with a SecurityError, as in the isolated environment:
IndexedDB unavailable: SecurityErrorDe getoonde code en het opgegeven resultaat zijn in een geïsoleerde omgeving geverifieerd met de methode die in het verificatiebewijs voor exact deze versie is vastgelegd.