CKTIS / JavaScript
IndexedDB: vytváření úložišť objektů a otevírání transakcí
Pomocí `createObjectStore()` měň schéma při zvýšení verze databáze; pomocí `transaction()` čti a zapisuj záznamy v existujících úložištích objektů.
Verze: ECMAScript 2024 and the current web platform; runtime support varies
Syntaxe
db.createObjectStore(name) → IDBObjectStore
db.createObjectStore(name, options) → IDBObjectStore
db.transaction(storeNames) → IDBTransaction
db.transaction(storeNames, mode) → IDBTransaction
db.transaction(storeNames, mode, options) → IDBTransactionIDBDatabase představuje otevřené připojení k databázi IndexedDB. db.createObjectStore(name, options) okamžitě vrátí nový IDBObjectStore, ale funguje pouze v aktivní transakci versionchange. IndexedDB ji zahájí, když indexedDB.open() databázi vytvoří nebo otevře s vyšší verzí. Schéma měň v obsluze upgradeneeded. Otevřené připojení na jiné kartě může změnu verze zablokovat: požadavek na otevření vyvolá blocked a původní připojení může v reakci na versionchange zavolat close().
Volitelný keyPath určuje, odkud se z hodnoty získá klíč, například z id. Pole cest určuje složený klíč; bez cesty se klíč ukládá odděleně. Výchozí hodnota autoIncrement je false; true zapíná generátor klíčů, ale nelze je kombinovat s prázdným řetězcem nebo polem jako keyPath (InvalidAccessError). Duplicitní název úložiště vyvolá ConstraintError, neplatná cesta vyvolá SyntaxError a volání bez transakce změny verze vyvolá InvalidStateError.
db.transaction(storeNames, mode, options) okamžitě vrátí IDBTransaction, jejíž rozsah určuje jeden název úložiště předaný jako řetězec nebo neprázdný iterovatelný objekt s názvy existujících úložišť, například pole nebo Set. K úložišti z tohoto rozsahu přistoupíš přes tx.objectStore(name). Výchozí "readonly" umožňuje jen čtení; "readwrite" umožňuje i zápis. "versionchange" tu nelze vybrat (TypeError). Neznámé úložiště vyvolá NotFoundError, prázdný seznam InvalidAccessError a zavírané nebo zavřené připojení InvalidStateError. Volitelné options.durability ("default", "strict", "relaxed") vyjadřuje požadavek na trvalost zápisu při potvrzení; ověř podporu v cílových prohlížečích.
Požadavky zařazuj jen v aktivní transakci: v úloze, která ji vytvořila, nebo v obsluze success či error některého z jejích požadavků. Po await fetch(...) už může být automaticky potvrzena a pozdější požadavek může vyvolat TransactionInactiveError. Úspěch požadavku neznamená úspěch celé transakce. complete potvrzuje dokončení transakce; abort znamená vrácení změn.
IndexedDB je webové API, nikoli součást ECMAScript 2024. Přístup je omezen na stejný původ (origin); nastavení prohlížeče může omezit přístup k úložišti nebo dobu uchování dat.
Pří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ýsledek
IndexedDB
Zpřístupni soubor HTML přes HTTPS a otevři ho v prohlížeči, ve kterém je ukládání povoleno. Příklad vytvoří databázi s náhodným názvem, po potvrzení zápisu přečte záznam, zavře a smaže databázi a nakonec vypíše `IndexedDB` do konzole prohlížeče.
Související lekce
- JavaScript · Lekce 31 · Pokročilá · Verze: 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