base de datos

Una Herramienta Sumor Cloud.
Más Documentación Un conector de base de datos para MySQL, etc. Basado en entidad.

Instalación

npm i @sumor/database --save

Prerrequisitos

Versión de Node.JS

Requiere Node.JS versión 18.x o superior

Requiere módulo ES de Node.JS

Ya que este paquete está escrito en módulo ES, por favor cambia el siguiente código en tu archivo package.json:

{
  "type": "module"
}

Uso

Uso General

import database from '@sumor/database'

const config = {
  host: 'localhost',
  user: 'root',
  password: 'password',
  database: 'database',
  port: 3306
}

await database.install(config, {
  entidad: {
    Coche: {
      propiedad: {
        marca: {
          tipo: 'cadena',
          longitud: 100
        },
        modelo: {
          tipo: 'cadena',
          longitud: 100
        }
      }
    }
  },
  vista: {}
})

// obtener cliente con pool de conexiones
const cliente = await database.cliente(config)

// obtener conexión
const bd = await cliente.conectar()

// establecer usuario operador
bd.setUsuario('tester')

// crear registro
const idCoche1 = await bd.insertar('Coche', {
  marca: 'BMW',
  modelo: 'X5'
})
const idCoche2 = await bd.insertar('Coche', {
  marca: 'BMW',
  modelo: 'X6'
})

// leer registro
const coche = await bd.único('Coche', { id: idCoche })
// coche = {id: idCoche1, marca: 'BMW', modelo: 'X5'}

// consultar registros
const coches = await bd.consulta('Coche', {
  marca: 'BMW'
})
// coches = [{id: idCoche1, marca: 'BMW', modelo: 'X5'}, {id: idCoche2, marca: 'BMW', modelo: 'X6'}]

// contar registros
const cantidad = await bd.contar('Coche', {
  marca: 'BMW'
})
// cantidad = 2

// actualizar registro
await bd.actualizar(
  'Coche',
  { id: idCoche1 },
  {
    marca: 'BMW',
    modelo: 'X5M'
  }
)

// asegurar registro
await bd.asegurar('Coche', ['marca'], {
  marca: 'BMW',
  modelo: 'X5C'
})
// no insertará el registro si la marca 'BMW' ya existe

// modificar registro
await bd.modificar('Coche', ['marca'], {
  marca: 'BMW',
  modelo: 'X5C'
})
// actualizará el modelo del registro si la marca 'BMW' ya existe

// borrar registro
await bd.eliminar('Coche', { id: idCoche1 })

// cerrar conexión
await bd.confirmar()

// deshacer
await bd.revertir()

// cerrar conexión
await bd.liberar()

// destruir cliente cuando el servidor deba apagarse
await cliente.destruir()

Opciones de Consulta

// consultar registros con opciones
const coches = await bd.seleccionar(
  'Coche',
  {
    marca: 'BMW'
  },
  {
    término: 'X5',
    rangoTérmino: ['modelo'],
    tope: 10,
    omitir: 0
  }
)

Opciones de Definición de Entidad

Índice

Puedes añadir un array de índices a la definición de entidad para crear un índice en la tabla, por defecto se creará un índice en el campo id.

Unir

Puedes añadir un objeto de unión a la definición de entidad para crear una unión en la tabla. Como en el siguiente ejemplo, creará el campo userId en la entidad Coche.

import database from '@sumor/database'

const configuración = {
  host: 'localhost',
  usuario: 'root',
  contraseña: 'contraseña',
  baseDeDatos: 'base_de_datos',
  puerto: 3306
}

await database.instalar(configuración, {
  entidad: {
    Coche: {
      propiedad: {
        marca: {
          tipo: 'cadena',
          longitud: 100
        },
        modelo: {
          tipo: 'cadena',
          longitud: 100
        }
      },
      índice: ['userId'],
      unir: {
        usuario: 'Usuario'
      }
    }
  },
  vista: {}
})