diff options
Diffstat (limited to 'files/fr/web/api/idbtransaction/index.md')
| -rw-r--r-- | files/fr/web/api/idbtransaction/index.md | 188 |
1 files changed, 188 insertions, 0 deletions
diff --git a/files/fr/web/api/idbtransaction/index.md b/files/fr/web/api/idbtransaction/index.md new file mode 100644 index 0000000000..b856029dee --- /dev/null +++ b/files/fr/web/api/idbtransaction/index.md @@ -0,0 +1,188 @@ +--- +title: IDBTransaction +slug: Web/API/IDBTransaction +tags: + - API + - IDBTransaction + - IndexedDB + - Interface + - Reference +translation_of: Web/API/IDBTransaction +--- +<div>{{APIRef("IndexedDB")}}</div> + +<p>L'interface <strong><code>IDBTransaction</code></strong> de l'<a href="/fr/docs/Web/API/API_IndexedDB">API IndexedDB</a> fournit une transaction statique asynchrone vers une base de données grâce à des attributs de gestion d'évènementns. Toutes les opérations de lecture et d'écriture de données sont effectuées au sein de transaction. Il est possible d'utiliser {{domxref("IDBDatabase")}} afin d'initier des transactions puis {{domxref("IDBTransaction")}} afin de paramétrer le mode de la transaction (c'est-à-dire s'il est en lecture seule ou en lecture/écriture) et d'accéder à un objet {{domxref("IDBObjectStore")}} pour réaliser une requête. On peut également utiliser <code>IDBTransaction</code> pour interrompre une requête.</p> + +<p>S'il vous garantir une certaine longévité (par exemple si on utilise des données critiques qui ne peuvent pas être recalculées par la suite), il est possible d'écrire le contenu de la transaction sur le disque avant la diffusion de l'évènement <code>complete</code> grâce au mode expérimental non-standard <code>readwriteflush</code> (cf. {{domxref("IDBDatabase.transaction")}}).</p> + +<p>On notera qu'une transaction commence dès sa création et pas lorsque la première requête est lancée. Par exemple :</p> + +<pre class="brush: js">var trans1 = db.transaction("toto", "readwrite"); +var trans2 = db.transaction("toto", "readwrite"); +trans2.put("2", "clé"); +trans1.put("1", "clé"); +</pre> + +<p>Une fois que le code est exécuté, le magasin d'objet contiendra la valeur "2" car la transaction est lancée après la transaction <code>trans1</code>.</p> + +<p>{{AvailableInWorkers}}</p> + +<h2 id="Méthodes">Méthodes</h2> + +<p>Cette interface hérite de {{domxref("EventTarget")}}.</p> + +<dl> + <dt>{{domxref("IDBTransaction.abort")}}</dt> + <dd>Cette méthode annule les modifications apportées aux objets associés à cette transaction. Si la transaction a déjà été interrompue ou est terminée, cette méthode déclenchera un évènement d'erreur.</dd> + <dt>{{domxref("IDBTransaction.objectStore")}}</dt> + <dd>Cette méthode renvoie un objet {{domxref("IDBObjectStore")}} qui représente le magasin d'objet associé à cette transaction.</dd> +</dl> + +<h2 id="Propriétés">Propriétés</h2> + +<dl> + <dt>{{domxref("IDBTransaction.db")}} {{readonlyInline}}</dt> + <dd>La connexion à la base de données associée à cette transaction.</dd> + <dt>{{domxref("IDBTransaction.mode")}} {{readonlyInline}}</dt> + <dd>Le mode de la transaction qui définit la façon dont on accède/modifie les données. Les différentes valeurs sont définies ci-après dans la section Constante. Par défaut, la valeur est <code>readonly</code>.</dd> + <dt>{{domxref("IDBTransaction.objectStoreNames")}} {{readonlyinline}}</dt> + <dd>Cette propriété est une liste ({{domxref("DOMStringList")}}) des noms des objets {{domxref("IDBObjectStore")}}.</dd> + <dt>{{domxref("IDBTransaction.error")}} {{readonlyInline}}</dt> + <dd>Cette propriété renvoie le type de l'erreur qui se produit lorsque la transaction infructueuse. Cette propriété vaut <code>null</code> si la transaction n'est pas finie, est finie et validée correctement ou a été cloturée avec la fonction{{domxref("IDBTransaction.abort")}}.</dd> +</dl> + +<h3 id="Gestionnaires_d'évènements">Gestionnaires d'évènements</h3> + +<dl> + <dt>{{domxref("IDBTransaction.onabort")}} {{readonlyInline}}</dt> + <dd>Ce gestionnaire permet de gérer l'évènement <code>abort</code> qui est déclenché lorsque la transaction a été interrompue.</dd> + <dt>{{domxref("IDBTransaction.oncomplete")}} {{readonlyInline}}</dt> + <dd>Ce gestionnaire permet de gérer l'évènement <code>complete</code> qui est déclenché lorsque la transaction se finit correctement.</dd> + <dt>{{domxref("IDBTransaction.onerror")}} {{readonlyInline}}</dt> + <dd>Ce gestionnaire permet de gérer l'évènement <code>error</code> qui est déclenché lorsqu'une erreur empêche la transaction de se finir correctement.</dd> +</dl> + +<h2 id="Les_différents_modes">Les différents modes</h2> + +<p>Une transaction peut s'effectuer dans l'un de ces modes :</p> + +<table class="standard-table"> + <thead> + <tr> + <th scope="col">Valeur</th> + <th scope="col">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td> + <p>"readonly"</p> + + <p>(0 dans Chrome)</p> + </td> + <td>Ce mode permet de lire les données mais pas de les modifier.</td> + </tr> + <tr> + <td> + <p>"readwrite"</p> + + <p>(1 dans Chrome)</p> + </td> + <td>Ce mode permet de lire, d'écrire et de modifier les données du magasin d'objets.</td> + </tr> + <tr> + <td> + <p>"versionchange"</p> + + <p>(2 dans Chrome)</p> + </td> + <td>Ce mode permet d'effectuer toutes les opérations, y compris l'ajout ou la suppression de magasins d'objets et d'index. Ce mode doit être utilisé pour mettre à jour le numéro de version utilisé par les transactions démarées avec la méthode <a href="/fr/docs/Web/API/IDBDatabase"><code>setVersion()</code></a> de <code><a href="/fr/docs/Web/API/IDBDatabase">IDBDatabase</a></code>. Les transactions lancées dans ce mode ne peuvent pas être lancées en même temps que d'autres transactions. Ces transactions sont parfois qualifiées comme « transactions de mise à jour ».</td> + </tr> + </tbody> +</table> + +<h2 id="Exemples">Exemples</h2> + +<p>Dans l'exemple qui suit, on ouvre une transaction en lecture/écriture sur la base de données et on ajoute des données dans le magasin d'objet. On notera également l'utilisation des gestionnaires d'évènements attachés à la transaction qui permettent d'indiquer la réussite ou l'échec de l'ouverture de la transaction. Pour un exemple complet, voir <a href="https://github.com/mdn/to-do-notifications/">l'application de notifications To-do</a> (<a href="https://mdn.github.io/to-do-notifications/">voir également la démonstration <em>live</em></a>)</p> + +<pre class="brush: js">// On commence par ouvrir la base de données +var DBOpenRequest = window.indexedDB.open("toDoList", 4); + +DBOpenRequest.onsuccess = function(event) { + note.innerHTML += '<li>Initialisation de la base.</li>'; + + // On enregistre le résultat de l'ouverture + // dans la variable db afin de l'utiliser + // ensuite + var db = DBOpenRequest.result; + + // On utilise la fonction addData() afin d'ajouter + // des données à la base de données + addData(); +}; + +function addData() { + // On crée un nouvel objet prêt à être inséré + // dans la base de données + var newItem = [ { taskTitle: "Promener le chien", hours: 19, minutes: 30, day: 24, month: "Décembre", year: 2013, notified: "no" } ]; + + // On ouvre une transaction en lecture/écriture + // vers la base de données afin d'ajouter des + // données + var transaction = db.transaction(["toDoList"], "readwrite"); + + // On indique le succès de la transaction + transaction.oncomplete = function(event) { + note.innerHTML += '<li>Transaction terminée : modification finie.</li>'; + }; + + + transaction.onerror = function(event) { + note.innerHTML += '<li>Transaction non-ouverte à cause d'une erreur. Les doublons ne sont pas autorisés.</li>'; + }; + + // On crée un magasin d'objet pour la transaction + var objectStore = transaction.objectStore("toDoList"); + + // On ajoute l'objet newItem au magasin d'objets + var objectStoreRequest = objectStore.add(newItem[0]); + + objectStoreRequest.onsuccess = function(event) { + // On indique le succès de l'ajout de l'objet + // dans la base de données + note.innerHTML += '<li>Un nouvel élément a été ajouté dans la base de données.</li>'; + }; +};</pre> + +<h2 id="Spécifications">Spécifications</h2> + +<table class="standard-table"> + <tbody> + <tr> + <th scope="col">Spécification</th> + <th scope="col">État</th> + <th scope="col">Commentaires</th> + </tr> + <tr> + <td>{{SpecName('IndexedDB', '#transaction', 'IDBTransaction')}}</td> + <td>{{Spec2('IndexedDB')}}</td> + <td>Définition initiale</td> + </tr> + </tbody> +</table> + +<h2 id="Compatibilité_des_navigateurs">Compatibilité des navigateurs</h2> + +<p>{{Compat("api.IDBTransaction")}}</p> + +<h2 id="Voir_aussi">Voir aussi</h2> + +<ul> + <li><a href="/fr/docs/Web/API/API_IndexedDB/Using_IndexedDB">Utiliser IndexedDB</a></li> + <li>Initier une connexion : {{domxref("IDBDatabase")}}</li> + <li>Utiliser les transactions : {{domxref("IDBTransaction")}}</li> + <li>Définir un intervalle de clés : {{domxref("IDBKeyRange")}}</li> + <li>Récupérer et modifier les données : {{domxref("IDBObjectStore")}}</li> + <li>Utiliser les curseurs {{domxref("IDBCursor")}}</li> + <li>Exemple de référence : <a href="https://github.com/mdn/to-do-notifications/tree/gh-pages">To-do Notifications</a> (<a href="https://mdn.github.io/to-do-notifications/">exemple <em>live</em></a>).</li> +</ul> |