base de datos

Una Sumor Cloud Tool.
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

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

require Node.JS ES module

Dado que este paquete está escrito en módulo ES, cambie el siguiente código en su archivo package.json:

{
  "type": "module"
}

Uso

Instalar base de datos

Puede usar el método de instalación para instalar entidad y vista en la base de datos.

database.install(config, [ruta de recurso], [datos de recurso])

caso 1: instalar entidad y vista desde la ruta del recurso, cargará datos/entidad y datos/vista desde la ruta raíz del proyecto.

import database from '@sumor/database'

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

await database.install(config.database, process.cwd() + '/data')

caso 2: instalar entidad y vista desde los datos del recurso, cargará datos/entidad y datos/vista desde el objeto de datos.

import database from '@sumor/database'

await database.install(config, {
  entity: {
    Car: {
      property: {
        brand: {
          type: 'string',
          length: 100
        },
        model: {
          type: 'string',
          length: 100
        }
      }
    }
  },
  view: {}
})

Uso general

import database from '@sumor/database'

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

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

// obtener conexión
const db = await cliente.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 })
// coche = {id: car1Id, brand: 'BMW', model: 'X5'}

// consultar registros
const cars = await db.query('Car', {
  brand: 'BMW'
})
// coches = [{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 apagarse
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

Puede agregar una matriz de índices a la definición de la entidad para crear un índice en la tabla, por defecto, creará un índice en el campo id.

Unir

Puede agregar un objeto de unión a la definición de la entidad para crear una unión en la tabla. Como en el siguiente ejemplo, creará un campo userId en la entidad de 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: {}
})