From 33058f2b292b3a581333bdfb21b8f671898c5060 Mon Sep 17 00:00:00 2001 From: Peter Bengtsson Date: Tue, 8 Dec 2020 14:40:17 -0500 Subject: initial commit --- files/fr/web/api/idbindex/openkeycursor/index.html | 228 +++++++++++++++++++++ 1 file changed, 228 insertions(+) create mode 100644 files/fr/web/api/idbindex/openkeycursor/index.html (limited to 'files/fr/web/api/idbindex/openkeycursor/index.html') diff --git a/files/fr/web/api/idbindex/openkeycursor/index.html b/files/fr/web/api/idbindex/openkeycursor/index.html new file mode 100644 index 0000000000..09f7003c12 --- /dev/null +++ b/files/fr/web/api/idbindex/openkeycursor/index.html @@ -0,0 +1,228 @@ +--- +title: IDBIndex.openKeyCursor() +slug: Web/API/IDBIndex/openKeyCursor +tags: + - API + - IDBIndex + - IndexedDB + - Méthode + - Reference + - openKeyCursor +translation_of: Web/API/IDBIndex/openKeyCursor +--- +
{{APIRef("IndexedDB")}}
+ +

La méthode openKeyCursor() de {{domxref("IDBIndex")}} renvoie un objet {{domxref("IDBRequest")}} et, dans un thread séparé, crée un curseur sur l'intervalle de clé passé en argument pour l'index courant.

+ +

Cette méthode positionne le curseur sur la clé appropriée, dans la direction indiquée :

+ + + +

{{AvailableInWorkers}}

+ +

Syntaxe

+ +
var monIndex = objectStore.index("index");
+var request = monIndex.openKeyCursor(keyRange,direction);
+ +

Paramètres

+ +
+
keyRange {{optional_inline}}
+
L'{{domxref("IDBKeyRange","intervalle de clé")}} sur lequel se déplace le curseur. On peut passer un clé seule qui sera alors considéré comme une {{domxref("IDBKeyRange.only","intervalle seule")}}. Par défaut le curseur se déplace sur l'ensemble des clés de l'index.
+
direction {{optional_inline}}
+
La {{domxref("IDBCursor.direction","direction")}} du {{domxref("IDBCursor","curseur")}} qui défini le sens d'itération. par défaut "next".
+
+ +

Valeur de retour

+ +

Un objet {{domxref("IDBRequest")}} sur lequel on peut écouter les évènements associés à l'opération lancée par la méthode.

+ +

Exceptions

+ +

Cette méthode peut lever une exception :

+ + + + + + + + + + + + + + + + + + + + + + + + + + +
Type d'exceptionDescription
TransactionInactiveErrorLa transaction pour cet index {{domxref("IDBIndex")}} est inactive.
TypeErrorLa valeur du paramètre pour la direction est invalide.
DataError +

La clé ou l'intervalle de clé fourni contient une clé invalide.

+
InvalidStateErrorL'index {{domxref("IDBIndex")}} a été supprimé ou déplacé.
+ +

Exemple

+ +

Dans l'exemple suivant on ouvre une transaction puis un magasin d'objet et enfin l'index lName.

+ +

Ensuite, on itère sur l'ensemble des enregistrements pour en insérer leur clé dans un tableau HTML. En utilisant la méthode {{domxref("IDBIndex.openKeyCursor")}} qui travaille de la même façon que la méthode {{domxref("IDBObjectStore.openKeyCursor")}} de l'{{domxref("IDBObjectStore","accès")}} au magasin d'objet sauf que les enregistrements sont renvoyés dans l'ordre de l'index et non celui du magasin d'objet.

+ +
function displayDataByIndex() {
+  tableEntry.innerHTML = '';
+
+  //ouvre un transaction
+  var transaction = db.transaction(['contactsList'], 'readonly');
+  //accés au magasin d'objet
+  var objectStore = transaction.objectStore('contactsList');
+
+  //on récupère l'index
+  var myIndex = objectStore.index('lName');
+
+  //un curseur qui itère sur l'index
+  var request = myIndex.openCursor();
+  request.onsuccess = function(event) {
+    var cursor = request.result;
+    if(cursor) {
+
+
+      // cursor.key la clé de l'enregistrement à la position du curseur
+      // il n'y as pas de cursor.value contrairement à openCursor()
+
+      var tableRow = document.createElement('tr');
+      tableRow.innerHTML =   '<td>' + cursor.key + '</td>'
+      tableEntry.appendChild(tableRow);
+
+      //on relance la requête pour la position suivante du curseur
+      cursor.continue();
+    } else {
+      console.log('Toutes les clé ont été affichés.');
+    }
+  };
+};
+ +

Note : pour un exemple fonctionnel complet, voir notre application To-do (exemple).

+ +

Spécifications

+ + + + + + + + + + + + + + +
SpécificationÉtatCommentaires
{{SpecName('IndexedDB', '#widl-IDBIndex-openKeyCursor-IDBRequest-any-range-IDBCursorDirection-direction', 'openKeyCursor()')}}{{Spec2('IndexedDB')}} 
+ +

Browser compatibility

+ +
{{CompatibilityTable}}
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FonctionnalitéChromeEdgeFirefox (Gecko)Internet ExplorerOperaSafari (WebKit)
Support simple23{{property_prefix("webkit")}}
+ 24
{{CompatVersionUnknown}}10 {{property_prefix("moz")}}
+ {{CompatGeckoDesktop("16.0")}}
10, partial157.1
Disponible pour les web workers{{CompatVersionUnknown}}{{CompatVersionUnknown}}{{CompatGeckoMobile("37.0")}}{{CompatUnknown}}{{CompatVersionUnknown}}{{CompatUnknown}}
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
FeatureAndroidWebview AndroidEdgeFirefox Mobile (Gecko)Firefox OSIE PhoneOpera MobileSafari MobileChrome pour Android
Support simple4.4{{CompatVersionUnknown}}{{CompatVersionUnknown}}{{CompatGeckoMobile("22.0")}}1.0.110228{{CompatVersionUnknown}}
Disponible pour les web workers{{CompatVersionUnknown}}{{CompatVersionUnknown}}{{CompatVersionUnknown}}{{CompatGeckoMobile("37.0")}}{{CompatVersionUnknown}}{{CompatUnknown}}{{CompatVersionUnknown}}{{CompatUnknown}}{{CompatVersionUnknown}}
+
+ +

Voir aussi

+ + -- cgit v1.2.3-54-g00ecf