Base de connaissancesCentre d’examen
FRFrançais
Choisir la langue13

CKTIS / JavaScript

IndexedDB : lire et déplacer un curseur avec `value` et `continue()`

Lisez la valeur de l’enregistrement courant d’un curseur IndexedDB, puis demandez le suivant ou avancez jusqu’à une position déterminée par une clé.

Version : ECMAScript 2024 and the current web platform; runtime support varies

Syntaxe

cursor.value           // Read-only property of IDBCursorWithValue
cursor.continue()      // Request the next eligible position; returns undefined
cursor.continue(key)   // Request the next eligible position at or beyond key in the cursor's direction; returns undefined

IDBCursor.value/continue désigne deux éléments de l’API : la propriété en lecture seule IDBCursorWithValue.value et la méthode héritée IDBCursor.continue(). Lorsqu’une requête openCursor() fournit un curseur, cursor.value donne la valeur stockée de l’enregistrement courant. Modifier les champs de l’objet obtenu ne sauvegarde rien. Pour écrire, utilisez par exemple cursor.update() dans une transaction readwrite. Un curseur issu de openKeyCursor() possède continue(), mais pas value.

cursor.continue() demande le prochain enregistrement admissible dans le sens du parcours et renvoie undefined. cursor.continue(key) vise la première position suivante dont la clé est >= key avec next ou nextunique, ou <= key avec prev ou prevunique. La clé cible n’a pas besoin d’exister et la plage initiale reste applicable. La comparaison porte sur la clé primaire pour un magasin d’objets et sur la clé d’index (cursor.key) pour un index.

Lisez request.result à chaque événement success de la même requête. null indique qu’il n’y a aucun résultat ou que le parcours est terminé. Lisez la valeur et appelez continue() au plus une fois avant de passer à une tâche ultérieure, par exemple un rappel de temporisateur. Une clé invalide ou qui ne se trouve pas strictement plus loin dans le sens du parcours provoque DataError. Un nouvel appel avant le résultat suivant, l’absence de position courante ou la suppression de la source peut provoquer InvalidStateError. Une transaction inactive provoque TransactionInactiveError.

IndexedDB est une API Web, pas une fonctionnalité d’ECMAScript 2024. Sa disponibilité dépend de l’environnement d’exécution et du contexte. L’accès aux données respecte la politique de même origine.

Exemples

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>IndexedDB cursor example</title>
</head>
<body>
<script>
(() => {
  const name = `cktis-cursor-${crypto.randomUUID()}`;
  const open = indexedDB.open(name, 1);

  open.onupgradeneeded = () => {
    const store = open.result.createObjectStore('items');
    store.add({ name: 'Ada' }, 1);
    store.add({ name: 'Bo' }, 2);
    store.add({ name: 'Lin' }, 4);
  };
  open.onerror = () => console.error(open.error);

  open.onsuccess = () => {
    const db = open.result;
    const tx = db.transaction('items', 'readonly');
    const request = tx.objectStore('items').openCursor();

    const cleanup = () => {
      db.close();
      const deletion = indexedDB.deleteDatabase(name);
      deletion.onerror = () => console.error(deletion.error);
    };
    tx.oncomplete = cleanup;
    tx.onabort = () => {
      console.error(tx.error);
      cleanup();
    };

    request.onsuccess = () => {
      const cursor = request.result;
      if (cursor === null) {
        console.log('Done');
        return;
      }
      console.log(`${cursor.key}: ${cursor.value.name}`);
      if (cursor.key === 1) {
        cursor.continue(3);
      } else {
        cursor.continue();
      }
    };
  };
})();
</script>
</body>
</html>

Résultat

1: Ada
4: Lin
Done

Ouvrez ce document HTML en HTTPS comme page de premier niveau dans un navigateur où IndexedDB et `crypto.randomUUID()` sont disponibles. Consultez la sortie dans la console de développement. L’exemple crée une base de test distincte et demande sa suppression à la fin. `continue(3)` saute la clé `2` et atteint `4`, car la clé `3` est absente. Le `continue()` suivant donne un résultat `null`, et le gestionnaire affiche `Done`.

Leçons associées

  • JavaScript · Leçon 21 · Intermédiaire · Version : 3

Sources