CKTIS / JavaScript
IndexedDB : créer des magasins d’objets et ouvrir des transactions
Modifiez le schéma lors d’une mise à niveau avec `createObjectStore()`, puis lisez ou écrivez dans les magasins existants avec `transaction()`.
Version : 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 représente une connexion ouverte à IndexedDB. db.createObjectStore(name, options) renvoie immédiatement un nouvel IDBObjectStore, mais ne fonctionne que dans une transaction versionchange active. IndexedDB lance cette transaction quand indexedDB.open() crée la base ou l’ouvre avec une version supérieure. Modifiez le schéma dans upgradeneeded. Une connexion ouverte dans un autre onglet peut bloquer la mise à niveau : la requête d’ouverture émet blocked et l’ancienne connexion peut appeler close() en réponse à versionchange.
Le keyPath facultatif indique où extraire la clé de la valeur, par exemple dans id. Un tableau de chemins définit une clé composée ; sans chemin, la clé est stockée séparément. autoIncrement vaut false par défaut ; true active un générateur de clés, mais ne peut pas être combiné avec une chaîne vide ou un tableau comme keyPath (InvalidAccessError). Un nom de magasin en double donne ConstraintError, un chemin de clé invalide donne SyntaxError et un appel sans transaction de mise à niveau donne InvalidStateError.
db.transaction(storeNames, mode, options) renvoie immédiatement une IDBTransaction dont le périmètre est défini par un seul nom de magasin passé sous forme de chaîne ou par un itérable non vide de noms de magasins existants, par exemple un tableau ou un Set. Accédez à un magasin de ce périmètre avec tx.objectStore(name). Le mode par défaut "readonly" autorise uniquement la lecture ; "readwrite" autorise aussi l’écriture. On ne peut pas choisir "versionchange" ici (TypeError). Un magasin inconnu donne NotFoundError, une liste vide donne InvalidAccessError, et une connexion fermée ou en cours de fermeture donne InvalidStateError. L’option options.durability ("default", "strict", "relaxed") indique la préférence de durabilité à la validation ; vérifiez sa prise en charge par les navigateurs ciblés.
Ajoutez des requêtes uniquement lorsque la transaction est active : dans la tâche qui l’a créée ou dans un gestionnaire success ou error de l’une de ses requêtes. Après await fetch(...), elle peut déjà avoir été validée automatiquement ; une requête tardive peut alors lever TransactionInactiveError. La réussite d’une requête ne garantit pas celle de la transaction. complete confirme la validation ; abort indique que les modifications ont été annulées.
IndexedDB est une API Web et ne fait pas partie d’ECMAScript 2024. L’accès est limité à la même origine ; les réglages du navigateur peuvent restreindre l’accès au stockage ou la durée de conservation.
Exemples
<!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>Résultat
IndexedDB
Servez le fichier HTML via HTTPS et ouvrez-le dans un navigateur où le stockage est autorisé. L’exemple crée une base au nom aléatoire, lit l’enregistrement après validation de l’écriture, ferme et supprime la base, puis affiche `IndexedDB` dans la console du navigateur.
Leçons associées
- JavaScript · Leçon 31 · Avancé · Version : 4
Sources
- 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