digna CLI Referenz 2025.09¶
2025-09-29
Diese Seite dokumentiert die vollständige Menge an Befehlen, die in der digna CLI-Version 2025.09 verfügbar sind, einschließlich Anwendungsbeispielen und Optionen.
CLI-Grundlagen¶
Hilfe¶
Die Option --help liefert Informationen über verfügbare Befehle und deren Verwendung. Es gibt zwei Hauptmöglichkeiten, diese Option zu nutzen:
-
Allgemeine Hilfe anzeigen:
Verwenden Sie --help unmittelbar nach dem Schlüsselwort dignacl
-
Hilfe für spezifische Befehle abrufen:
Für detaillierte Informationen zu einem bestimmten Befehl hängen Sie
--helpan diesen Befehl an. Beispielsweise, um Hilfe zum Befehladd-userzu erhalten, führen Sie aus:### Ausgabe:
- Beschreibung des Befehls: Bietet eine detaillierte Beschreibung dessen, was der Befehl tut.
- Syntax: Zeigt die exakte Syntax, einschließlich erforderlicher und optionaler Argumente.
- Optionen: Listet alle spezifischen Optionen des Befehls zusammen mit ihren Erklärungen auf.
- Beispiele: Liefert Beispiele dafür, wie der Befehl effektiv ausgeführt wird.
check-config¶
Der Befehl check-config ist ein Hilfswerkzeug innerhalb des digna CLI-Tools, das dazu dient, die Konfiguration von digna zu testen. Dieser Befehl stellt sicher, dass die digna-Komponenten die benötigten Konfigurationselemente in der config.toml finden können.
Optionen¶
--configpath,-cp: Datei oder Verzeichnis, das die Konfiguration enthält. Wird dies weggelassen, wird ../config.toml verwendet.
Befehlsverwendung¶
Nach erfolgreicher Ausführung gibt der Befehl eine Bestätigung über die Vollständigkeit der Konfiguration aus.
Falls die Konfiguration unvollständig erscheint, werden die fehlenden Konfigurationselemente aufgelistet.
check-repo-connection¶
Der Befehl check-repo-connection ist ein Hilfswerkzeug innerhalb des digna CLI-Tools, das die Konnektivität und den Zugriff auf ein angegebenes digna-Repository testet. Dieser Befehl stellt sicher, dass die CLI mit dem Repository interagieren kann.
Befehlsverwendung¶
Nach erfolgreicher Ausführung gibt der Befehl eine Bestätigung der Verbindung aus sowie Details zum Repository: Repository-Version, Host, Datenbank und Schema.
Wenn die Verbindung zum Repository nicht erfolgreich ist, überprüfen Sie die Datei config.toml auf korrekte Konfigurationseinstellungen.
version¶
Um die installierte Version von dignacli zu prüfen, verwenden Sie die Option --version.
Befehlsverwendung¶
Beispielausgabe¶
Logging-Optionen¶
Standardmäßig ist die Konsolenausgabe der digna-Befehle minimalistisch gehalten. Die meisten Befehle bieten die Möglichkeit, zusätzliche Informationen zu liefern, mittels der folgenden Optionen:
-- verbose (-v)
-- debug (-d)
-- logfile (lf)
„verbose“ und „debug“ legen den Detaillierungsgrad fest, während der Schalter „logfile“ das Umleiten der Ausgabe in eine Datei statt in das Konsolenfenster ermöglicht.
Benutzerverwaltung¶
add-user¶
Der Befehl add-user in der digna CLI wird verwendet, um einen neuen Benutzer im digna-System hinzuzufügen.
Befehlsverwendung¶
Argumente¶
- USER_NAME: Der Benutzername für den neuen Benutzer (erforderlich).
- USER_FULL_NAME: Der vollständige Name des neuen Benutzers (erforderlich).
- USER_PASSWORD: Das Passwort für den neuen Benutzer (erforderlich).
Optionen¶
--is_superuser,-su: Kennzeichnet den neuen Benutzer als Administrator.--valid_until,-vu: Setzt ein Ablaufdatum für das Benutzerkonto im FormatYYYY-MM-DD HH:MI:SS. Wenn nicht gesetzt, hat das Konto kein Ablaufdatum.
Beispiel¶
Um einen neuen Benutzer mit dem Benutzernamen jdoe, dem vollständigen Namen John Doe und dem Passwort password123 hinzuzufügen:
Um einen neuen Benutzer hinzuzufügen und ein Ablaufdatum für das Konto zu setzen:
delete-user¶
Der Befehl delete-user in der digna CLI wird verwendet, um einen bestehenden Benutzer aus dem digna-System zu entfernen.
Befehlsverwendung¶
Argumente¶
- USER_NAME: Der Benutzername des zu löschenden Benutzers (erforderlich). Dies ist das einzige vom Befehl erforderliche Argument.
Beispiel¶
Durch Ausführen dieses Befehls wird der Benutzer jdoe aus dem digna-System entfernt; damit werden dessen Zugriff und zugehörige Daten sowie Berechtigungen im Repository widerrufen bzw. gelöscht.
modify-user¶
Der Befehl modify-user in der digna CLI wird verwendet, um die Details eines bestehenden Benutzers im digna-System zu aktualisieren.
Befehlsverwendung¶
Argumente¶
- USER_NAME: Der Benutzername des zu ändernden Benutzers (erforderlich).
- USER_FULL_NAME: Der neue vollständige Name für den Benutzer (erforderlich).
Optionen¶
--is_superuser,-su: Setzt den Benutzer als Superuser und gewährt erhöhte Privilegien. Dieser Schalter benötigt keinen Wert.--valid_until,-vu: Setzt ein Ablaufdatum für das Benutzerkonto im Format YYYY-MM-DD HH:MI:SS. Wird dies nicht angegeben, bleibt das Konto unbegrenzt gültig.
Beispiel¶
Um den vollständigen Namen des Benutzers jdoe auf „Johnathan Doe“ zu ändern und den Benutzer als Superuser zu setzen:
modify-user-pwd¶
Der Befehl modify-user-pwd in der digna CLI wird verwendet, um das Passwort eines bestehenden Benutzers im digna-System zu ändern.
Befehlsverwendung¶
Argumente¶
- USER_NAME: Der Benutzername des Benutzers, dessen Passwort geändert werden soll (erforderlich).
- USER_PWD: Das neue Passwort für den Benutzer (erforderlich).
Beispiel¶
Um das Passwort des Benutzers jdoe auf newpassword123 zu ändern:
list-users¶
Der Befehl list-users in der digna CLI zeigt eine Liste aller im digna-System registrierten Benutzer an.
Befehlsverwendung¶
Beim Ausführen dieses Befehls verbindet sich die digna CLI mit dem digna-Repository und listet alle Benutzer auf, wobei deren ID, Benutzername, vollständiger Name, Superuser-Status und Ablaufzeitstempel angezeigt werden.
Repository-Verwaltung¶
upgrade-repo¶
Der Befehl upgrade-repo in der digna CLI wird verwendet, um das digna-Repository zu upgraden oder zu initialisieren. Dieser Befehl ist essentiell, um Updates anzuwenden oder die Repository-Infrastruktur erstmals einzurichten.
Befehlsverwendung¶
Optionen¶
--simulation-mode,-s: Wenn aktiviert, führt dieser Schalter den Befehl im Simulationsmodus aus, wobei die SQL-Anweisungen ausgegeben werden, die ausgeführt würden, aber nicht tatsächlich ausgeführt werden. Dies ist nützlich, um Änderungen vorab zu prüfen, ohne das Repository zu verändern.
Beispiel¶
Um das digna-Repository zu aktualisieren, können Sie den Befehl ohne Optionen ausführen:
Um das Upgrade im Simulationsmodus auszuführen (um die SQL-Anweisungen zu sehen, ohne sie anzuwenden):Dieser Befehl ist entscheidend für die Wartung des digna-Systems und stellt sicher, dass das Datenbankschema und andere Repository-Komponenten mit der neuesten Softwareversion auf dem aktuellen Stand sind.
encrypt¶
Der Befehl encrypt in der digna CLI wird verwendet, um ein Passwort zu verschlüsseln.
Befehlsverwendung¶
Argumente¶
- PASSWORD: Das zu verschlüsselnde Passwort (erforderlich).
Beispiel¶
Um ein Passwort zu verschlüsseln, müssen Sie das Passwort als Argument angeben.
Beispielsweise, um das Passwort mypassword123 zu verschlüsseln, verwenden Sie:
generate-key¶
Der Befehl generate-key wird verwendet, um einen Fernet-Schlüssel zu generieren, der für die Sicherung von Passwörtern im digna-Repository erforderlich ist.
Befehlsverwendung¶
Datenverwaltung¶
clean-up¶
Der Befehl clean-up in der digna CLI wird verwendet, um Profile, Vorhersagen und Daten des Ampelsystems für eine oder mehrere Datenquellen innerhalb eines angegebenen Projekts zu entfernen. Dieser Befehl ist wichtig für das Datenlebenszyklus-Management und hilft, eine organisierte und effiziente Datenumgebung zu erhalten, indem veraltete oder unnötige Daten gelöscht werden.
Befehlsverwendung¶
Argumente¶
- PROJECT_NAME: Der Name des Projekts, aus dem Daten entfernt werden sollen (erforderlich). Wird das Schlüsselwort all-projects in diesem Argument verwendet, weist dies digna an, über alle vorhandenen Projekte zu iterieren und den Befehl anzuwenden.
- FROM_DATE: Das Startdatum und die Startzeit für die Datenlöschung. Zulässige Formate sind %Y-%m-%d, %Y-%m-%dT%H:%M:%S oder %Y-%m-%d %H:%M:%S (erforderlich).
- TO_DATE: Das Enddatum und die Endzeit für die Datenlöschung, in denselben Formaten wie FROM_DATE (erforderlich).
Optionen¶
--table-name,-tn: Beschränkt die Clean-up-Operation auf eine bestimmte Tabelle innerhalb des Projekts.--table-filter,-tf: Filtert und beschränkt das Clean-up auf Tabellen, deren Namen die angegebene Teilzeichenkette enthalten.--timing,-tm: Zeigt nach Abschluss die Dauer des Clean-up-Vorgangs an.--help: Zeigt Hilfsinformationen zum clean-up-Befehl an und beendet das Programm.
Beispiel¶
Um Daten aus dem Projekt ProjectA zwischen dem 1. Januar 2023 und dem 30. Juni 2023 zu entfernen:
Um Daten nur aus einer bestimmten Tabelle namens Table1 zu entfernen:
Dieser Befehl hilft bei der Verwaltung des Datenspeichers und stellt sicher, dass das Repository nur relevante Informationen enthält.
remove-orphans¶
Der Befehl remove-orphans in der digna CLI dient der Aufräumarbeit im digna-Repository.
Wenn ein Benutzer Projekte oder Datenquellen löscht, bleiben die Profile und Vorhersagen im Repository zurück. Mit diesem Befehl werden solche verwaisten Zeilen aus dem Repository entfernt.
Befehlsverwendung¶
list-projects¶
Der Befehl list-projects in der digna CLI wird verwendet, um eine Liste aller verfügbaren Projekte im digna-System anzuzeigen.
Befehlsverwendung¶
Dieser Befehl ist besonders nützlich für Administratoren und Benutzer, die mehrere Projekte verwalten, und bietet einen schnellen Überblick über die im digna-Repository verfügbaren Projekte.
list-ds¶
Der Befehl list-ds in der digna CLI wird verwendet, um eine Liste aller verfügbaren Datenquellen innerhalb eines angegebenen Projekts anzuzeigen. Dieser Befehl ist hilfreich, um die für Analyse und Verwaltung verfügbaren Datenbestände zu verstehen.
Befehlsverwendung¶
Argumente¶
- PROJECT_NAME: Der Name des Projekts, für das die Datenquellen aufgelistet werden (erforderlich).
Beispiel¶
Um alle Datenquellen im Projekt mit dem Namen ProjectA aufzulisten:
Dieser Befehl verschafft den Benutzern einen Überblick über die in einem Projekt verfügbaren Datenquellen und erleichtert die Navigation und Verwaltung der Datenlandschaft.
inspect¶
Der Befehl inspect in der digna CLI wird verwendet, um Profile, Vorhersagen und Daten des Ampelsystems für eine oder mehrere Datenquellen innerhalb eines angegebenen Projekts zu erstellen. Dieser Befehl hilft bei der Analyse und Überwachung von Daten über einen definierten Zeitraum. Nach Abschluss der Inspektion wird der Wert des berechneten Ampelsystems zurückgegeben:
- 0: OK
- 1: INFO
- 2: WARNING
Befehlsverwendung¶
Argumente¶
- PROJECT_NAME: Der Name des Projekts, das inspiziert werden soll (erforderlich). Wird das Schlüsselwort all-projects in diesem Argument verwendet, weist dies digna an, über alle vorhandenen Projekte zu iterieren und den Befehl anzuwenden.
- FROM_DATE: Das Startdatum und die Startzeit für die Dateninspektion. Zulässige Formate sind %Y-%m-%d, %Y-%m-%dT%H:%M:%S oder %Y-%m-%d %H:%M:%S (erforderlich).
- TO_DATE: Das Enddatum und die Endzeit für die Dateninspektion, in denselben Formaten wie FROM_DATE (erforderlich).
Optionen¶
--table-name,-tn: Beschränkt die Inspektion auf eine bestimmte Tabelle innerhalb des Projekts.--table-filter,-tf: Filtert und inspiziert nur Tabellen, deren Namen die angegebene Teilzeichenkette enthalten.--enable_notification,-en: Aktiviert das Versenden von Benachrichtigungen im Falle von Alarmen.--bypass-backend,-bb: Umgeht das Backend und führt die Inspektion direkt aus der CLI aus (nur zu Testzwecken!).
Beispiel¶
Um Daten des Projekts ProjectA vom 1. Januar 2024 bis zum 31. Januar 2024 zu inspizieren:
Um nur eine bestimmte Tabelle zu inspizieren und die Vorhersagen zwangsweise neu zu berechnen:
Dieser Befehl ist nützlich, um aktualisierte Profile und Vorhersagen zu erzeugen, die Datenintegrität zu überwachen und Alarmsysteme innerhalb eines angegebenen Projektzeitraums zu verwalten.inspect-async¶
Der Befehl inspect-async in der digna CLI wird verwendet, um Profile, Vorhersagen und Daten des Ampelsystems für eine oder mehrere Datenquellen innerhalb eines angegebenen Projekts zu erstellen. Dieser Befehl hilft bei der Analyse und Überwachung von Daten über einen definierten Zeitraum. Im Gegensatz zum inspect-Befehl wartet dieser nicht auf den Abschluss der Inspektion. Stattdessen gibt er die Request-ID für die eingereichte Inspektionsanfrage zurück. Um den Fortschritt des Inspektionsprozesses abzufragen, verwenden Sie den Befehl inspect-status.
Befehlsverwendung¶
Argumente¶
- PROJECT_NAME: Der Name des Projekts, das inspiziert werden soll (erforderlich). Wird das Schlüsselwort all-projects in diesem Argument verwendet, weist dies digna an, über alle vorhandenen Projekte zu iterieren und den Befehl anzuwenden.
- FROM_DATE: Das Startdatum und die Startzeit für die Dateninspektion. Zulässige Formate sind %Y-%m-%d, %Y-%m-%dT%H:%M:%S oder %Y-%m-%d %H:%M:%S (erforderlich).
- TO_DATE: Das Enddatum und die Endzeit für die Dateninspektion, in denselben Formaten wie FROM_DATE (erforderlich).
Optionen¶
--table-name,-tn: Beschränkt die Inspektion auf eine bestimmte Tabelle innerhalb des Projekts.--table-filter,-tf: Filtert und inspiziert nur Tabellen, deren Namen die angegebene Teilzeichenkette enthalten.--enable_notification,-en: Aktiviert das Versenden von Benachrichtigungen im Falle von Alarmen.
Beispiel¶
Um Daten des Projekts ProjectA vom 1. Januar 2024 bis zum 31. Januar 2024 asynchron zu inspizieren:
inspect-status¶
Der Befehl inspect-status in der digna CLI wird verwendet, um den Fortschritt einer asynchronen Inspektion anhand der Request-ID zu prüfen.
Befehlsverwendung¶
Argumente¶
- REQUEST_ID: Die von
inspect-asynczurückgegebene Request-ID.
Beispiel¶
Um den Fortschritt einer Inspektion mit der Request-ID 12345 zu prüfen:
inspect-cancel¶
Der Befehl inspect-cancel in der digna CLI wird verwendet, um Inspektionen anhand der Request-ID abzubrechen, oder er kann verwendet werden, um alle aktuellen Anfragen abzubrechen.
Befehlsverwendung¶
Argumente¶
- REQUEST_ID: Die von
inspect-asynczurückgegebene Request-ID.
Beispiel¶
Um die Inspektion mit der Request-ID 12345 abzubrechen:
Um alle derzeit laufenden oder ausstehenden Anfragen abzubrechen:
export-ds¶
Der Befehl export-ds in der digna CLI wird verwendet, um einen Export von Datenquellen aus dem digna-Repository zu erzeugen. Standardmäßig werden alle Datenquellen eines gegebenen Projekts exportiert.
Befehlsverwendung¶
Argumente¶
- PROJECT_NAME: Der Name des Projekts, aus dem die Datenquellen exportiert werden.
Optionen¶
--table_name,-tn: Exportiert eine bestimmte Datenquelle aus einem Projekt.--exportfile,-ef: Legt den Dateinamen für den Export fest.
Beispiel¶
Um alle Datenquellen aus dem Projekt mit dem Namen ProjectA zu exportieren:
Dieser Befehl exportiert alle Datenquellen von ProjectA als JSON-Dokument, das in ein anderes Projekt oder Repository von digna importiert werden kann.
import-ds¶
Der Befehl import-ds in der digna CLI wird verwendet, um Datenquellen in ein Zielprojekt zu importieren und einen Importbericht zu erstellen.
Befehlsverwendung¶
Argumente¶
- PROJECT_NAME: Der Name des Projekts, in das die Datenquellen importiert werden sollen.
- EXPORT_FILE: Der Dateiname des zu importierenden Datenquellen-Exports.
Optionen¶
--output-file,-o: Datei, in die der Importbericht gespeichert wird (wenn nicht angegeben, wird er in tabellarischer Form im Terminal ausgegeben).--output-format,-f: Format, in dem der Importbericht gespeichert wird (json, csv).
Beispiel¶
Um alle Datenquellen aus der Exportdatei my_export.json in ProjectB zu importieren:
Nach dem Import zeigt dieser Befehl zudem einen Bericht über importierte und übersprungene Objekte an. Es werden nur neue Datenquellen in ProjectB importiert. Um herauszufinden, welche Objekte importiert und welche übersprungen würden, können Sie den Befehl plan-import-ds verwenden.
plan-import-ds¶
Der Befehl plan-import-ds in der digna CLI wird verwendet, um den Import von Datenquellen in ein Zielprojekt zu planen und einen Importbericht zu erstellen.
Befehlsverwendung¶
Argumente¶
- PROJECT_NAME: Der Name des Projekts, in das die Datenquellen importiert werden würden.
- EXPORT_FILE: Der Dateiname des zu analysierenden Exportfiles vor dem Import.
Optionen¶
--output-file,-o: Datei, in die der Importbericht gespeichert wird (wenn nicht angegeben, wird er in tabellarischer Form im Terminal ausgegeben).--output-format,-f: Format, in dem der Importbericht gespeichert wird (json, csv).
Beispiel¶
Um zu prüfen, welche Datenquellen aus der Exportdatei my_export.json beim Import in ProjectB importiert bzw. übersprungen würden:
Dieser Befehl zeigt nur einen Importplan der zu importierenden und zu überspringenden Objekte an.