IDBObjectStore

Baseline Widely available *

Cette fonctionnalité est bien établie et fonctionne sur de nombreux appareils et versions de navigateurs. Elle est disponible sur tous les navigateurs depuis juillet 2015.

* Certaines parties de cette fonctionnalité peuvent bénéficier de prise en charge variables.

L'interfaceIDBObjectStore de l'API IndexedDB est un accès aux magasins d'objet de la base de données.

Le magasin d'objet emmagasine des enregistrements. Chaque enregistrement est constitué d'un couple clé/valeur. Chaque valeurs est indexée sur sa clé. Les clés sont triées pour former l'index primaire du magasin. Ce qui permet un accès rapide et ordonnée aux valeurs.

Le magasin d'objet peut en plus de l'index primaire avoir des index qui ordonnent les enregistrements sur d'autres clés. Ces index se mettent automatiquement à jour dans la plupart des cas et permettent de mettre des contraintes d'unicités pour d'autres clés que la clé primaire du magasin d'objet.

Note : Cette fonctionnalité est disponible via lesWeb Workers.

Méthodes

IDBObjectStore.add(): Unerequête pour ajouter un enregistrement au magasin d'objet relié, unclone structuré de la valeur passé en paramètre et sa clé .
IDBObjectStore.clear(): Unerequête pour vider le magasin d'objet relié.
IDBObjectStore.delete(): Unerequête de suppression d'enregistrement(s) du magasin d'objet relié.
IDBObjectStore.get(): Unerequête pour renvoyer la valeur d'un enregistrement du magasin d'objet relié.
IDBObjectStore.getAll(): Unerequête qui renvoie un tableau ordonné suivant les clés, des valeurs de tous les enregistrements du magasin d'objet relié. On peut limité le nombre d'enregistrements en les filtrants suivant leurs clés ou en paramétrant le compteur.
IDBObjectStore.getAllKeys(): Unerequête qui renvoie la liste de toutes les clés des enregistrements du magasin d'objet. On peut limité le nombre d'enregistrements en les filtrants suivant leurs clés ou en paramétrant le compteur.
IDBObjectStore.createIndex(): Met en place sur le magasin d'objet relié, un nouvel index et en renvoie l'accès.
IDBObjectStore.deleteIndex(): Supprime l'index dont le nom est passé en paramètre, du magasin d'objet relié.
IDBObjectStore.index(): L'accès à l'index dont le nom est passé en paramètre du magasin d'objet relié.
IDBObjectStore.put(): Unerequête pour ajouter ou mettre à jour un enregistrement du magasin d'objet relié, unclone structuré de la valeur passée en paramètre et sa clé.
IDBObjectStore.openCursor(): Unerequête récursive suivant uncurseur avec valeur qui itère le magasin d'objet relié.
IDBObjectStore.openKeyCursor(): Unerequête récursive suivant uncurseur qui itère le magasin d'objet relié.
IDBObjectStore.count(): Unerequête au magasin d'objet relié. La requête compte le nombre d'enregistrements dans ce magasin d'objet ou sur l'intervalle de clé passé en paramètre.

Propriétés

IDBObjectStore.indexNamesLecture seule: La liste des noms d'index du magasin d'objet relié.
IDBObjectStore.keyPathLecture seule: Lenom de la clé du magasin d'objets relié.
IDBObjectStore.nameLecture seule: Le nom du magasin d'objet relié.
IDBObjectStore.transactionLecture seule: Latransaction à laquelle l'accès du magasin d'objet appartient.
IDBObjectStore.autoIncrementLecture seule: La position du drapeau d'incrémentation automatique du magasin d'objet relié.

Exemple

Cet exemple montre différents usages de l'accès au magasin d'objet. On met à jour la structure de donnée avecIDBObjectStore.createIndex dans un gestionnaire d'événementonupgradeneeded. On ajoute un nouvel enregistrement avecIDBObjectStore.add.

// connexion à la base de donnéesvar DBOpenRequest = window.indexedDB.open("toDoList", 4);// gère le succès de la connexionDBOpenRequest.onsuccess = function (event) {  note.innerHTML += "<li>Connexion ouverte.</li>";  //affect la connexion à la variable db.  db = DBOpenRequest.result;};// Ce gestionnaire d'événement s'active quand on à besoin d'une nouvelle version de la base de donnée.// Si la base n'existais pas avant ou// si on ouvre une nouvelle version avec window.indexedDB.open.DBOpenRequest.onupgradeneeded = function (event) {  var db = event.target.result;  db.onerror = function (event) {    note.innerHTML += "<li>Erreur de chargement de la base.</li>";  };  // Ajoute un magasin d'objets à la base de données  var objectStore = db.createObjectStore("toDoList", { keyPath: "taskTitle" });  // défini des index sur ce magasin  objectStore.createIndex("hours", "hours", { unique: false });  objectStore.createIndex("minutes", "minutes", { unique: false });  objectStore.createIndex("day", "day", { unique: false });  objectStore.createIndex("month", "month", { unique: false });  objectStore.createIndex("year", "year", { unique: false });  objectStore.createIndex("notified", "notified", { unique: false });  note.innerHTML += "<li>Le magasin d'objet est ajouté.</li>";};// Un nouvel enregistrement à ajoutervar newItem = [  {    taskTitle: "Walk dog",    hours: 19,    minutes: 30,    day: 24,    month: "December",    year: 2013,    notified: "no",  },];// ouvre une transaction en lecture/écriture sur la connexion, prête à ajouter l'enregistrement.var transaction = db.transaction(["toDoList"], "readwrite");// affiche le succès de la transactiontransaction.oncomplete = function (event) {  note.innerHTML += "<li>La transaction à été effectuée.</li>";};transaction.onerror = function (event) {  note.innerHTML += "<li>La transaction n'as pue aboutir.</li>";};// Un accès à toDoList pour la transactionvar objectStore = transaction.objectStore("toDoList");// Ajoute l'enregistrement au magasin d'objetvar objectStoreRequest = objectStore.add(newItem[0]);//l'enregistrement s'est bien passé.objectStoreRequest.onsuccess = function (event) {  note.innerHTML +=    "<li>L'enregistrement à été ajouté au magasin d'objet.</li>";};

Note :Pour un exemple de travail complet, voir notreTo-do Notifications app (view example live).