base de datos

Una Herramienta Nube Sumor.
Documentación Adicional Un conector de base de datos para MySQL, etc. Basado en entidad.

Instalación

npm i @sumor/database --save

Requisitos

Versión de Node.JS

Se requiere Node.JS versión 18.x o superior.

Requiere módulo ES de Node.JS

Como 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 cliente = await database.cliente(config)

// Obtener conexión
const db = await cliente.conectar()

// 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()

// Revertir
await db.rollback()

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

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

Opciones de Consulta

// Consultar registros con opciones
const cars = await db.select(
  'Car',
  {
    brand: 'BMW'
  },
  {
    term: 'X5',
    termRange: ['model'],
    top: 10,
    skip: 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, 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 ejemplo a continuación, creará el campo userId en la entidad Car.

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
        }
      },
      index: ['userId'],
      join: {
        user: 'User'
      }
    }
  },
  view: {}
})