CKTIS / JavaScript
IndexedDB: vytváranie úložísk objektov a otváranie transakcií
Použi `createObjectStore()` na zmenu schémy pri zvýšení verzie databázy a `transaction()` na čítanie alebo zápis záznamov v existujúcich úložiskách.
Verzia: ECMAScript 2024 and the current web platform; runtime support varies
Syntax
db.createObjectStore(name) → IDBObjectStore
db.createObjectStore(name, options) → IDBObjectStore
db.transaction(storeNames) → IDBTransaction
db.transaction(storeNames, mode) → IDBTransaction
db.transaction(storeNames, mode, options) → IDBTransactionIDBDatabase predstavuje otvorené pripojenie k databáze IndexedDB. db.createObjectStore(name, options) okamžite vráti nový IDBObjectStore, ale funguje iba v aktívnej transakcii versionchange. IndexedDB ju spustí, keď indexedDB.open() databázu vytvorí alebo otvorí s vyššou verziou. Schému meň v obsluhe upgradeneeded. Otvorené pripojenie na inej karte môže zmenu verzie zablokovať: požiadavka na otvorenie vyvolá blocked a pôvodné pripojenie môže pri versionchange zavolať close().
Voliteľný keyPath určuje, odkiaľ sa z hodnoty získa kľúč, napríklad z id. Pole ciest definuje zložený kľúč; bez cesty sa kľúč ukladá oddelene. autoIncrement má predvolene hodnotu false; true zapne generátor kľúčov, ale nemožno ho kombinovať s prázdnym reťazcom ani poľom ako keyPath (InvalidAccessError). Duplicitný názov úložiska vyvolá ConstraintError, neplatná cesta ku kľúču SyntaxError a volanie bez transakcie zmeny verzie InvalidStateError.
db.transaction(storeNames, mode, options) okamžite vráti IDBTransaction, ktorej rozsah určuje jeden názov úložiska odovzdaný ako reťazec alebo neprázdny iterovateľný objekt s názvami existujúcich úložísk, napríklad pole alebo Set. K úložisku v tomto rozsahu pristúpiš cez tx.objectStore(name). Predvolený režim "readonly" umožňuje iba čítanie; "readwrite" umožňuje aj zápis. "versionchange" tu nemožno zvoliť (TypeError). Neznáme úložisko vyvolá NotFoundError, prázdny zoznam InvalidAccessError a zatvárané alebo zatvorené pripojenie InvalidStateError. Voliteľné options.durability ("default", "strict", "relaxed") vyjadruje preferenciu trvácnosti zápisu pri potvrdení; over podporu v cieľových prehliadačoch.
Požiadavky zaraďuj iba počas aktívnej transakcie: v úlohe, ktorá ju vytvorila, alebo v obsluhe success či error niektorej z jej požiadaviek. Po await fetch(...) už môže byť automaticky potvrdená a neskoršia požiadavka môže vyvolať TransactionInactiveError. Úspech požiadavky neznamená úspech celej transakcie. complete potvrdzuje úspešné ukončenie; abort znamená vrátenie zmien.
IndexedDB je webové API, nie súčasť ECMAScript 2024. Prístup je obmedzený na rovnaký pôvod (origin); nastavenia prehliadača môžu obmedziť prístup k úložisku alebo dobu uchovávania údajov.
Príklady
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IndexedDB example</title>
</head>
<body>
<script>
(async () => {
const idb = window.indexedDB;
const name = `cktis-notes-${crypto.randomUUID()}`;
const requestResult = (request) => new Promise((resolve, reject) => {
request.onsuccess = () => resolve(request.result);
request.onerror = () => reject(request.error);
});
const finished = (tx) => new Promise((resolve, reject) => {
tx.oncomplete = () => resolve();
tx.onabort = () => reject(tx.error ?? new Error("Transaction aborted"));
});
const open = idb.open(name, 1);
open.onupgradeneeded = () => {
open.result.createObjectStore("notes", { keyPath: "id" });
};
const db = await requestResult(open);
db.onversionchange = () => db.close();
let title;
try {
const write = db.transaction("notes", "readwrite");
write.objectStore("notes").put({ id: 1, title: "IndexedDB" });
await finished(write);
const read = db.transaction("notes");
const get = read.objectStore("notes").get(1);
await finished(read);
title = get.result.title;
} finally {
db.close();
await requestResult(idb.deleteDatabase(name));
}
console.log(title);
})().catch((error) => console.error(error));
</script>
</body>
</html>Výsledok
IndexedDB
Sprístupni súbor HTML cez HTTPS a otvor ho v prehliadači, v ktorom je ukladanie povolené. Príklad vytvorí databázu s náhodným názvom, po potvrdení zápisu prečíta záznam, zatvorí a odstráni databázu a nakoniec vypíše `IndexedDB` do konzoly prehliadača.
Súvisiace lekcie
- JavaScript · Lekcia 31 · Pokročilá · Verzia: 4
Zdroje
- IDBDatabase: createObjectStore() method
- IDBDatabase: transaction() method
- IDBFactory: open() method
- Using IndexedDB
- IDBTransaction
- IDBTransaction: durability property
- IndexedDB key characteristics and basic terminology
- IDBObjectStore: put() method
- IDBObjectStore: get() method
- IDBFactory: deleteDatabase() method
- Crypto: randomUUID() method
- ECMAScript® 2024 Language Specification — Overview