CKTIS / JavaScript
IDBObjectStore — un magasin d’enregistrements IndexedDB
IDBObjectStore expose les enregistrements IndexedDB au moyen d’une référence liée à une transaction. Il permet d’ajouter, de remplacer, de lire, de supprimer et de compter les données, ainsi que d’utiliser des index secondaires.
Version : ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support
Syntaxe
const store = transaction.objectStore(name);
store.createIndex(name, keyPath, options); // upgrade transaction only
store.add(value, key); // key may be omitted
store.put(value, key); // key may be omitted
store.getAll(query, count); // query and count are optional
store.delete(query);
store.count(query); // query is optional
store.index(name);IDBObjectStore est une référence vers un magasin d’enregistrements IndexedDB, liée à une transaction donnée. Chaque enregistrement possède une clé primaire et une valeur copiée par clonage structuré. keyPath: "id" utilise la valeur du champ id comme clé ; avec cette configuration, ne passez pas de clé séparée à add() ou put().
add() insère un enregistrement ; une clé en double provoque une erreur ConstraintError. put() insère un enregistrement ou remplace toute la valeur associée à une clé existante — il ne fusionne pas les champs. delete(query) supprime les enregistrements à partir de leur clé primaire ou d’une plage de clés. Ces opérations nécessitent une transaction autorisant les écritures. getAll(query?, count?) récupère les valeurs, triées par clé primaire croissante par défaut ; count(query?) compte les enregistrements correspondants. Si la requête est omise, tout le magasin est concerné.
createIndex(name, keyPath, options) crée un index uniquement pendant une transaction de mise à niveau du schéma, généralement dans onupgradeneeded ; unique: true impose l’unicité des clés de l’index. index(name) renvoie un IDBIndex existant pour effectuer des recherches à partir d’une clé secondaire. Ces deux méthodes renvoient des références de manière synchrone ; les autres méthodes listées renvoient un IDBRequest, et non une Promise.
La réussite d’une requête ne signifie pas que la transaction est validée : attendez complete et gérez abort. Lancez les opérations pendant que la transaction est active ; attendre des tâches asynchrones sans rapport peut la rendre inactive. L’exemple utilise les formes d’API d’IndexedDB 2.0, sans la surcharge plus récente de getAll() avec un objet d’options. Il s’agit d’une API Web, et non d’une partie d’ECMAScript ; Node 24 ne permet pas d’établir la prise en charge par les navigateurs. Vérifiez la disponibilité de indexedDB dans l’environnement cible.
Identifiants de référence couverts par cette entrée : IDBObjectStore.createIndex, IDBObjectStore.add, IDBObjectStore.getAll, IDBObjectStore.delete, IDBObjectStore.put, IDBObjectStore.count, IDBObjectStore.index.
Exemples
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IDBObjectStore: working with records</title>
</head>
<body>
<h1>Working with an IndexedDB object store</h1>
<script>
(() => {
const name = 'cktis-store-' + crypto.getRandomValues(new Uint32Array(4)).join('-');
const report = error => console.log(error.name === 'SecurityError'
? 'IndexedDB unavailable: SecurityError' : `IndexedDB error: ${error.name}`);
let factory, opening;
try {
factory = window.indexedDB;
if (!factory) {
console.log('IndexedDB unavailable: API missing');
return;
}
opening = factory.open(name, 1);
} catch (error) {
report(error);
return;
}
let created = false;
opening.onerror = () => report(opening.error);
opening.onupgradeneeded = () => {
created = true;
const store = opening.result.createObjectStore('items', { keyPath: 'id' });
store.createIndex('byLabel', 'label', { unique: true });
};
opening.onsuccess = () => {
const db = opening.result;
if (!created) {
db.close();
console.log('Fixture name already in use');
return;
}
const tx = db.transaction('items', 'readwrite');
const store = tx.objectStore('items');
store.add({ id: 1, label: 'draft' });
store.add({ id: 2, label: 'spare' });
store.put({ id: 1, label: 'final' });
store.delete(2);
const all = store.getAll();
const count = store.count();
const indexed = store.index('byLabel').get('final');
const cleanup = () => {
db.close();
factory.deleteDatabase(name);
};
tx.oncomplete = () => {
console.log(JSON.stringify({ items: all.result, count: count.result, indexedId: indexed.result.id }));
cleanup();
};
tx.onabort = () => {
report(tx.error);
cleanup();
};
};
})();
</script>
</body>
</html>Résultat
Successful browser run (IndexedDB access permitted):
{"items":[{"id":1,"label":"final"}],"count":1,"indexedId":1}
If the browser blocks IndexedDB access with a SecurityError, as in the isolated environment:
IndexedDB unavailable: SecurityErrorLe code affiché et le résultat déclaré ont été vérifiés dans un environnement isolé selon la méthode consignée dans la preuve de vérification de cette version exacte.