Datenbank

Ein Sumor Cloud Tool.
Mehr Dokumentation Ein Datenbank-Connector für MySQL usw. Basierend auf Entität.

Installation

npm i @sumor/database --save

Voraussetzungen

Node.JS Version

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

Erfordern Node.JS ES-Modul

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

{
  "type": "module"
}

Verwendung

Datenbankinstallation

Sie können die Installationsmethode verwenden, um Entität und Ansicht in der Datenbank zu installieren.

database.install(config, [Ressourcenpfad], [Ressourcendaten])

Fall 1: Entität und Ansicht aus Ressourcenpfad installieren. Es werden Daten/Entität und Daten/Ansicht aus dem Projektstammverzeichnis geladen.

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')

Fall 2: Entität und Ansicht aus Ressourcendaten installieren. Es werden Daten/Entität und Daten/Ansicht aus dem Datenobjekt geladen.

import database from '@sumor/database'

await database.install(config, {
  entity: {
    Auto: {
      attribute: {
        Marke: {
          Typ: 'Zeichenfolge',
          Länge: 100
        },
        Modell: {
          Typ: 'Zeichenfolge',
          Länge: 100
        }
      }
    }
  },
  Ansicht: {}
})

Allgemeine Verwendung

import database from '@sumor/database'

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

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

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

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

// Datensatz erstellen
const car1Id = await db.insert('Auto', {
  Marke: 'BMW',
  Modell: 'X5'
})
const car2Id = await db.insert('Auto', {
  Marke: 'BMW',
  Modell: 'X6'
})

// Datensatz lesen
const auto = await db.single('Auto', { id: carId })
// auto = {id: car1Id, Marke: 'BMW', Modell: 'X5'}

// Datensätze abfragen
const autos = await db.query('Auto', {
  Marke: 'BMW'
})
// autos = [{id: car1Id, Marke: 'BMW', Modell: 'X5'}, {id: car2Id, Marke: 'BMW', Modell: 'X6'}]

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

// Datensatz aktualisieren
await db.update(
  'Auto',
  { id: car1Id },
  {
    Marke: 'BMW',
    Modell: 'X5M'
  }
)

// Datensatz sicherstellen
await db.ensure('Auto', ['Marke'], {
  Marke: 'BMW',
  Modell: 'X5C'
})
// Datensatz wird nicht eingefügt, wenn Marke 'BMW' bereits vorhanden ist

// Datensatz ändern
await db.modify('Auto', ['Marke'], {
  Marke: 'BMW',
  Modell: 'X5C'
})
// Datensatzmodell wird aktualisiert, wenn Marke 'BMW' bereits vorhanden ist

// Datensatz löschen
await db.delete('Auto', { 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 autos = await db.select(
  'Auto',
  {
    Marke: 'BMW'
  },
  {
    Begriff: 'X5',
    Begriffsbereich: ['Modell'],
    Top: 10,
    Überspringen: 0
  }
)

Optionen zur Entitätsdefinition

Index

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

Join

Sie können ein Join-Objekt zur Entitätsdefinition hinzufügen, um einen Join in der Tabelle zu erstellen. Wie im folgenden Beispiel wird das Feld userId in der Car-Entität erstellt.

import database from '@sumor/database'

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

await database.install(config, {
  entity: {
    Auto: {
      attribute: {
        Marke: {
          Typ: 'Zeichenfolge',
          Länge: 100
        },
        Modell: {
          Typ: 'Zeichenfolge',
          Länge: 100
        }
      },
      Index: ['userId'],
      Join: {
        Benutzer: 'Benutzer'
      }
    }
  },
  Ansicht: {}
})