Datenbank

Ein Sumor Cloud Tool.
Mehr Dokumentation Ein Datenbank-Connector für MySQL, basierend auf Entity.

Installation

npm i @sumor/database --save

Voraussetzungen

Node.JS Version

Erfordert Node.JS Version 18.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"
}

Verwendung

Allgemeine Verwendung

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

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

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

// Benutzer festlegen
db.setUser('tester')

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

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

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

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

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

// Datensatz sicherstellen
await db.ensure('Car', ['brand'], {
  brand: 'BMW',
  model: 'X5C'
})
// Legt keinen Datensatz an, wenn 'BMW' bereits vorhanden ist

// Datensatz anpassen
await db.modify('Car', ['brand'], {
  brand: 'BMW',
  model: 'X5C'
})
// Aktualisiert das Datensatzmodell, wenn 'BMW' bereits vorhanden ist

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

// Verbindung schließen
await db.commit()

// Rollback
await db.rollback()

// Verbindung schließen
await db.release()

// Client zerstören, wenn der Server heruntergefahren werden soll
await client.destroy()

Abfrageoptionen

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

Optionen zur Definition von Entitäten

Index

Du kannst ein Index-Array zur Entitätsdefinition hinzufügen, um einen Index auf der Tabelle zu erstellen. Standardmäßig wird ein Index auf dem Feld id erstellt.

Join

Du kannst ein Join-Objekt zur Entitätsdefinition hinzufügen, um einen Join auf der Tabelle zu erstellen. Wie im folgenden Beispiel, es wird ein Feld userId im Car-Entity erstellen.

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