CKTIS / JavaScript
IDBObjectStore — shramba zapisov IndexedDB
IDBObjectStore omogoča dostop do zapisov IndexedDB prek sklica, vezanega na transakcijo. Podatke lahko dodaja, zamenjuje, bere, briše in šteje ter omogoča uporabo sekundarnih indeksov.
Različica: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Sintaksa
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 je sklic na shrambo zapisov IndexedDB, vezan na določeno transakcijo. Vsak zapis ima primarni ključ in vrednost, ki se kopira s strukturiranim kloniranjem. keyPath: "id" vzame ključ iz polja id; pri tej nastavitvi metodama add() ali put() ne podajte ločenega argumenta za ključ.
add() vstavi zapis; podvojen ključ povzroči napako ConstraintError. put() vstavi zapis ali zamenja celotno vrednost pri obstoječem ključu — polj ne združuje. delete(query) izbriše zapise po primarnem ključu ali obsegu ključev. Te operacije zahtevajo transakcijo, ki dovoljuje pisanje. getAll(query?, count?) pridobi vrednosti, privzeto razvrščene po naraščajočem primarnem ključu; count(query?) prešteje ujemajoče se zapise. Če poizvedbo izpustite, je zajeta celotna shramba.
createIndex(name, keyPath, options) ustvari indeks samo med transakcijo za nadgradnjo sheme, običajno v onupgradeneeded; unique: true zahteva enolične ključe indeksa. index(name) vrne obstoječi IDBIndex za iskanje po sekundarnem ključu. Obe metodi sinhrono vrneta sklica; druge navedene metode vrnejo IDBRequest, ne Promise.
Uspeh zahteve ne pomeni, da je transakcija potrjena: počakajte na complete in obravnavajte abort. Operacije dodajajte, ko je transakcija aktivna; čakanje na nepovezano asinhrono delo jo lahko naredi neaktivno. Primer uporablja oblike API-ja iz IndexedDB 2.0, brez novejše različice getAll() z objektom možnosti. To je Web API, ne del ECMAScripta; Node 24 ne potrjuje podpore v brskalnikih. Preverite, ali je indexedDB na voljo v ciljnem okolju.
Referenčni identifikatorji, zajeti v tem geslu: IDBObjectStore.createIndex, IDBObjectStore.add, IDBObjectStore.getAll, IDBObjectStore.delete, IDBObjectStore.put, IDBObjectStore.count, IDBObjectStore.index.
Primeri
<!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>Rezultat
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: SecurityErrorPrikazana koda in navedeni rezultat sta bila preverjena v izoliranem okolju z metodo, zapisano v dokazilu o preverjanju te natančne različice.