base de datos

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

Instalación

npm i @sumor/database --save

Prerrequisitos

Versión de Node.JS

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

Requerir 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, {
  entity: {
    Car: {
      property: {
        brand: {
          type: 'string',
          length: 100
        },
        model: {
          type: 'string',
          length: 100
        }
      }
    }
  },
  view: {}
})

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

// obtener conexión
const db = await client.connect()

// establecer usuario operativo
db.setUser('tester')

// crear registro
const car1Id = await db.insert('Car', {
  brand: 'BMW',
  model: 'X5'
})
const car2Id = await db.insert('Car', {
  brand: 'BMW',
  model: 'X6'
})

// leer registro
const car = await db.single('Car', { id: carId })
// car = {id: car1Id, brand: 'BMW', model: 'X5'}

// consultar registros
const cars = await db.query('Car', {
  brand: 'BMW'
})
// cars = [{id: car1Id, brand: 'BMW', model: 'X5'}, {id: car2Id, brand: 'BMW', model: 'X6'}]

// contar registros
const count = await db.count('Car', {
  brand: 'BMW'
})
// count = 2

// actualizar registro
await db.update(
  'Car',
  { id: car1Id },
  {
    brand: 'BMW',
    model: 'X5M'
  }
)

// asegurar registro
await db.ensure('Car', ['brand'], {
  brand: 'BMW',
  model: 'X5C'
})
// no insertará el registro si la marca 'BMW' ya existe

// modificar registro
await db.modify('Car', ['brand'], {
  brand: 'BMW',
  model: 'X5C'
})
// actualizará el modelo del registro si la marca 'BMW' ya existe

// eliminar registro
await db.delete('Car', { id: car1Id })

// cerrar conexión
await db.commit()

// deshacer
await db.rollback()

// cerrar conexión
await db.release()

// destruir cliente cuando el servidor deba cerrarse
await client.destroy()

Opciones de Consulta

// consultar registros con opciones
const cars = await db.select(
  'Car',
  {
    brand: 'BMW'
  },
  {
    term: 'X5',
    termRange: ['model'],
    top: 10,
    skip: 0
  }
)