Manual de Uso para la Clase Entity

La clase Entity proporciona una interfaz para interactuar con documentos en una base de datos MongoDB. Esta clase permite realizar operaciones comunes como obtener, establecer, añadir, eliminar valores, así como también operaciones aritméticas y manipulación de arreglos en los documentos de la base de datos.

Requisitos Previos

Antes de utilizar cualquier función proporcionada por la clase Entity, asegúrate de establecer la variable de entorno BBEL_MONGO_URI con la URI de conexión a MongoDB. Esto es necesario para que la clase pueda conectarse a la base de datos correctamente.

export BBEL_MONGO_URI=tu_uri_de_conexion_mongodb

Uso Básico

Para utilizar la clase Entity, primero importa la función getEntityClass desde el módulo donde se encuentra definida la clase.

const { getEntityClass } = require('bbel-simple-db');

Luego, puedes obtener la clase de entidad llamando a la función getEntityClass y pasando el nombre de la colección en la base de datos como argumento.

const Entity = await getEntityClass('nombre_de_la_coleccion');

Creación de una Instancia de Entity

Una vez que tengas la clase de entidad, puedes crear una instancia de la misma pasando los filtros necesarios para encontrar el documento en la base de datos.

const entityInstance = new Entity({ filtro: valor });

Métodos Disponibles

Método get

Este método permite obtener el valor asociado a una clave específica en el documento de la base de datos.

const valor = await entityInstance.get('clave', valorPorDefecto);

Método set

El método set permite establecer un valor para una clave específica en el documento de la base de datos.

await entityInstance.set('clave', valor);

Método add

El método add realiza una operación de suma en el valor asociado a una clave específica en el documento de la base de datos.

await entityInstance.add('clave', valor);

Método subtract

El método subtract realiza una operación de resta en el valor asociado a una clave específica en el documento de la base de datos.

await entityInstance.subtract('clave', valor);

Método multiply

El método multiply realiza una operación de multiplicación en el valor asociado a una clave específica en el documento de la base de datos.

await entityInstance.multiply('clave', valor);

Método divide

El método divide realiza una operación de división en el valor asociado a una clave específica en el documento de la base de datos.

await entityInstance.divide('clave', valor);

Método append

El método append añade un valor al final de un arreglo asociado a una clave específica en el documento de la base de datos.

await entityInstance.append('clave', valor);

Método remove

El método remove elimina un valor de un arreglo asociado a una clave específica en el documento de la base de datos.

await entityInstance.remove('clave', valor);

Método destroy

El método destroy elimina el documento de la base de datos y devuelve el documento eliminado.

const documentoEliminado = await entityInstance.destroy();

Manejo de Errores

La clase Entity lanza errores en caso de que ocurran situaciones inesperadas o se proporcionen datos inválidos como argumentos a los métodos. Es importante manejar estos errores adecuadamente en tu aplicación para garantizar un funcionamiento robusto.