IDBObjectStore.openKeyCursor()

Syntaxe

var reques = objectStore.openKeyCursor(optionalKeyRange, optionalDirection);

Paramètres

optionalKeyRange Facultatif

L'intervalle de clé sur lequel se déplace le curseur. On peut passer un clé seule qui sera alors considéré comme une intervalle seule. Par default  le curseur se deplace sur l'ensemble des clés du magasin d'objet.

optionalDirection Facultatif

La direction du curseur qui défini le sens d'itération. par défaut "next".

Renvoie

Une requête.

La propriété result de cette requête contient le curseur.

Exceptions

TransactionInactiveError

Cette exception est levé si la transaction est inactive.

DataError

Cette exception est levé si la clé ou l'intervalle de clé est invalide.

InvalidStateError

Cette exception est levé si le magasin d'objet ou l'index à été supprimé.

Exemple

Dans ce morceau de code on fait une transaction pour obtenir l'accès au magasin d'objet sur lequel on itère en utilisant un curseur.

La méthode openKeyCursor() initialise la requête récursive qui contiendra le curseur.

//un transaction sur la base de données
var transaction = db.transaction("name", "readonly");

//un accès au magsin d'objet "name"
var objectStore = transaction.objectStore("name");

//Une requête récursive
var request = objectStore.openKeyCursor();
request.onsuccess = function() {
  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()
    console.log(cursor.key);
    //on relance la requête pour la position suivante du curseur
    cursor.continue();
  } else {
    //pas ou plus de curseur , fin d'itération.
  }
};

Spécification

Compatibilité avec les navigateurs

Voir aussi

• Utiliser IndexedDB
• Débuter une connexion
• Utilisé les transactions
• Définir l'intervalle des clés
• Accès aux magasins d'objets
• Utiliser les curseur
• Exemple de référence: To-do Notifications (view example live.)