diff options
Diffstat (limited to 'files/fr/web/api/idbindex/getkey/index.md')
| -rw-r--r-- | files/fr/web/api/idbindex/getkey/index.md | 152 |
1 files changed, 73 insertions, 79 deletions
diff --git a/files/fr/web/api/idbindex/getkey/index.md b/files/fr/web/api/idbindex/getkey/index.md index 828f700fb9..b64e69aaff 100644 --- a/files/fr/web/api/idbindex/getkey/index.md +++ b/files/fr/web/api/idbindex/getkey/index.md @@ -9,68 +9,74 @@ tags: - Reference translation_of: Web/API/IDBIndex/getKey --- -<div>{{APIRef("IndexedDB")}}</div> +{{APIRef("IndexedDB")}} -<p>La méthode <strong><code>getKey()</code></strong>, rattachée à l'interface {{domxref("IDBIndex")}}, renvoie un objet {{domxref("IDBRequest")}} et, dans un <em>thread</em> séparé, récupère la clé associée ou la clé primaire si l'argument passé à la fonction est un intervalle {{domxref("IDBKeyRange")}}.</p> +La méthode **`getKey()`**, rattachée à l'interface {{domxref("IDBIndex")}}, renvoie un objet {{domxref("IDBRequest")}} et, dans un _thread_ séparé, récupère la clé associée ou la clé primaire si l'argument passé à la fonction est un intervalle {{domxref("IDBKeyRange")}}. -<p>Si la méthode trouve une clé, ce sera alors la propriété <code>result</code> de la requête renvoyée. Seule la clé primaire de l'enregistrement est renvoyée (pour obtenir l'ensemble de l'enregistrement, on utilisera {{domxref("IDBIndex.get")}}).</p> +Si la méthode trouve une clé, ce sera alors la propriété `result` de la requête renvoyée. Seule la clé primaire de l'enregistrement est renvoyée (pour obtenir l'ensemble de l'enregistrement, on utilisera {{domxref("IDBIndex.get")}}). -<p>{{AvailableInWorkers}}</p> +{{AvailableInWorkers}} -<h2 id="Syntaxe">Syntaxe</h2> +## Syntaxe -<pre class="brush: js">var myIndex = objectStore.index('index'); -var request = myIndex.getKey(key);</pre> +```js +var myIndex = objectStore.index('index'); +var request = myIndex.getKey(key); +``` -<h3 id="Paramètres">Paramètres</h3> +### Paramètres -<dl> - <dt><code>key</code> {{optional_inline}}</dt> - <dd>Une clé ou un intervalle {{domxref("IDBKeyRange")}} qui identifie l'enregistrement dont on souhaite obtenir la clé. Si la valeur vaut {{jsxref("null")}} ou si elle est absente, le navigateur utilisera un intervalle de clé sans limite.</dd> -</dl> +- `key` {{optional_inline}} + - : Une clé ou un intervalle {{domxref("IDBKeyRange")}} qui identifie l'enregistrement dont on souhaite obtenir la clé. Si la valeur vaut {{jsxref("null")}} ou si elle est absente, le navigateur utilisera un intervalle de clé sans limite. -<h3 id="Valeur_de_retour">Valeur de retour</h3> +### Valeur de retour -<p>Un objet {{domxref("IDBRequest")}} qui recevra les différents évènements relatifs à l'opération qui est déclenchée.</p> +Un objet {{domxref("IDBRequest")}} qui recevra les différents évènements relatifs à l'opération qui est déclenchée. -<h3 id="Exceptions">Exceptions</h3> +### Exceptions -<p>Cette méthode peut déclencher une exception. Celle-ci peut avoir l'un des types suivants :</p> +Cette méthode peut déclencher une exception. Celle-ci peut avoir l'un des types suivants : <table class="standard-table"> - <thead> - <tr> - <th scope="col">Exception</th> - <th scope="col">Description</th> - </tr> - </thead> - <tbody> - <tr> - <td>TransactionInactiveError</td> - <td>La transaction rattachée à cet <code>IDBIndex</code> est inactive.</td> - </tr> - <tr> - <td><code>DataError</code></td> - <td> - <p>La clé ou l'intervalle de clés qui est fourni contient une clé invalide.</p> - </td> - </tr> - <tr> - <td><code>InvalidStateError</code></td> - <td>L'index a été supprimé ou déplacé.</td> - </tr> - </tbody> + <thead> + <tr> + <th scope="col">Exception</th> + <th scope="col">Description</th> + </tr> + </thead> + <tbody> + <tr> + <td>TransactionInactiveError</td> + <td> + La transaction rattachée à cet <code>IDBIndex</code> est inactive. + </td> + </tr> + <tr> + <td><code>DataError</code></td> + <td> + <p> + La clé ou l'intervalle de clés qui est fourni contient une clé + invalide. + </p> + </td> + </tr> + <tr> + <td><code>InvalidStateError</code></td> + <td>L'index a été supprimé ou déplacé.</td> + </tr> + </tbody> </table> -<h2 id="Exemples">Exemples</h2> +## Exemples -<p>Dans l'exemple qui suit, on ouvre une transaction et un magasin d'objets. Ensuite on récupère l'index <code>lName</code> sur cette base de donnée. On ouvre alors un curseur sur l'index grâce à la méthode {{domxref("IDBIndex.openCursor")}} (cela fonctionne de la même façon que {{domxref("IDBObjectStore.openCursor")}} sauf que les enregistrements sont triés selon l'index et pas selon la clé primaire).</p> +Dans l'exemple qui suit, on ouvre une transaction et un magasin d'objets. Ensuite on récupère l'index `lName` sur cette base de donnée. On ouvre alors un curseur sur l'index grâce à la méthode {{domxref("IDBIndex.openCursor")}} (cela fonctionne de la même façon que {{domxref("IDBObjectStore.openCursor")}} sauf que les enregistrements sont triés selon l'index et pas selon la clé primaire). -<p><code>myIndex.getKey('Bungle')</code> est ensuite utilisé afin d'obtenir la clé primaire de l'enregistrement pour lequel <code>lName</code> vaut <code>Bungle</code>. Le résultat de cette requête est imprimé dans la console lorsque la fonction de rappel (<em>callback</em>) de succès est déclenché.</p> +`myIndex.getKey('Bungle')` est ensuite utilisé afin d'obtenir la clé primaire de l'enregistrement pour lequel `lName` vaut `Bungle`. Le résultat de cette requête est imprimé dans la console lorsque la fonction de rappel (_callback_) de succès est déclenché. -<p>Enfin, on parcourt les enregistrements pour remplir un tableau HTML. Le dépôt <a href="https://github.com/mdn/IDBIndex-example">IDBIndex-example </a>contient un exemple complet (<a href="https://mdn.github.io/IDBIndex-example/">ainsi qu'une démonstration</a>).</p> +Enfin, on parcourt les enregistrements pour remplir un tableau HTML. Le dépôt [IDBIndex-example ](https://github.com/mdn/IDBIndex-example)contient un exemple complet ([ainsi qu'une démonstration](https://mdn.github.io/IDBIndex-example/)). -<pre class="brush: js">function displayDataByIndex() { +```js +function displayDataByIndex() { tableEntry.innerHTML = ''; var transaction = db.transaction(['contactsList'], 'readonly'); var objectStore = transaction.objectStore('contactsList'); @@ -84,14 +90,14 @@ var request = myIndex.getKey(key);</pre> var cursor = event.target.result; if(cursor) { var tableRow = document.createElement('tr'); - tableRow.innerHTML = '<td>' + cursor.value.id + '</td>' - + '<td>' + cursor.value.lName + '</td>' - + '<td>' + cursor.value.fName + '</td>' - + '<td>' + cursor.value.jTitle + '</td>' - + '<td>' + cursor.value.company + '</td>' - + '<td>' + cursor.value.eMail + '</td>' - + '<td>' + cursor.value.phone + '</td>' - + '<td>' + cursor.value.age + '</td>'; + tableRow.innerHTML = '<td>' + cursor.value.id + '</td>' + + '<td>' + cursor.value.lName + '</td>' + + '<td>' + cursor.value.fName + '</td>' + + '<td>' + cursor.value.jTitle + '</td>' + + '<td>' + cursor.value.company + '</td>' + + '<td>' + cursor.value.eMail + '</td>' + + '<td>' + cursor.value.phone + '</td>' + + '<td>' + cursor.value.age + '</td>'; tableEntry.appendChild(tableRow); cursor.continue(); @@ -99,37 +105,25 @@ var request = myIndex.getKey(key);</pre> console.log('Les éléments sont affichés.'); } }; -};</pre> +}; +``` -<h2 id="Spécification">Spécification</h2> +## Spécification -<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', '#widl-IDBIndex-getKey-IDBRequest-any-key', 'getKey()')}}</td> - <td>{{Spec2('IndexedDB')}}</td> - <td> </td> - </tr> - </tbody> -</table> +| Spécification | État | Commentaires | +| ------------------------------------------------------------------------------------------------------------ | ---------------------------- | ------------ | +| {{SpecName('IndexedDB', '#widl-IDBIndex-getKey-IDBRequest-any-key', 'getKey()')}} | {{Spec2('IndexedDB')}} | | -<h2 id="Compatibilité_des_navigateurs">Compatibilité des navigateurs</h2> +## Compatibilité des navigateurs -<p>{{Compat("api.IDBIndex.getKey")}}</p> +{{Compat("api.IDBIndex.getKey")}} -<h2 id="Voir_aussi">Voir aussi</h2> +## Voir aussi -<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>L'exemple de référence : <a href="https://github.com/mdn/to-do-notifications/tree/gh-pages">notifications de trucs à faire</a> (<a href="https://mdn.github.io/to-do-notifications/">voir la démonstration</a>)</li> -</ul> +- [Utiliser IndexedDB](/fr/docs/Web/API/API_IndexedDB/Using_IndexedDB) +- Initier une connexion : {{domxref("IDBDatabase")}} +- Utiliser les transactions : {{domxref("IDBTransaction")}} +- Définir un intervalle de clés : {{domxref("IDBKeyRange")}} +- Récupérer et modifier les données : {{domxref("IDBObjectStore")}} +- Utiliser les curseurs {{domxref("IDBCursor")}} +- L'exemple de référence : [notifications de trucs à faire](https://github.com/mdn/to-do-notifications/tree/gh-pages) ([voir la démonstration](https://mdn.github.io/to-do-notifications/)) |