CKTIS / JavaScript
IndexedDB: vytvorenie indexu, vloženie záznamu a vyhľadanie cez index
Pri zmene verzie databázy vytvorte sekundárny index, vložte záznam bez prepísania a vyhľadajte ho podľa kľúča indexu namiesto primárneho kľúča.
Verzia: Current web platform; runtime support varies
Syntax
store.createIndex(name, keyPath)
store.createIndex(name, keyPath, { unique, multiEntry })
store.add(value)
store.add(value, key)
store.index(name)createIndex(), add() a index() sú inštančné metódy IDBObjectStore vo webovom API IndexedDB, nie súčasť ECMAScriptu. IndexedDB dodržiava pravidlo rovnakého pôvodu; dostupnosť závisí od prostredia vykonávania a nastavení úložiska v prehliadači.
store.createIndex(name, keyPath, options) ihneď vráti IDBIndex, ale zmena schémy sa natrvalo uplatní až po potvrdení transakcie. Volajte ho v aktívnej transakcii versionchange, zvyčajne pri obsluhe upgradeneeded pri vytvorení databázy alebo zvýšení jej verzie. Názov identifikuje index; cesta ku kľúču určuje, odkiaľ sa zo záznamu získa kľúč indexu, bez pridania nového poľa. IndexedDB indexuje existujúce záznamy a index automaticky aktualizuje.
unique aj multiEntry majú predvolenú hodnotu false. unique: true zakazuje rovnaké kľúče indexu v rôznych záznamoch; existujúce duplicity môžu prerušiť zmenu verzie. multiEntry: true indexuje jednotlivé platné prvky poľa namiesto celého poľa ako jediného kľúča. Túto voľbu nemožno kombinovať s poľom ciest pre zložený kľúč (InvalidAccessError). Duplicitný názov indexu okamžite vyvolá ConstraintError.
store.add(value[, key]) vloží štruktúrovanú kópiu bez prepísania. Vyžaduje aktívnu transakciu readwrite alebo versionchange. Ak je primárny kľúč súčasťou hodnoty, key vynechajte; pri kľúči mimo hodnoty bez generátora ho zadajte. Pri úspechu obsahuje IDBRequest.result primárny kľúč, ale potvrdenie transakcie oznamuje až jej udalosť complete. Duplicitný primárny kľúč alebo kľúč jedinečného indexu spôsobí zlyhanie požiadavky s ConstraintError. put() môže záznam nahradiť, ale tiež musí dodržať jedinečnosť indexu.
store.index(name) vráti existujúci IDBIndex viazaný na tú istú transakciu. Nevytvára index ani nečíta záznam. Neexistujúci názov vyvolá NotFoundError; záleží na veľkosti písmen. V aktívnej transakcii index.get(key) vyžiada prvý zodpovedajúci záznam podľa kľúča indexu, nie primárneho kľúča. Po skončení transakcie už tento objekt nepoužívajte na čítanie.
Príklady
<!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>Výsledok
{"id":7,"email":"ada@example.test"}Sprístupnite súbor HTML na dôveryhodnej adrese HTTPS a otvorte ho v prehliadači s dostupnými IndexedDB a `crypto.randomUUID()`. Príklad vytvorí samostatnú databázu, po potvrdení zápisu vyhľadá záznam podľa `email` a pred vypísaním výsledku do konzoly prehliadača databázu zavrie a odstráni.
Súvisiace lekcie
- JavaScript · Lekcia 31 · Pokročilá · Verzia: 4