Ingeniería Systems: API IndexedDB

Una API de bajo nivel

La API estudiada en el capítulo anterior es útil para almacenamiento de pequeñas cantidades de datos, pero cuando se trata de grandes cantidades de datos estructurados debemos recurrir a un sistema de base de datos. La API IndexedDB es la solución provista por HTML5 a este respecto.

IndexedDB es un sistema de base de datos destinado a almacenar información indexada en el ordenador del usuario. Fue desarrollada como una API de bajo nivel con la intención de permitir un amplio espectro de usos. Esto la convierte en una de las API más poderosa de todas, pero también una de las más complejas. El objetivo fue proveer la estructura más básica posible para permitir a los desarrolladores construir librerías y crear interfaces de alto nivel para satisfacer necesidades específicas. En una API de bajo nivel como esta tenemos que hacernos cargo de cada aspecto y controlar las condiciones de cada proceso en toda operación realizada. El resultado es una API a la que la mayoría de los desarrolladores tardará en acostumbrarse y probablemente utilizará de forma indirecta a través de otras librerías populares construidas sobre ella que seguramente surgirán en un futuro cercano.

La estructura propuesta por IndexedDB es también diferente de SQL u otros sistemas de base de datos populares. La información es almacenada en la base de datos como objetos (registros) dentro de lo que es llamado Almacenes de Objetos (tablas). Los Almacenes de Objetos no tienen una estructura específica, solo un nombre e índices para poder encontrar los objetos en su interior. Estos objetos tampoco tienen una estructura definida, pueden ser diferentes unos de otros y tan complejos como necesitemos. La única condición para los objetos es que contengan al menos una propiedad declarada como índice para que sea posible encontrarlos en el Almacén de Objetos.

Base de datos

La base de datos misma es simple. Debido a que cada base de datos es asociada con un ordenador y un sitio web o aplicación, no existen usuarios para agregar o restricciones de acceso que debamos considerar. Solo necesitamos especificar el nombre y la versión, y la base de datos estará lista.

La interface declarada en la especificación para esta API provee el atributo indexedDB y el método open() para crear la base de datos. Este método retorna un objeto sobre el cual dos eventos serán disparados para indicar el éxito o los errores surgidos durante el proceso de creación de la base de datos.

El segundo aspecto que debemos considerar para crear o abrir una base de datos es la versión. La API requiere que una versión sea asignada a la base de datos. Esto es para preparar al sistema para futuras migraciones. Cuando tenemos que actualizar la estructura de una base de datos en el lado del servidor para agregar más tablas o índices, normalmente detenemos el servidor, migramos la información hacia la nueva estructura y luego encendemos el servidor nuevamente. Sin embargo, en este caso la información es contenida del lado del cliente y, por supuesto, el ordenador del usuario no puede ser apagado. Como resultado, la versión de la base de datos debe ser cambiada y luego la información migrada desde la vieja a la nueva versión.

Para trabajar con versiones de bases de datos, la API ofrece la propiedad version y el método setVersion(). La propiedad retorna el valor de la versión actual y el método asigna un nuevo valor de versión a la base de datos en uso. Este valor puede ser numérico o cualquier cadena de texto que se nos ocurra.

Objetos y Almacenes de Objetos

Lo que solemos llamar registros, en IndexedDB son llamados objetos. Estos objetos incluyen propiedades para almacenar e identificar valores. La cantidad de propiedades y cómo los objetos son estructurados es irrelevante. Solo deben incluir al menos una propiedad declarada como índice para poder encontrarlos dentro del Almacén de Objetos.

Los Almacenes de Objetos (tablas) tampoco tienen una estructura específica. Solo el nombre y uno o más índices deben ser declarados en el momento de su creación para poder encontrar objetos en su interior más tarde.

Como podemos ver en la Figura 11-1, un Almacén de Objetos contiene diversos objetos con diferentes propiedades. Algunos objetos tienen una propiedad DVD, otros tienen una propiedad Libro, etc… Cada uno tiene su propia estructura, pero todos deberán tener al menos una propiedad declarada como índice para poder ser encontrados. En el ejemplo de la Figura 11-1, este índice podría ser la propiedad Id.

Para trabajar con objetos y Almacenes de Objetos solo necesitamos crear el Almacén de Objetos, declarar las propiedades que serán usadas como índices y luego comenzar a almacenar objetos en este almacén. No necesitamos pensar acerca de la estructura o el contenido de los objetos en este momento, solo considerar los índices que vamos a utilizar para encontrarlos más adelante en el almacén.

La API provee varios métodos para manipular Almacenes de Objetos:

createObjectStore(nombre, clave, autoIncremento) Este método crea un nuevo Almacén de Objetos con el nombre y la configuración declarada por sus atributos. El atributo nombre es obligatorio. El atributo clave declarará un índice común para todos los objetos. Y el atributo autoIncremento es un valor booleano que determina si el Almacén de Objetos tendrá un generador de claves automático.
objectStore(nombre) Para acceder a los objetos en un Almacén de Objetos, una transacción debe ser iniciada y el Almacén de Objetos debe ser abierto para esa transacción. Este método abre el Almacén de Objetos con el nombre declarado por el atributo nombre.
deleteObjectStore(nombre) Este método destruye un Almacén de Objetos con el nombre declarado por el atributo nombre.

Los métodos createObjectStore() y deleteObjectStore(), así como otros métodos responsables de la configuración de la base de datos, pueden solo ser aplicados cuando la base de datos es creada o mejorada en una nueva versión.

Índices

Para encontrar objetos en un Almacén de Objetos necesitamos declarar algunas propiedades de estos objetos como índices. Una forma fácil de hacerlo es declarar el atributo clave en el método createObjectStore(). La propiedad declarada como clave será un índice común para cada objeto almacenado en ese Almacén de Objetos particular. Cuando declaramos el atributo clave, esta propiedad debe estar presente en todos los objetos.

Además del atributo clave podemos declarar todos los índices que necesitemos para un Almacén de Objetos usando métodos especiales provistos para este propósito:

createIndex(nombre, propiedad, único) Este método crea un índice para un Almacén de Objetos específico. El atributo nombre es un nombre con el que identificar al índice, el atributo propiedad es la propiedad que será usada como índice, y unique es un valor booleano que indica si existe la posibilidad de que dos o más objetos compartan el mismo valor para este índice.
index(nombre) Para usar un índice primero tenemos que crear una referencia al índice y luego asignar esta referencia a la transacción. El método index() crea esta referencia para el índice declarado en el atributo nombre.
deleteIndex(nombre) Si ya no necesitamos un índice podemos eliminarlo usando este método.

Transacciones

Un sistema de base de datos trabajando en un navegador debe contemplar algunas circunstancias únicas que no están presentes en otras plataformas. El navegador puede fallar, puede ser cerrado abruptamente, el proceso puede ser detenido por el usuario, o simplemente otro sitio web puede ser cargado en la misma ventana, por ejemplo. Existen muchas situaciones en las que trabajar directamente con la base de datos puede causar mal funcionamiento o incluso corrupción de datos. Para prevenir que algo así suceda, cada acción es realizada por medio de transacciones.

El método que genera una transacción se llama transaction(). Para declarar el tipo de transacción, contamos con los siguientes tres atributos:

READ_ONLY Este atributo genera una transacción de solo lectura. Modificaciones no son permitidas.
READ_WRITE Usando este tipo de transacción podemos leer y escribir. Modificaciones son permitidas.
VERSION_CHANGE Este tipo de transacción es solo utilizada para actualizar la versión de la base de datos.

Las más comunes son las transacciones de lectura y escritura. Sin embargo, para prevenir un uso inadecuado, el tipo READ_ONLY (solo lectura) es configurado por defecto.

Por este motivo, cuando solo necesitamos obtener información de la base de datos, lo único que debemos hacer es declarar el destino de la transacción (normalmente el nombre del Almacén de Objetos de donde vamos a leer esta información).

Métodos de Almacenes de Objetos

Para interactuar con Almacenes de Objetos, leer y almacenar información, la API provee varios métodos:

add(objeto) Este método recibe un par clave/valor o un objeto conteniendo varios pares clave/valor, y con los datos provistos genera un objeto que es agregado al Almacén de Objetos seleccionado. Si un objeto con el mismo valor de índice ya existe, el método add() retorna un error.
put(objeto) Este método es similar al anterior, excepto que si ya existe un objeto con el mismo valor de índice lo sobrescribe. Es útil para modificar un objeto ya almacenado en el Almacén de Objetos seleccionado.
get(clave) Podemos leer un objeto específico del Almacén de Objetos usando este método. El atributo clave es el valor del índice del objeto que queremos leer.
delete(clave) Para eliminar un objeto del Almacén de Objetos seleccionado solo tenemos que llamar a este método con el valor del índice del objeto a eliminar.

Espero haber ayudado en algo. Hasta la próxima oportunidad!

DESCARGAR PUBLICACIÓN

Regresar al índice