Datenbank

Ein Sumor Cloud Tool.
Weitere Dokumentation Ein Datenbank-Connector für MySQL, usw. Basierend auf Entitäten.

Installation

npm i @sumor/database --save

Voraussetzungen

Node.JS-Version

Erfordert Node.JS-Version 16.x oder höher

Erforderliches Node.JS ES-Modul

Da dieses Paket in ES-Modul geschrieben ist, ändere bitte den folgenden Code in deiner package.json-Datei:

{
  "type": "module"
}

Nutzung

Allgemeine Nutzung

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: {}
})

// Hole Client mit Verbindungspool
const client = await database.client(config)

// Hole Verbindung
const db = await client.connect()

// Setze Benutzer für Operationen
db.setUser('tester')

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

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

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

// Zähle Datensätze
const count = await db.count('Car', {
  brand: 'BMW'
})
// count = 2

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

// Stelle Datensatz sicher
await db.ensure('Car', ['brand'], {
  brand: 'BMW',
  model: 'X5C'
})
// Wenn brand 'BMW' bereits existiert, wird kein Datensatz eingefügt

// Ändere Datensatz
await db.modify('Car', ['brand'], {
  brand: 'BMW',
  model: 'X5C'
})
// Wenn brand 'BMW' bereits existiert, wird das Modell des Datensatzes aktualisiert

// Lösche Datensatz
await db.delete('Car', { id: car1Id })

// Schließe Verbindung
await db.commit()

// Rollback
await db.rollback()

// Schließe Verbindung
await db.release()

// Zerstöre Client, wenn Server heruntergefahren werden soll
await client.destroy()

Abfrage-Optionen

// Datensätze mit Optionen abfragen
const cars = await db.select(
  'Car',
  {
    brand: 'BMW'
  },
  {
    term: 'X5',
    termRange: ['model'],
    top: 10,
    skip: 0
  }
)