IDBObjectStore.openKeyCursor()

Baseline Widely available

This feature is well established and works across many devices and browser versions. It’s been available across browsers since September 2021.

La méthode openKeyCursor(), rattachée à l'interface IDBObjectStore, renvoie un objet IDBRequest dont le résultat sera un curseur (IDBCursor) qui pourra être utilisé afin de parcourir les enregistrements correspondants. Cette méthode est utilisée afin de parcourir les clés d'un magasin d'objets grâce à un curseur.

Afin de déterminer si le curseur a bien été ajouté, on pourra écouter l'évènement success sur le résultat de la méthode.

Syntaxe

js
var requete = objectStore.openKeyCursor(optionalKeyRange, optionalDirection);

Paramètres

optionalKeyRange

L'intervalle de clés qu'on souhaite parcourir. Si une seule clé est fournie, l'intervalle constitué ne contiendra que cette clé. Si aucune valeur n'est passée en argument, le curseur produit parcourera tous les enregistrements du magasin d'objets.

optionalDirection

Un objet IDBCursorDirection qui indique la direction dans laquelle le curseur doit parcourir les évènements. La valeur par défaut est "next".

Valeur de retour

Un objet IDBRequest sur lequel seront déclenchés les différents évènements relatifs à cette opération.

Exceptions

Cette méthode peut déclencher une exception DOMException ayant l'un des types suivants :

Exception Description
InvalidStateError Le magasin d'objets (IDBObjectStore ou l'index (IDBIndex) a été supprimé.
TransactionInactiveError La transaction associée au magasin d'objet (IDBObjectStore) est inactive.
DataError La clé ou l'intervalle de clés indiqué est invalide.

Exemples

Dans le fragment de code suivant, on crée une transaction, on l'utilise sur un magasin d'objets donné puis on utilise le curseur pour parcourir tous les enregistrements du magasin d'objets :

js
var transaction = db.transaction("name", "readonly");
var objectStore = transaction.objectStore("name");
var request = objectStore.openKeyCursor();
request.onsuccess = function (event) {
  var cursor = event.target.result;
  if (cursor) {
    // cursor.key contient la clé de l'enregistrement courant
    // à la différence de openCursor, il n'y a pas de cursor.value
    cursor.continue();
  } else {
    // Il n'y a plus d'autres résultats
  }
};

Spécifications

Specification
Indexed Database API 3.0
# ref-for-dom-idbobjectstore-openkeycursor①

Compatibilité des navigateurs

BCD tables only load in the browser

Voir aussi