arletdb-json
v1.0.0
Published
Gestor de base de datos local en archivos json
Downloads
11
Readme
Documentación de la Clase ArletDBJson
La clase ArletDBJson
proporciona una interfaz para gestionar bases de datos en formato JSON. Permite crear, modificar, eliminar tablas y realizar operaciones CRUD (Crear, Leer, Actualizar y Eliminar) sobre los registros de las tablas. Las tablas se almacenan como archivos JSON en un directorio especificado.
Constructor
constructor(carpeta: string)
Crea una nueva instancia de ArletDBJson
y establece la carpeta donde se almacenarán los archivos de las tablas. Si la carpeta no existe, se crea automáticamente.
Parámetros:
carpeta
: La ruta del directorio donde se almacenarán los archivos de las tablas.
Métodos
consulta(consulta: string): any
Procesa una consulta SQL personalizada y llama al método correspondiente según el tipo de operación.
Parámetros:
consulta
: La cadena que representa la consulta SQL.
Retorna:
- El resultado de la operación correspondiente.
validaciones(consulta: string): any
Valida el tipo de consulta y llama al método específico correspondiente a la operación solicitada.
Parámetros:
consulta
: La cadena que representa la consulta SQL.
Retorna:
- El resultado de la operación correspondiente o lanza un error si la consulta no es válida.
eliminarEspaciosInnecesarios(texto: string): string
Elimina los espacios en blanco innecesarios de la consulta.
Parámetros:
texto
: La cadena de texto a limpiar.
Retorna:
- La cadena de texto sin espacios innecesarios.
crearCarpetas(ruta: string): void
Crea la carpeta especificada si no existe.
Parámetros:
ruta
: La ruta de la carpeta que se debe crear.
leerTabla(tabla: string): object
Lee el archivo JSON correspondiente a la tabla especificada y devuelve su contenido.
Parámetros:
tabla
: El nombre de la tabla a leer.
Retorna:
- Un objeto que representa la tabla y sus datos.
Lanza:
- Un error si la tabla no existe.
escribirTabla(tabla: string, datos: object): void
Escribe (o actualiza) los datos de la tabla en su archivo JSON correspondiente.
Parámetros:
tabla
: El nombre de la tabla.datos
: Un objeto que contiene los datos que se deben guardar en la tabla.
tablaExiste(tabla: string): boolean
Verifica si la tabla especificada ya existe en el sistema de archivos.
Parámetros:
tabla
: El nombre de la tabla a verificar.
Retorna:
true
si la tabla existe,false
en caso contrario.
crearTabla(consulta: string): string
Crea una nueva tabla basada en la consulta especificada. Permite la opción de no crear la tabla si ya existe.
Parámetros:
consulta
: La cadena que representa la consulta para crear la tabla.
Retorna:
- Un mensaje indicando el resultado de la operación.
modificarTabla(consulta: string): string
Modifica la estructura de una tabla existente (agrega o elimina columnas).
Parámetros:
consulta
: La cadena que representa la consulta para modificar la tabla.
Retorna:
- Un mensaje indicando el resultado de la operación.
eliminarTabla(consulta: string): string
Elimina la tabla especificada del sistema de archivos.
Parámetros:
consulta
: La cadena que representa la consulta para eliminar la tabla.
Retorna:
- Un mensaje indicando el resultado de la operación.
resetearTabla(consulta: string): string
Resetea todos los datos de la tabla especificada, eliminando todos los registros.
Parámetros:
consulta
: La cadena que representa la consulta para resetear la tabla.
Retorna:
- Un mensaje indicando el resultado de la operación.
insertarEn(consulta: string): string
Inserta un nuevo registro en la tabla especificada.
Parámetros:
consulta
: La cadena que representa la consulta para insertar en la tabla.
Retorna:
- Un mensaje indicando el resultado de la operación.
actualizar(consulta: string): string
Actualiza uno o más registros de la tabla especificada según la condición definida.
Parámetros:
consulta
: La cadena que representa la consulta para actualizar registros.
Retorna:
- Un mensaje indicando el número de registros actualizados.
eliminarDe(consulta: string): string
Elimina registros de la tabla especificada según la condición definida.
Parámetros:
consulta
: La cadena que representa la consulta para eliminar registros.
Retorna:
- Un mensaje indicando el número de registros eliminados.
seleccionarTodoDe(consulta: string): object[]
Selecciona y devuelve todos los registros de la tabla especificada.
Parámetros:
consulta
: La cadena que representa la consulta para seleccionar todos los registros.
Retorna:
- Un arreglo con todos los registros de la tabla.
seleccionarDe(consulta: string): object[]
Selecciona y devuelve registros de la tabla especificada que cumplen con una condición definida.
Parámetros:
consulta
: La cadena que representa la consulta para seleccionar registros con condiciones.
Retorna:
- Un arreglo con los registros que cumplen con la condición.
evaluarCondicion(registro: object, whereClause: string): boolean
Evalúa si un registro cumple con las condiciones especificadas en la cláusula WHERE
.
Parámetros:
registro
: El objeto que representa un registro de la tabla.whereClause
: La cláusula que contiene las condiciones a evaluar.
Retorna:
true
si el registro cumple con todas las condiciones,false
en caso contrario.
seleccionar(consulta: string): object[]
Selecciona y devuelve columnas específicas de la tabla especificada.
Parámetros:
consulta
: La cadena que representa la consulta para seleccionar columnas específicas.
Retorna:
- Un arreglo de objetos con las columnas seleccionadas.
Empleabilidad de las Consultas
La clase ArletDBJson
permite manejar las siguientes consultas SQL:
- CREAR TABLA: Crea una nueva tabla.
- MODIFICAR TABLA: Agrega o elimina columnas en una tabla existente.
- ELIMINAR TABLA: Elimina una tabla del sistema.
- RESETEAR TABLA: Elimina todos los registros de una tabla.
- INSERTAR EN: Agrega un nuevo registro en una tabla.
- ACTUALIZAR: Modifica uno o más registros en una tabla.
- ELIMINAR DE: Elimina registros específicos de una tabla.
- SELECCIONAR TODO DE: Recupera todos los registros de una tabla.
- SELECCIONAR DE: Recupera registros que cumplen con condiciones específicas.
- SELECCIONAR: Recupera columnas específicas de una tabla.
Esta clase es ideal para aplicaciones que requieren un sistema de gestión de bases de datos ligero y en formato JSON, como prototipos, herramientas de desarrollo o pequeñas aplicaciones donde la complejidad del SQL completo no es necesaria.