CKTIS / JavaScript
IndexedDB: ustvarjanje indeksa, vstavljanje zapisa in iskanje po indeksu
Ob nadgradnji podatkovne zbirke ustvarite sekundarni indeks, vstavite zapis brez prepisa in ga poiščite po ključu indeksa namesto po primarnem ključu.
Različica: Current web platform; runtime support varies
Sintaksa
store.createIndex(name, keyPath)
store.createIndex(name, keyPath, { unique, multiEntry })
store.add(value)
store.add(value, key)
store.index(name)createIndex(), add() in index() so metode primerka IDBObjectStore v spletnem API-ju IndexedDB, ne v ECMAScriptu. IndexedDB upošteva pravilnik istega izvora; razpoložljivost je odvisna od izvajalnega okolja in nastavitev shrambe v brskalniku.
store.createIndex(name, keyPath, options) takoj vrne IDBIndex, vendar sprememba sheme postane trajna šele, ko je transakcija potrjena. Metodo kličite v aktivni transakciji versionchange, navadno ob dogodku upgradeneeded pri ustvarjanju zbirke ali zvišanju njene različice. Ime določa indeks, pot do ključa pa določa, od kod se v zapisu vzame ključ indeksa, ne da bi se dodalo polje. IndexedDB indeksira obstoječe zapise in samodejno posodablja indeks.
unique in multiEntry imata privzeto vrednost false. unique: true prepoveduje enake ključe indeksa v različnih zapisih; obstoječi dvojniki lahko prekinejo nadgradnjo. multiEntry: true ločeno indeksira veljavne elemente polja namesto celotnega polja kot enega ključa. Te možnosti ni mogoče združiti s poljem poti za sestavljeni ključ (InvalidAccessError). Podvojeno ime indeksa takoj sproži ConstraintError.
store.add(value[, key]) vstavi strukturirano kopijo brez prepisa. Uporabite aktivno transakcijo readwrite ali versionchange. Izpustite key, če je primarni ključ del vrednosti; podajte ga, če je zunaj vrednosti in ni generatorja. Ob uspehu IDBRequest.result vsebuje primarni ključ, vendar šele dogodek complete potrdi uspešno potrditev transakcije. Zaradi podvojenega primarnega ključa ali ključa enoličnega indeksa zahteva spodleti s ConstraintError. put() lahko nadomesti zapis, vendar mora prav tako upoštevati enoličnost indeksa.
store.index(name) vrne obstoječi IDBIndex, vezan na isto transakcijo. Ne ustvari indeksa in ne prebere zapisa. Neobstoječe ime sproži NotFoundError; velike in male črke se razlikujejo. V aktivni transakciji index.get(key) zahteva prvi ustrezni zapis po ključu indeksa, ne po primarnem ključu. Ko se transakcija konča, tega objekta ne uporabljajte več za branje.
Primeri
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IndexedDB: insert and look up a contact</title>
</head>
<body>
<script>
(async () => {
const { indexedDB, crypto } = window;
const name = `cktis-index-${crypto.randomUUID()}`;
const resultOf = (request) => new Promise((resolve, reject) => {
request.onsuccess = () => resolve(request.result);
request.onerror = () => reject(request.error);
});
const committed = (tx) => new Promise((resolve, reject) => {
tx.oncomplete = () => resolve();
tx.onabort = () => reject(tx.error ?? new Error('Transaction aborted'));
});
const open = indexedDB.open(name, 1);
open.onupgradeneeded = () => {
const store = open.result.createObjectStore('contacts', { keyPath: 'id' });
store.createIndex('byEmail', 'email', { unique: true });
};
const db = await resultOf(open);
let contact;
try {
const write = db.transaction('contacts', 'readwrite');
write.objectStore('contacts').add({ id: 7, email: 'ada@example.test' });
await committed(write);
const read = db.transaction('contacts', 'readonly');
const lookup = read.objectStore('contacts').index('byEmail').get('ada@example.test');
await committed(read);
contact = lookup.result;
} finally {
db.close();
await resultOf(indexedDB.deleteDatabase(name));
}
console.log(JSON.stringify(contact));
})().catch((error) => console.error(error));
</script>
</body>
</html>Rezultat
{"id":7,"email":"ada@example.test"}Datoteko HTML ponudite na zaupanja vrednem naslovu HTTPS in jo odprite v brskalniku, kjer sta na voljo IndexedDB in `crypto.randomUUID()`. Primer ustvari ločeno zbirko, po potrditvi pisanja poišče zapis po `email`, nato pa zbirko zapre in izbriše, preden izpiše rezultat v konzolo brskalnika.
Povezane lekcije
- JavaScript · Lekcija 31 · Napredna · Različica: 4