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

CKTIS / JavaScript

IDBCursor — percorrer registos do IndexedDB

IDBCursor lê registos do IndexedDB sequencialmente, por ordem das chaves. Um cursor com valor expõe cursor.value, enquanto cursor.continue() avança de forma assíncrona para o registo seguinte.

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 request = store.openCursor();
request.onsuccess = () => {
  const cursor = request.result;
  if (!cursor) return;
  const value = cursor.value;
  cursor.continue();
};

IDBCursor representa uma posição durante a passagem por um object store ou índice do IndexedDB. openCursor() devolve um IDBRequest, não um cursor. Lê request.result em onsuccess; se não houver cursor, a iteração termina. A direção predefinida, next, significa ordem crescente das chaves, não ordem de inserção.

O nome IDBCursor.value é uma abreviatura descritiva: a propriedade value é, na realidade, definida por IDBCursorWithValue, que herda de IDBCursor. openCursor() expõe esse cursor; openKeyCursor() não expõe value. Alterar um objeto devolvido por cursor.value não guarda as alterações; para as guardar, utiliza update() numa transação readwrite.

IDBCursor.continue, chamado como cursor.continue(), agenda o passo seguinte e devolve undefined, não uma Promise. O resultado chega num novo evento success da mesma operação. Chama o método uma vez por passo numa transação ativa: voltar a chamá-lo antes do resultado provoca InvalidStateError, enquanto uma transação inativa provoca TransactionInactiveError. Não aguardes por operações assíncronas sem relação entre passos.

Esta é uma Web API, não faz parte de ECMAScript; ter Node 24 não comprova que exista suporte. As operações descritas estão especificadas em Indexed Database API 2.0 e 3.0. Verifica o suporte e a disponibilidade de armazenamento no browser de destino.

Exemplos

<!doctype html>
<html lang="en">
<head>
  <meta charset="utf-8">
  <title>Iterating records with IDBCursor</title>
</head>
<body>
<script>
  (() => {
    // This disposable name does not require a secure-context API.
    const name = `cktis-cursor-${Date.now()}-${Math.random()}`;
    const unavailable = () => console.log('IndexedDB unavailable in this context.');
    let open;
    try {
      open = indexedDB.open(name, 1);
    } catch {
      unavailable();
      return;
    }
    open.onerror = unavailable;
    open.onupgradeneeded = () => {
      const store = open.result.createObjectStore('items');
      store.put('Beta', 2);
      store.put('Alpha', 1);
    };
    open.onsuccess = () => {
      const db = open.result;
      const rows = [];
      const tx = db.transaction('items', 'readonly');
      const request = tx.objectStore('items').openCursor();
      request.onsuccess = () => {
        const cursor = request.result;
        if (cursor === null) return;
        rows.push(`${cursor.key}: ${cursor.value}`);
        cursor.continue();
      };
      function cleanup() {
        db.close();
        indexedDB.deleteDatabase(name);
      }
      tx.oncomplete = () => {
        for (const row of rows) console.log(row);
        cleanup();
      };
      tx.onabort = () => {
        cleanup();
        console.log('Cursor transaction aborted.');
      };
    };
  })();
</script>
</body>
</html>

Resultado

1: Alpha
2: Beta

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