Zum Hauptinhalt springen

CLI verwenden

Inoffizielle Beta-Übersetzung

Diese Seite wurde von PageTurner AI übersetzt (Beta). Nicht offiziell vom Projekt unterstützt. Fehler gefunden? Problem melden →

CLI installieren​

Wenn Entitätsdateien in JavaScript vorliegen​

Falls du eine lokale TypeORM-Version verwendest, stelle sicher, dass sie mit der globalen Version übereinstimmt, die wir installieren werden.

Du kannst TypeORM global installieren mit npm i -g typeorm. Alternativ kannst du für jeden Befehl npx typeorm <params> verwenden, wenn du die Installation vermeiden möchtest.

Wenn Entitätsdateien in TypeScript vorliegen​

Dieses CLI-Tool ist in JavaScript geschrieben und läuft auf Node.js. Wenn deine Entitätsdateien in TypeScript sind, musst du sie vor der CLI-Verwendung nach JavaScript transpilieren. Du kannst diesen Abschnitt überspringen, wenn du nur JavaScript verwendest.

Du kannst ts-node in deinem Projekt einrichten, um den Vorgang zu vereinfachen:

ts-node installieren:

npm install ts-node --save-dev

Füge den typeorm-Befehl im Abschnitt "scripts" der package.json hinzu

"scripts": {
    ...
    "typeorm": "typeorm-ts-node-commonjs"
}

Für ESM-Projekte stattdessen dies hinzufügen:

"scripts": {
    ...
    "typeorm": "typeorm-ts-node-esm"
}

Wenn du zusätzliche Module wie module-alias laden möchtest, kannst du weitere --require my-module-supporting-register hinzufügen

Dann kannst du den Befehl so ausführen:

npm run typeorm migration:run -- -d path-to-datasource-config

Wie liest man die Dokumentation?​

Um die Dokumentation weniger wortreich zu gestalten, verwenden die folgenden Abschnitte eine global installierte TypeORM-CLI. Je nach Installationsmethode kannst du typeorm am Befehlsanfang durch npx typeorm oder npm run typeorm ersetzen.

Ein neues TypeORM-Projekt initialisieren​

Du kannst ein neues Projekt mit vorkonfigurierter Umgebung erstellen:

typeorm init

Es werden alle Dateien für ein grundlegendes TypeORM-Projekt erstellt:

  • .gitignore

  • package.json

  • README.md

  • tsconfig.json

  • src/entity/User.ts

  • src/index.ts

Führe dann npm install aus, um alle Abhängigkeiten zu installieren. Anschließend kannst du deine Anwendung mit npm start starten.

Alle Dateien werden im aktuellen Verzeichnis generiert. Für ein spezielles Zielverzeichnis verwende --name:

typeorm init --name my-project

Für eine spezifische Datenbank verwende --database:

typeorm init --database mssql

Für ein ESM-Basisprojekt verwende --module esm:

typeorm init --name my-project --module esm

Du kannst auch ein Basisprojekt mit Express generieren:

typeorm init --name my-project --express

Bei Docker-Verwendung kannst du eine docker-compose.yml-Datei generieren mit:

typeorm init --docker

typeorm init ist der einfachste und schnellste Weg, ein TypeORM-Projekt einzurichten.

Neue Entität erstellen​

Du kannst eine neue Entität mit dem CLI erstellen:

typeorm entity:create path-to-entity-dir/entity

Mehr über Entitäten erfahren.

Neuen Abonnenten erstellen​

Du kannst einen neuen Abonnenten mit dem CLI erstellen:

typeorm subscriber:create path-to-subscriber-dir/subscriber

Mehr über Abonnenten erfahren.

Migrationen verwalten​

  • typeorm migration:create - erstellen einer leeren Migration

  • typeorm migration:generate - generieren einer Migration durch Vergleich von Entitäten mit dem aktuellen Datenbankschema

  • typeorm migration:run - ausführen aller Migrationen

  • typeorm migration:revert - zurücksetzen der letzten Migration

  • typeorm migration:show - auflisten aller Migrationen mit ihrem Ausführungsstatus

Mehr über Migrationen erfahren.

Datenbankschema synchronisieren​

Um ein Datenbankschema zu synchronisieren:

typeorm schema:sync

Vorsicht bei der Ausführung in Produktivumgebungen - Die Schemasynchronisation kann zu Datenverlust führen, wenn nicht sorgfältig verwendet. Überprüfen Sie vor dem Einsatz in Produktion, welche SQL-Abfragen ausgeführt werden.

Synchronisierungsabfragen protokollieren ohne Ausführung​

Um zu prüfen, welche SQL-Abfragen schema:sync ausführen würde:

typeorm schema:log

Datenbankschema löschen​

Um ein Datenbankschema vollständig zu entfernen:

typeorm schema:drop -- -d path-to-datasource-config

Vorsicht mit diesem Befehl in Produktivumgebungen - er entfernt komplett alle Daten aus Ihrer Datenbank.

Beliebige SQL-Abfragen ausführen​

Sie können beliebige SQL-Abfragen direkt in der Datenbank ausführen mit:

typeorm query "SELECT * FROM USERS"

Cache leeren​

Wenn Sie QueryBuilder-Caching verwenden, können Sie den gesamten Cache leeren:

typeorm cache:clear

Version prüfen​

Sie können Ihre installierte TypeORM-Version (lokal und global) prüfen mit:

typeorm version