CKTIS / JavaScript
IndexedDB: leer y mover un cursor con `value` y `continue()`
Lee el valor del registro actual de un cursor de IndexedDB y solicita el siguiente registro o salta a una posición determinada por una clave.
Versión: ECMAScript 2024 and the current web platform; runtime support varies
Sintaxis
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 undefinedIDBCursor.value/continue agrupa dos miembros de la API: la propiedad de solo lectura IDBCursorWithValue.value y el método heredado IDBCursor.continue(). Si una solicitud openCursor() entrega un cursor, cursor.value da el valor almacenado del registro actual. Modificar campos del objeto recuperado no guarda los cambios; para escribirlos, usa, por ejemplo, cursor.update() en una transacción readwrite. Un cursor de openKeyCursor() tiene continue(), pero no la propiedad value.
cursor.continue() solicita el siguiente registro que cumpla los criterios en la dirección del cursor y devuelve undefined. cursor.continue(key) busca la primera posición posterior con clave >= key para next o nextunique, o <= key para prev o prevunique. La clave de destino no tiene por qué existir y el rango original sigue vigente. Se compara la clave primaria en un almacén de objetos y la clave de índice (cursor.key) en un índice.
Lee request.result en cada evento success de la misma solicitud. null significa que no hubo coincidencias o que terminó el recorrido. Lee el valor y llama a continue() como máximo una vez antes de ceder el control a una tarea posterior, como una función de retorno de un temporizador. Una clave inválida o que no esté estrictamente más adelante en la dirección elegida provoca DataError. Repetir la llamada antes del siguiente resultado, no tener una posición actual o tener un origen del cursor eliminado puede provocar InvalidStateError. Una transacción inactiva causa TransactionInactiveError.
IndexedDB es una API web, no parte de ECMAScript 2024. Su disponibilidad depende del entorno de ejecución y del contexto. El acceso a los datos está sujeto a la política del mismo origen.
Ejemplos
<!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>Resultado
1: Ada 4: Lin Done
Abre este documento HTML por HTTPS como página de nivel superior en un navegador donde estén disponibles IndexedDB y `crypto.randomUUID()`. Consulta la salida en la consola de desarrollo. El ejemplo crea una base de pruebas independiente y solicita su eliminación al terminar. `continue(3)` omite la clave `2` y llega a `4` porque no existe la clave `3`. El siguiente `continue()` da un resultado `null` y el controlador muestra `Done`.
Lecciones relacionadas
- JavaScript · Lección 21 · Intermedio · Versión: 3
Fuentes
- IDBCursorWithValue: value property
- IDBCursor: continue() method
- IDBObjectStore: openCursor() method
- IDBIndex: openCursor() method
- IDBObjectStore: openKeyCursor() method
- IDBCursor: update() method
- IDBTransaction
- IndexedDB API
- Crypto: randomUUID() method
- IDBFactory: deleteDatabase() method
- ECMAScript 2024 Language Specification: Hosts and Implementations