IDBTransaction.oncomplete

Le gestionnaire d'événement oncomplete, rattaché à l'interface IDBTransaction, s'exécute au déclenchement d'un événement complete lorsque la transaction se termine avec succès.

Note : Depuis Firefox 40, les transactions IndexedDB diminuent en efficacité pour gagner en efficience (voir bug 1112702). Auparavant, dans une transaction en readwrite, l'événement complete était déclenché seulement lorsque toutes les données étaient écrites sur le disque. Maintenant, l'événement complete est déclenché après que l'OS ai envoyé l'ordre d'écrire les données, mais potentiellement avant qu'elles aient été écrites sur le disque. L'événement complete peut ainsi être déclenché plus rapidement qu'auparavant. Cependant, il existe une chance infime pour que l'ensemble de la transaction soit perdue si le système d'exploitation plante ou s'il y a une perte de courant avant que les données aient été écrites sur le disque. Étant donné que ces événements catastrophiques sont rares, la plupart des utilisateurs ne devraient pas avoir à s'en préoccuper davantage.

Si vous devez vous assurer de l'efficacité d'une transaction pour une raison quelconque (par exemple, vous stockez des données critiques qui ne peuvent être recalculé plus tard), vous pouvez forcer l'enregistrement complet sur disque avant de déclencher l'événement complete en utilisant le mode readwriteflush (non-standard) expérimental (cf. IDBDatabase.transaction ). Ce mode expérimentale ne peut être utilisé que si la préférence dom.indexedDB.experimental pref est réglée sur true dans about: config.

Note : Cette fonctionnalité est disponible via les Web Workers.

Syntaxe

transaction.oncomplete = function() { ... };

Exemple

Dans le code suivant, on ouvre une connexion à la base de donnée. Ensuite, sur cette connexion, on démarre une transaction (avec  IDBTransaction) en lecture/écriture pour accéder au magasin d'objet "toDoList" et y ajouter un enregistrement grâce à la méthode IDBObjectStore.add. On notera également la façon dont le gestionnaire d'événement IDBTransaction.onerror est utilisé dans la transaction.

Le gestionnaires d'événement oncomplete de la transaction permet d'afficher un message de succès sur la page.

// Connexion à la base de données
var DBOpenRequest = window.indexedDB.open("toDoList", 4);

DBOpenRequest.onsuccess = function(event) {
  note.innerHTML += '<li>Connexion établie.</li>'; 
  
  // Affectation de la connexion à la variable db. 
  db = DBOpenRequest.result; 

  // Exécution de la fonction addData () pour
  // stocker des données dans la base
  addData(); 
};

function addData() { 
  // Voici un nouvel objet prêt à être emmagasiné
  newItem = [ { taskTitle: "Walk dog", hours: 19, minutes: 30, day: 24, month: "December", year: 2013, notified: "no" } ]; 
  
  // On ouvre une transaction en lecture/écriture
  // prête au traitement des données sur la connexion
  var transaction = db.transaction(["toDoList"], "readwrite"); 

  // Voici le gestionnaire utilisé en cas de succès
  // de l'ouverture de la transaction 
  transaction.oncomplete = function(event) { 
    note.innerHTML += '<li>Transaction terminée : modification de la base de données OK.</li>'; 
  }; 

  // Et celui utilisé en cas d'échec de
  // l'ouverture de la transaction 
  transaction.onerror = function(event) { 
    note.innerHTML += '<li>L\'erreur: "' + transaction.error +'" s\'est produite, échec de la transaction.</li>';  
  }; 

  // Puis, on ouvre l'accès au un magasin "toDoList"
  // de la transaction
  var objectStore = transaction.objectStore("toDoList"); 

  // Enfin on ajoute l'enregistrement
  var objectStoreRequest = objectStore.add(newItem[0]); 
  objectStoreRequest.onsuccess = function(event) { 
    // Et on signale l'ajout de l'enregistrement
    note.innerHTML += '<li>Enregistrement ajouté.</li>'; 
  };
 };

Pour un exemple de travail complet, voir notre application To-do Notifications (exemple live disponible).

Spécifications

Spécification État Commentaires
Indexed Database API
La définition de 'oncomplete' dans cette spécification.
Recommendation  

Compatibilité des  navigateurs

Fonctionnalité Chrome Firefox (Gecko) Internet Explorer Opera Safari (WebKit)
Support simple 23webkit
24
10 moz
16.0 (16.0)
10, en partie 15 7.1
Disponible via les web workers (Oui) 37.0 (37.0) ? (Oui) ?
Fonctionnalité Android Firefox Mobile (Gecko) Firefox OS IE Phone Opera Mobile Safari Mobile
Support simple 4.4 22.0 (22.0) 1.0.1 10 22 8
Disponible via les web workers (Oui) 37.0 (37.0) (Oui) ? (Oui) ?

Voir aussi

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : SphinxKnight, gadgino
 Dernière mise à jour par : SphinxKnight,