CKTIS / JavaScript
IndexedDB : créer un index, ajouter, compter et lire des enregistrements
Créez un index secondaire, insérez des enregistrements sans les écraser et recherchez-les par clé primaire ou par clé d’index.
Version : ECMAScript 2024 and the current web platform; runtime support varies
Syntaxe
store.createIndex(name, keyPath)
store.createIndex(name, keyPath, options)
store.count()
store.count(query)
store.add(value)
store.add(value, key)
store.getAll()
store.getAll(query)
store.getAll(query, count)
store.getAll(options)
store.index(name)Un IDBObjectStore représente un magasin d’objets rattaché à une transaction. Chaque enregistrement possède une clé primaire et une valeur. IndexedDB est une API du Web, pas une partie d’ECMAScript ; l’accès suit la politique de même origine.
createIndex(name, keyPath, options) renvoie immédiatement un IDBIndex, mais ne s’utilise que dans une transaction versionchange active, généralement dans upgradeneeded. Le chemin de clé indique où extraire la clé d’index ; il n’ajoute aucun champ à l’enregistrement. unique: true interdit les clés d’index en double et multiEntry: true indexe séparément les éléments valides d’un tableau. Les deux options valent false par défaut. multiEntry: true est incompatible avec un chemin composé fourni sous forme de tableau de chemins.
add(value, key) stocke une copie structurée et place la nouvelle clé dans request.result. Omettez le second argument si la clé est intégrée à la valeur ; fournissez-le si la clé est séparée et qu’il n’y a pas de générateur. Un doublon de clé primaire ou une violation d’unicité d’index fait échouer la requête avec ConstraintError. Utilisez put() pour insérer ou remplacer selon la clé primaire.
count(query) donne un nombre ; getAll(query, count) donne un tableau de copies des valeurs, vide sans correspondance. Les deux acceptent une clé primaire ou un IDBKeyRange et couvrent tout le magasin sans filtre. Un count positif limite le nombre de valeurs de getAll(). Par défaut, l’ordre des clés primaires est croissant. La forme plus récente getAll({ query, count, direction }) permet notamment "prev" ; vérifiez sa prise en charge dans le navigateur cible.
index(name) renvoie immédiatement un IDBIndex existant, rattaché à la même transaction. Un nom inconnu déclenche NotFoundError ; la casse compte. store.getAll("sci-fi") filtre sur la clé primaire, tandis que store.index("byGenre").getAll("sci-fi") renvoie les valeurs correspondant à la clé d’index.
add(), count() et getAll() renvoient un IDBRequest, pas une Promise. Lisez result après success et gérez error. Dans une transaction ordinaire, l’écriture requiert le mode readwrite. Placez les requêtes tant que la transaction est active : attendre une autre opération asynchrone peut la laisser se terminer. Le succès d’une requête ne confirme pas la validation de la transaction ; attendez son événement complete.
Exemples
<!doctype html>
<meta charset="utf-8">
<title>IndexedDB object store methods</title>
<script>
(() => {
const dbName = `cktis-books-${crypto.randomUUID()}`;
const open = indexedDB.open(dbName, 1);
open.onupgradeneeded = () => {
const store = open.result.createObjectStore('books', { keyPath: 'id' });
store.createIndex('byGenre', 'genre');
};
open.onerror = () => console.error(open.error);
open.onsuccess = () => {
const db = open.result;
const tx = db.transaction('books', 'readwrite');
const store = tx.objectStore('books');
const cleanup = () => {
db.close();
const deletion = indexedDB.deleteDatabase(dbName);
deletion.onerror = () => console.error(deletion.error);
};
tx.onabort = () => {
console.error(tx.error);
cleanup();
};
const added = store.add({ id: 3, title: 'Orbit', genre: 'sci-fi' });
store.add({ id: 1, title: 'Dunes', genre: 'sci-fi' });
store.add({ id: 2, title: 'Herbs', genre: 'guide' });
const total = store.count();
const all = store.getAll();
const matches = store.index('byGenre').getAll('sci-fi');
tx.oncomplete = () => {
const titles = (request) => request.result.map((book) => book.title).join(', ');
console.log(`Added key: ${added.result}`);
console.log(`Total: ${total.result}`);
console.log(`All: ${titles(all)}`);
console.log(`Sci-fi: ${titles(matches)}`);
cleanup();
};
};
})();
</script>Résultat
Added key: 3 Total: 3 All: Dunes, Herbs, Orbit Sci-fi: Dunes, Orbit
Servez ce document HTML en HTTPS, ouvrez-le dans un navigateur et consultez la console de développement. L’exemple crée puis supprime une base temporaire distincte. Il insère trois livres dans un ordre différent de celui des clés primaires. Après validation, il affiche tous les titres par `id`, puis ceux sélectionnés par l’index de genre.
Leçons associées
- JavaScript · Leçon 21 · Intermédiaire · Version : 3
Sources
- IDBObjectStore: createIndex() method
- IDBObjectStore: count() method
- IDBObjectStore: add() method
- IDBObjectStore: getAll() method
- IDBObjectStore: index() method
- IDBIndex: getAll() method
- IDBTransaction
- IDBTransaction: complete event
- IndexedDB key characteristics and basic terminology
- Using IndexedDB
- Crypto: randomUUID() method