CKTIS / JavaScript
IndexedDB: crear un índice, insertar un registro y consultar por índice
Crea un índice secundario durante una actualización de la base de datos, inserta sin sobrescribir y busca por la clave del índice en vez de por la clave primaria.
Versión: Current web platform; runtime support varies
Sintaxis
store.createIndex(name, keyPath)
store.createIndex(name, keyPath, { unique, multiEntry })
store.add(value)
store.add(value, key)
store.index(name)createIndex(), add() e index() son métodos de instancia de IDBObjectStore en la API web IndexedDB, no en ECMAScript. IndexedDB aplica la política del mismo origen; su disponibilidad depende del entorno de ejecución y de la configuración de almacenamiento del navegador.
store.createIndex(name, keyPath, options) devuelve un IDBIndex de inmediato, pero el cambio de esquema solo es definitivo si se confirma la transacción. Llámalo en una transacción versionchange activa, normalmente en upgradeneeded al crear la base de datos o aumentar su versión. El nombre identifica el índice; la ruta de clave determina la clave del índice a partir del registro sin añadirle un campo. IndexedDB indexa los registros existentes y mantiene el índice actualizado automáticamente.
unique y multiEntry valen false por defecto. unique: true prohíbe que distintos registros compartan una clave de índice; los duplicados existentes pueden abortar la actualización. multiEntry: true indexa por separado los elementos válidos de un array en vez de usar el array completo como clave. No se puede combinar con un array de rutas para una clave compuesta (InvalidAccessError). Un nombre de índice repetido lanza ConstraintError de inmediato.
store.add(value[, key]) inserta una copia estructurada sin sobrescribir. Requiere una transacción readwrite o versionchange activa. Omite key si la clave primaria está dentro del valor y proporciónala si es externa y no hay generador. Si la solicitud IDBRequest tiene éxito, result contiene la clave primaria, pero solo el evento complete de la transacción confirma la escritura. Una clave primaria o de índice único duplicada hace fallar la solicitud con ConstraintError. put() permite sustituir un registro, pero debe respetar igualmente la unicidad del índice.
store.index(name) devuelve el IDBIndex existente, ligado a la misma transacción. No crea un índice ni lee un registro. Un nombre inexistente provoca NotFoundError; se distinguen mayúsculas y minúsculas. En una transacción activa, index.get(key) solicita el primer registro que coincida con la clave del índice, no con la clave primaria. No reutilices ese objeto para leer después de que termine la transacción.
Ejemplos
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>IndexedDB: insert and look up a contact</title>
</head>
<body>
<script>
(async () => {
const { indexedDB, crypto } = window;
const name = `cktis-index-${crypto.randomUUID()}`;
const resultOf = (request) => new Promise((resolve, reject) => {
request.onsuccess = () => resolve(request.result);
request.onerror = () => reject(request.error);
});
const committed = (tx) => new Promise((resolve, reject) => {
tx.oncomplete = () => resolve();
tx.onabort = () => reject(tx.error ?? new Error('Transaction aborted'));
});
const open = indexedDB.open(name, 1);
open.onupgradeneeded = () => {
const store = open.result.createObjectStore('contacts', { keyPath: 'id' });
store.createIndex('byEmail', 'email', { unique: true });
};
const db = await resultOf(open);
let contact;
try {
const write = db.transaction('contacts', 'readwrite');
write.objectStore('contacts').add({ id: 7, email: 'ada@example.test' });
await committed(write);
const read = db.transaction('contacts', 'readonly');
const lookup = read.objectStore('contacts').index('byEmail').get('ada@example.test');
await committed(read);
contact = lookup.result;
} finally {
db.close();
await resultOf(indexedDB.deleteDatabase(name));
}
console.log(JSON.stringify(contact));
})().catch((error) => console.error(error));
</script>
</body>
</html>Resultado
{"id":7,"email":"ada@example.test"}Sirve el archivo HTML desde una dirección HTTPS de confianza y ábrelo en un navegador con IndexedDB y `crypto.randomUUID()` disponibles. El ejemplo crea una base de datos independiente, busca por `email` una vez confirmada la escritura y cierra y elimina la base antes de mostrar el resultado en la consola del navegador.
Lecciones relacionadas
- JavaScript · Lección 31 · Avanzado · Versión: 4