CKTIS / JavaScript
IDBObjectStore — ein IndexedDB-Datenspeicher
IDBObjectStore stellt IndexedDB-Datensätze über einen an eine Transaktion gebundenen Handle bereit. Damit lassen sich Daten hinzufügen, ersetzen, lesen, löschen und zählen sowie Sekundärindizes verwenden.
Version: 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 ist ein Handle für einen IndexedDB-Datenspeicher, das an eine bestimmte Transaktion gebunden ist. Jeder Datensatz hat einen Primärschlüssel und einen Wert, der mittels Structured Cloning kopiert wird. keyPath: "id" verwendet den Wert im Feld id als Schlüssel. Bei dieser Konfiguration darfst du an add() oder put() keinen separaten Schlüssel übergeben.
add() fügt einen Datensatz ein; bei einem doppelten Schlüssel tritt ConstraintError auf. put() fügt einen Datensatz ein oder ersetzt den gesamten Wert unter einem vorhandenen Schlüssel – Felder werden nicht zusammengeführt. delete(query) löscht Datensätze anhand des Primärschlüssels oder eines Schlüsselbereichs. Diese Operationen benötigen eine Transaktion, die Schreibvorgänge zulässt. getAll(query?, count?) ruft Werte ab, standardmäßig nach aufsteigendem Primärschlüssel sortiert; count(query?) zählt passende Datensätze. Ohne Abfrage wird der gesamte Datenspeicher berücksichtigt.
createIndex(name, keyPath, options) erstellt einen Index nur während einer Schema-Upgrade-Transaktion, üblicherweise in onupgradeneeded; unique: true erzwingt eindeutige Indexschlüssel. index(name) gibt einen vorhandenen IDBIndex für Abfragen über einen Sekundärschlüssel zurück. Beide Methoden geben synchron Handles zurück; die übrigen aufgeführten Methoden geben IDBRequest zurück, kein Promise.
Der Erfolg einer Anfrage bedeutet nicht, dass die Transaktion abgeschlossen ist: Warte auf complete und behandle abort. Stelle Operationen ein, solange die Transaktion aktiv ist; das Warten auf nicht damit zusammenhängende asynchrone Arbeit kann sie inaktiv machen. Das Beispiel verwendet API-Formen aus IndexedDB 2.0, ohne die neuere Überladung von getAll() mit einem Optionsobjekt. Dies ist eine Web API und kein Teil von ECMAScript; Node 24 belegt keine Browserunterstützung. Prüfe, ob indexedDB in der Zielumgebung verfügbar ist.
In diesem Eintrag behandelte Referenzbezeichner: IDBObjectStore.createIndex, IDBObjectStore.add, IDBObjectStore.getAll, IDBObjectStore.delete, IDBObjectStore.put, IDBObjectStore.count, IDBObjectStore.index.
Beispiele
<!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>Ergebnis
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: SecurityErrorDer angezeigte Code und das angegebene Ergebnis wurden in einer isolierten Umgebung mit der im Prüfnachweis für genau diese Version dokumentierten Methode verifiziert.