Query Manager - API

Libreria para ejecutar QueryManager en el lado de la api

Instalación

Sigue estos pasos para instalar y configurar Query Manager - API en tu proyecto:

1. Instalar Query Manager - API: Ejecuta el siguiente comando para instalar la biblioteca en tu proyecto.

   npm i query-manager-api

2. Instalar Dependencias: Asegúrate de tener las siguientes dependencias instaladas en tu proyecto. Es recomendable usar las versiones especificadas.

   {
      "ajv": "^8.12.0",
      "ajv-errors": "^3.0.0",
      "ajv-formats": "^2.1.1",
      "dotenv": "^16.0.3",
      "moment": "^2.29.4",
      "sequelize": "^6.31.1",
      "@sap/hana-client": "^2.18.24",
      "tedious": "^16.1.0"
   }

3. Configuración de Variables de Entorno Define las siguientes variables de entorno en tu archivo .env para la configuración de la base de datos y Query Manager.

   DB_HOST=
   DB_PORT=
   DB_INSTANCE=
   DB_DATABASE=
   DB_DIALECT=
   DB_USER=
   DB_PASSWORD=
   DISABLE_DB_LOGS=
   
   # QUERY MANAGER CONFIG
   DB_QUERYMANAGER_USER=
   DB_QUERYMANAGER_PASSWORD=
   

Uso

1. Uso de los controladores Para utilizar los controladores, importa y usa en tus rutas como se muestra a continuación:

   import { crearCategoria } from 'query-manager-api';
      
   routes.put('/', schemaValidator(CategoriasSchema), crearCategoria);

   Controladores disponibles:

   • crearCategoria
   • editarCategoria
   • eliminarCategoria
   • leerCategoria
   • listarCategorias
   • getTiposDatos
   • listarEmpleados
   • actualizar
   • asignar
   • crear
   • eliminar
   • eliminarConsulta
   • generarConsulta
   • leer
   • listar
   • listarAsignados
   • listarConsultasPorUsuario
   • verificarConsulta

2. Esquemas Importa y utiliza los esquemas para validación de datos en tus endpoints:

   import { crearCategoria } from 'query-manager-api';
   
   routes.post('/crear', schemaValidator(CategoriasSchema), crearCategoria);

   schemas disponibles:

   • AsignarSchema
   • CategoriasSchema
   • verificarConsultasSchema
   • GenerarConsultaSchema

Stored Procedures para SQL

Para integrar correctamente query-manager-api con tu base de datos, es necesario agregar los siguientes Stored Procedures (SP) en la base de datos de tu proyecto. Estos SP son esenciales para el manejo y la consulta de datos:

• SP_CrearCategoriaQueryManager
• SP_ListarCategoriasQueryManager
• SP_EditarCategoriaQueryManager
• SP_ListarConsultasPorID
• SP_ListarTiposDatoSql
• SP_CrearConsulta
• SP_CrearConsultaVariable
• SP_EditarConsulta
• SP_EditarConsultaVariable
• SP_ListarConsultas
• SP_ListarConsultaPorID
• SP_ListarConsultaVariablePorID
• SP_EliminarConsultaUsuario
• SP_CrearUsuariosConsulta
• SP_ListarAsignadosQueryManager
• SP_ListarUsuariosAsignadosConsultas
• SP_ListarConsultasAsignadosUsuarios
• SP_ListarConsultasTodas