oranodedb v1.0.0

Framework Node.js para Oracle Database

Este proyecto tiene como objetivo crear una librería de Node.js que funcione como un framework para facilitar las consultas a una base de datos Oracle. A continuación, se presentan algunas recomendaciones para desarrollar este framework de manera organizada y escalable.

Estructura del proyecto

Se sugiere utilizar una estructura de directorios clara y organizada para el proyecto, como se muestra a continuación:

lib/
├── config/
│ └── oracle.js
├── connection/
│ └── connection.js
├── queries/
│ └── queryBuilder.js
├── examples/
│ └── queryBuilderExample.js
├── test/
│ └── queryBuilder.test.js
└── index.js

El archivo index.js será el punto de entrada principal de la librería y deberá exportar las funciones y objetos clave que los usuarios utilizarán.

Carpeta config/

Dentro de la carpeta config/, crea un archivo oracle.js para gestionar la configuración de la conexión a Oracle. Puedes utilizar el módulo dotenv para cargar las variables de entorno desde un archivo .env.

// oracle.js

// Importaciones
const dotenv = require('dotenv');

// Configuración de las variables de entorno
dotenv.config();

// Configuración de la conexión a Oracle
const oracleConfig = {
  connectionString: process.env.ORACLE_CONNECTION_STRING,
  username: process.env.ORACLE_USERNAME,
  password: process.env.ORACLE_PASSWORD,
  // Otros parámetros de configuración de Oracle
};

// Exportación del objeto de configuración
module.exports = oracleConfig;

Carpeta connection/

Dentro de la carpeta connection/, crea un archivo connection.js para gestionar la conexión a la base de datos Oracle. Define una función que se encargue de la apertura y cierre de la conexión utilizando la librería oracledb.

// connection.js

// Importaciones
const oracledb = require('oracledb');
const oracleConfig = require('../config/oracle');

// Función para establecer la conexión a la base de datos Oracle
async function connect() {
  const connection = await oracledb.getConnection(oracleConfig);
  console.log('Conexión establecida a Oracle');
  return connection;
}

// Función para cerrar la conexión a la base de datos Oracle
async function disconnect(connection) {
  await connection.close();
  console.log('Conexión cerrada');
}

// Exportación de las funciones de conexión
module.exports = {
  connect,
  disconnect,
};

Carpeta queries/

Dentro de la carpeta queries/, crea un archivo queryBuilder.js para definir métodos que faciliten la construcción y ejecución de consultas a la base de datos Oracle. Implementa funciones que abstraigan la complejidad de la librería oracledb, como la ejecución de consultas y transacciones. Utiliza funciones asíncronas o promesas para gestionar las operaciones con la base de datos de manera eficiente.

// queryBuilder.js

// Importaciones
const connection = require('../connection/connection');

// Función para ejecutar una consulta a la base de datos Oracle
async function executeQuery(query) {
  let dbConnection;
  try {
    dbConnection = await connection.connect();
    const result = await dbConnection.execute(query);
    return result;
  } catch (error) {
    throw new Error(`Error al ejecutar la consulta: ${error.message}`);
  } finally {
    if (dbConnection) {
      await connection.disconnect(dbConnection);
    }
  }
}

// Exportación de la función de ejecución de consultas
module.exports = {
  executeQuery,
};

Documentación

Es importante documentar adecuadamente los métodos y su uso en cada archivo. Utiliza comentarios claros y descriptivos para explicar el propósito y los parámetros de cada función. Considera utilizar herramientas como JSDoc para generar una documentación más formal y legible.

Ejemplos de uso

Proporciona ejemplos prácticos de cómo utilizar tu librería en la carpeta examples/. Crea archivos o scripts de muestra que muestren cómo realizar consultas básicas, consultas más complejas y transacciones. Comenta los ejemplos para que sean fáciles de entender y sigan las buenas prácticas de programación.

Instalación

Para utilizar este framework de Node.js para Oracle Database, sigue los siguientes pasos:

Clona este repositorio en tu máquina local.

Navega hasta la carpeta raíz del proyecto.

Ejecuta el siguiente comando para instalar las dependencias necesarias:

npm install

Configura las variables de entorno en el archivo .env o utiliza otro método para establecer las variables necesarias para la conexión a Oracle.

Inicia tu aplicación y utiliza las funciones y objetos exportados en el archivo index.js para interactuar con la base de datos Oracle.

Recuerda seguir las convenciones de nombres y las buenas prácticas de desarrollo de software, como utilizar nombres descriptivos para las funciones y variables, modularizar el código, aplicar principios SOLID y escribir código limpio y legible.

Este proyecto está bajo licencia MIT. Puedes encontrar más información en el archivo LICENSE.