CKTIS / JavaScript
IndexedDB: crear un índice, insertar, contar y leer registros
Crea un índice secundario, inserta registros sin sobrescribirlos y consulta por clave primaria o por clave de índice.
Versión: ECMAScript 2024 and the current web platform; runtime support varies
Sintaxis
store.createIndex(name, keyPath)
store.createIndex(name, keyPath, options)
store.count()
store.count(query)
store.add(value)
store.add(value, key)
store.getAll()
store.getAll(query)
store.getAll(query, count)
store.getAll(options)
store.index(name)Un IDBObjectStore representa un almacén de objetos asociado a una transacción. Cada registro tiene una clave primaria y un valor. IndexedDB es una API web, no parte de ECMAScript; el acceso sigue la política del mismo origen.
createIndex(name, keyPath, options) devuelve un IDBIndex de inmediato, pero solo se puede llamar en una transacción versionchange activa, normalmente en upgradeneeded. La ruta de clave indica de dónde se extrae la clave de índice; no añade ningún campo al registro. unique: true impide las claves de índice duplicadas y multiEntry: true indexa por separado los elementos válidos de un array. Ambas opciones valen false por defecto. No puedes combinar multiEntry: true con una ruta de clave compuesta expresada como array de rutas.
add(value, key) guarda una copia estructurada y deja la nueva clave en request.result. Omite el segundo argumento si la clave está dentro del valor; indícalo si la clave se guarda por separado y no hay generador. Una clave primaria repetida o una infracción de unicidad del índice hace fallar la solicitud con ConstraintError. Usa put() para insertar o sustituir según la clave primaria.
count(query) da un número, mientras que getAll(query, count) da un array de copias de los valores, vacío si no hay coincidencias. Ambos aceptan una clave primaria o un IDBKeyRange y abarcan todo el almacén si no hay filtro. Un count positivo limita los valores devueltos por getAll(). Por defecto, el orden es ascendente por clave primaria. La forma más reciente getAll({ query, count, direction }) permite usar, por ejemplo, "prev"; comprueba la compatibilidad del navegador de destino.
index(name) devuelve de inmediato un IDBIndex existente de la misma transacción. Un nombre desconocido lanza NotFoundError; se distinguen mayúsculas y minúsculas. store.getAll("sci-fi") busca por clave primaria, mientras que store.index("byGenre").getAll("sci-fi") devuelve valores que coinciden por clave de índice.
add(), count() y getAll() devuelven un IDBRequest, no una Promise. Lee result tras success y gestiona error. En una transacción ordinaria, escribir exige el modo readwrite. Encola las solicitudes mientras esté activa: al esperar otra operación asíncrona, la transacción podría terminar. El éxito de una solicitud no confirma la transacción; para eso espera su evento complete.
Ejemplos
<!doctype html>
<meta charset="utf-8">
<title>IndexedDB object store methods</title>
<script>
(() => {
const dbName = `cktis-books-${crypto.randomUUID()}`;
const open = indexedDB.open(dbName, 1);
open.onupgradeneeded = () => {
const store = open.result.createObjectStore('books', { keyPath: 'id' });
store.createIndex('byGenre', 'genre');
};
open.onerror = () => console.error(open.error);
open.onsuccess = () => {
const db = open.result;
const tx = db.transaction('books', 'readwrite');
const store = tx.objectStore('books');
const cleanup = () => {
db.close();
const deletion = indexedDB.deleteDatabase(dbName);
deletion.onerror = () => console.error(deletion.error);
};
tx.onabort = () => {
console.error(tx.error);
cleanup();
};
const added = store.add({ id: 3, title: 'Orbit', genre: 'sci-fi' });
store.add({ id: 1, title: 'Dunes', genre: 'sci-fi' });
store.add({ id: 2, title: 'Herbs', genre: 'guide' });
const total = store.count();
const all = store.getAll();
const matches = store.index('byGenre').getAll('sci-fi');
tx.oncomplete = () => {
const titles = (request) => request.result.map((book) => book.title).join(', ');
console.log(`Added key: ${added.result}`);
console.log(`Total: ${total.result}`);
console.log(`All: ${titles(all)}`);
console.log(`Sci-fi: ${titles(matches)}`);
cleanup();
};
};
})();
</script>Resultado
Added key: 3 Total: 3 All: Dunes, Herbs, Orbit Sci-fi: Dunes, Orbit
Sirve este documento HTML por HTTPS, ábrelo en un navegador y consulta la consola de desarrollo. El ejemplo crea una base temporal separada y luego la elimina. Inserta tres libros fuera del orden de las claves primarias y, una vez confirmada la transacción, muestra todos los títulos por `id` y los elegidos por el índice de género.
Lecciones relacionadas
- JavaScript · Lección 21 · Intermedio · Versión: 3
Fuentes
- IDBObjectStore: createIndex() method
- IDBObjectStore: count() method
- IDBObjectStore: add() method
- IDBObjectStore: getAll() method
- IDBObjectStore: index() method
- IDBIndex: getAll() method
- IDBTransaction
- IDBTransaction: complete event
- IndexedDB key characteristics and basic terminology
- Using IndexedDB
- Crypto: randomUUID() method