Base de conhecimentoCentro de Exames
PT · PTPortuguês (Portugal)
Escolher idioma13

CKTIS / JavaScript

IDBIndex — consultar um índice IndexedDB

IDBIndex expõe os registos de um object store através de uma chave secundária. Compara a obtenção de um array com getAll() com a iteração de um cursor por openCursor(), e distingue as chaves do índice das chaves primárias.

Versão: ECMAScript and Web APIs; exact feature edition and browser support reviewed per entry; Node 24 in repository does not prove browser API support

Sintaxe

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

IDBIndex é uma referência ao índice secundário de um object store IndexedDB, não um construtor para utilização directa. Cria o índice com createIndex() durante upgradeneeded; mais tarde, obtém-no com store.index(name) dentro de uma transacção. O índice é actualizado automaticamente com o object store.

IDBIndex.getAll(query, count) devolve um IDBRequest, não uma Promise. O resultado é um array de valores do object store ou [] se não houver correspondências. query aceita uma chave de índice ou um IDBKeyRange; se for omitido, todas as entradas correspondem. O parâmetro opcional count limita o número de resultados. Se for 0 ou for omitido, são devolvidas todas as correspondências. A ordenação é crescente pela chave do índice e, em seguida, pela chave primária.

IDBIndex.openCursor(query, direction) também devolve um IDBRequest. Em success, lê o cursor ou null quando já não houver resultados; continue() inicia o passo seguinte. cursor.key é a chave do índice, cursor.primaryKey é a chave do object store e cursor.value é o registo. A direcção predefinida é "next"; também estão disponíveis "prev", "nextunique" e "prevunique".

Um cursor permite o processamento gradual; getAll() materializa todo o array de resultados. Emite os pedidos enquanto a transacção estiver activa; não intercales entre eles um await sem relação. O exemplo usa a sintaxe IndexedDB 2.0, sem a forma mais recente de opções de getAll(). Verifica o navegador de destino: ter Node 24 não comprova o suporte desta Web API.

Exemplos

<!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

O código apresentado e o resultado declarado foram verificados num ambiente isolado pelo método registado na prova de verificação desta versão exata.

Fontes