Base de conocimientosCentro de exámenes
ESEspañol
Elegir idioma13

CKTIS / JavaScript

IDBIndex — consultar un índice de IndexedDB

IDBIndex permite acceder a los registros de un almacén de objetos mediante una clave secundaria. Compara la obtención de un array con getAll() con la iteración de un cursor mediante openCursor(), y distingue las claves del índice de las claves principales.

Versión: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Sintaxis

const index = transaction.objectStore(storeName).index(indexName);
const valuesRequest = index.getAll(query, count);
const cursorRequest = index.openCursor(query, "next");

IDBIndex es una referencia al índice secundario de un almacén de objetos de IndexedDB, no un constructor que se deba usar directamente. Crea el índice con createIndex() durante upgradeneeded; más adelante, obténlo con store.index(name) dentro de una transacción. El índice se actualiza automáticamente junto con el almacén.

IDBIndex.getAll(query, count) devuelve un IDBRequest, no una Promise. El resultado es un array de valores del almacén o [] si no hay coincidencias. query acepta una clave de índice o un IDBKeyRange; si se omite, coinciden todas las entradas. El parámetro opcional count limita el número de resultados. Si vale 0 o se omite, se devuelven todas las coincidencias. El orden es ascendente por clave de índice y, después, por clave principal.

IDBIndex.openCursor(query, direction) también devuelve un IDBRequest. En success, lee el cursor o null cuando no quedan resultados; continue() inicia el siguiente paso. cursor.key es la clave de índice, cursor.primaryKey es la clave del almacén y cursor.value es el registro. La dirección predeterminada es "next"; también están disponibles "prev", "nextunique" y "prevunique".

Un cursor permite procesar los datos de forma progresiva; getAll() materializa todo el array de resultados. Realiza las solicitudes mientras la transacción esté activa; no intercales entre ellas un await que no esté relacionado. El ejemplo usa la sintaxis de IndexedDB 2.0, sin la forma más reciente de opciones de getAll(). Comprueba el navegador de destino: disponer de Node 24 no demuestra que esta API web esté admitida.

Ejemplos

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>IDBIndex: querying a secondary key</title>
</head>
<body>
  <h1>Querying an IndexedDB index</h1>
  <script>
    (() => {
      const name = 'cktis-index-' + crypto.getRandomValues(new Uint32Array(4)).join('-');
      const report = error => console.log(error.name === 'SecurityError'
        ? 'IndexedDB unavailable: SecurityError' : `IndexedDB error: ${error.name}`);
      let factory, opening;
      try {
        factory = window.indexedDB;
        if (!factory) {
          console.log('IndexedDB unavailable: API missing');
          return;
        }
        opening = factory.open(name, 1);
      } catch (error) {
        report(error);
        return;
      }
      let created = false;
      opening.onerror = () => report(opening.error);
      opening.onupgradeneeded = () => {
        created = true;
        const store = opening.result.createObjectStore('tokens', { keyPath: 'id' });
        store.createIndex('byColor', 'color');
        store.add({ id: 2, color: 'blue', token: 'square' });
        store.add({ id: 1, color: 'blue', token: 'circle' });
        store.add({ id: 3, color: 'red', token: 'triangle' });
      };
      opening.onsuccess = () => {
        const db = opening.result;
        if (!created) {
          db.close();
          console.log('Fixture name already in use');
          return;
        }
        const tx = db.transaction('tokens', 'readonly');
        const index = tx.objectStore('tokens').index('byColor');
        const all = index.getAll('blue');
        const scan = index.openCursor('blue');
        const rows = [];
        scan.onsuccess = () => {
          const cursor = scan.result;
          if (cursor) {
            rows.push([cursor.key, cursor.primaryKey, cursor.value.token]);
            cursor.continue();
          }
        };
        const cleanup = () => {
          db.close();
          factory.deleteDatabase(name);
        };
        tx.oncomplete = () => {
          console.log(JSON.stringify(all.result.map(record => record.token)));
          console.log(JSON.stringify(rows));
          cleanup();
        };
        tx.onabort = () => {
          report(tx.error);
          cleanup();
        };
      };
    })();
  </script>
</body>
</html>

Resultado

When IndexedDB access is allowed and the query succeeds, both lines show matches for the index key "blue" in ascending primary-key order:
["circle","square"]
[["blue",1,"circle"],["blue",2,"square"]]

If the browser denies IndexedDB access with a SecurityError, the example logs instead:
IndexedDB unavailable: SecurityError

El código mostrado y el resultado declarado se verificaron en un entorno aislado mediante el método registrado en la evidencia de verificación de esta versión exacta.

Fuentes