digna CLI Reference 2024.12¶

2024-12-09

Diese Seite dokumentiert die vollständige Befehlsübersicht der digna CLI-Version 2024.12, einschließlich Anwendungsbeispielen und Optionen.

2024-12-09

CLI-Grundlagen¶

Verwendung der Option --help¶

Die Option --help liefert Informationen über verfügbare Befehle und deren Verwendung. Es gibt zwei Hauptarten, diese Option zu nutzen:

1. Allgemeine Hilfe anzeigen:

   Verwenden Sie --help unmittelbar nach dem Stichwort dignacli
   

   dignacli --help
   

2. Hilfe für spezifische Befehle abrufen:

   Für detaillierte Informationen zu einem bestimmten Befehl hängen Sie --help an diesen Befehl an.
   Zum Beispiel, um Hilfe für den Befehl add-user zu erhalten, führen Sie aus:

   dignacli add-user --help
   

   ### Ausgabe:

   • Befehlsbeschreibung: Bietet eine detaillierte Beschreibung der Funktion des Befehls.
   • Syntax: Zeigt die genaue Syntax, einschließlich erforderlicher und optionaler Argumente.
   • Optionen: Listet spezifische Optionen des Befehls mit Erläuterungen auf.
   • Beispiele: Liefert Beispiele, wie der Befehl effektiv ausgeführt wird.

Verwendung des Befehls check-repo-connection¶

Der Befehl check-repo-connection ist ein Hilfswerkzeug innerhalb der digna CLI, das dazu dient, die Konnektivität und den Zugriff auf ein angegebenes digna Repository zu testen. Dieser Befehl stellt sicher, dass die CLI mit dem Repository kommunizieren kann.

Befehlsverwendung¶

dignacli check-repo-connection

Bei erfolgreicher Ausführung gibt der Befehl eine Bestätigung der Verbindung sowie Details zum Repository aus: Repository-Version, Host, Datenbank und Schema.

Wenn die Repository-Verbindung nicht erfolgreich ist, überprüfen Sie die Datei config.toml auf korrekte Konfigurationseinstellungen.

Verwendung des Befehls --version¶

Um die installierte Version von dignacli zu prüfen, verwenden Sie die Option --version.

Befehlsverwendung¶

dignacli --version

Beispield Ausgabe¶

dignacli version 2024.12

Verwendung von Logging-Optionen¶

Standardmäßig ist die Konsolenausgabe der digna-Befehle minimal gehalten. Die meisten Befehle bieten jedoch die Möglichkeit, zusätzliche Informationen zu liefern, mit den folgenden Optionen:

-- verbose (-v)
-- debug (-d)
-- logfile (lf)

„verbose“ und „debug“ legen den Detaillierungsgrad fest, während die Option „logfile“ die Umleitung der Ausgabe in eine Datei anstelle des Konsolenfensters ermöglicht.

Benutzerverwaltung¶

Verwendung des Befehls add-user¶

Der Befehl add-user in der digna CLI wird verwendet, um einen neuen Benutzer im digna System anzulegen.

Befehlsverwendung¶

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

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: Legt ein Ablaufdatum für das Benutzerkonto im Format YYYY-MM-DD HH:MI:SS fest. Wenn nicht gesetzt, hat das Konto kein Ablaufdatum.

Beispiel¶

Um einen neuen Benutzer mit dem Benutzernamen jdoe, vollständigem Namen John Doe und Passwort password123 hinzuzufügen:

dignacli add-user [OPTIONS] USER_NAME USER_FULL_NAME USER_PASSWORD

Um einen neuen Benutzer hinzuzufügen und ein Ablaufdatum für das Konto zu setzen:

dignacli add-user jdoe "John Doe" password123 --valid_until "2024-12-31 23:59:59"

Verwendung des Befehls delete-user¶

Der Befehl delete-user in der digna CLI wird verwendet, um einen bestehenden Benutzer aus dem digna System zu entfernen.

Befehlsverwendung¶

dignacli delete-user USER_NAME

Argumente¶

• USER_NAME: Der Benutzername des zu löschenden Benutzers (erforderlich). Dies ist das einzige vom Befehl benötigte Argument.

Beispiel¶

dignacli delete-user jdoe

Durch Ausführen dieses Befehls wird der Benutzer jdoe aus dem digna System entfernt, sein Zugriff entzogen und seine zugehörigen Daten und Berechtigungen im Repository gelöscht.

Verwendung des Befehls modify-user¶

Der Befehl modify-user in der digna CLI wird verwendet, um die Details eines bestehenden Benutzers im digna System zu aktualisieren.

Befehlsverwendung¶

dignacli modify-user <USER_NAME> <USER_FULL_NAME> [options]

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. Dieses Flag benötigt keinen Wert.
• --valid_until, -vu: Legt ein Ablaufdatum für das Benutzerkonto im Format YYYY-MM-DD HH:MI:SS fest. Wenn nicht angegeben, bleibt das Konto unbegrenzt gültig.

Beispiel¶

Um den vollständigen Namen des Benutzers jdoe in „Johnathan Doe“ zu ändern und den Benutzer als Superuser zu setzen:

dignacli modify-user jdoe "Johnathan Doe" --is_superuser

Verwendung des Befehls 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¶

dignacli modify-user-pwd <USER_NAME> <USER_PWD>

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:

dignacli modify-user-pwd jdoe newpassword123

Verwendung des Befehls list-users¶

Der Befehl list-users in der digna CLI zeigt eine Liste aller im digna System registrierten Benutzer an.

Befehlsverwendung¶

dignacli list-users

Durch Ausführen dieses Befehls verbindet sich die digna CLI mit dem digna Repository und listet alle Benutzer auf, wobei ID, Benutzername, vollständiger Name, Superuser-Status und Ablaufzeitstempel angezeigt werden.

Repository-Verwaltung¶

Verwendung des Befehls upgrade-repo¶

Der Befehl upgrade-repo in der digna CLI wird verwendet, um das digna Repository zu aktualisieren oder zu initialisieren. Dieser Befehl ist wichtig, um Updates anzuwenden oder die Repository-Infrastruktur zum ersten Mal einzurichten.

Befehlsverwendung¶

dignacli upgrade-repo [options]

Optionen¶

• --simulation-mode, -s: Wenn aktiviert, führt dieser Modus den Befehl im Simulationsmodus aus und druckt die SQL-Anweisungen, die ausgeführt würden, ohne diese tatsächlich zu übernehmen. 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:

dignacli upgrade-repo

dignacli upgrade-repo --simulation-mode

Dieser Befehl ist entscheidend für die Wartung des digna Systems und stellt sicher, dass das Datenbankschema und andere Repository-Komponenten mit der neuesten Version der Software übereinstimmen.

Verwendung des Befehls encrypt¶

Der Befehl encrypt in der digna CLI wird verwendet, um ein Passwort zu verschlüsseln.

Befehlsverwendung¶

dignacli encrypt <PASSWORD>

Argumente¶

• PASSWORD: Das zu verschlüsselnde Passwort (erforderlich).

Beispiel¶

Um ein Passwort zu verschlüsseln, müssen Sie das Passwort als Argument übergeben.
Beispielsweise, um das Passwort mypassword123 zu verschlüsseln, verwenden Sie:

dignacli encrypt mypassword123

Verwendung des Befehls generate-key¶

Der Befehl generate-key wird verwendet, um einen Fernet-Schlüssel zu generieren, der zur Sicherung von Passwörtern im digna Repository erforderlich ist.

Befehlsverwendung¶

dignacli generate-key

Datenverwaltung¶

Verwendung des Befehls 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 löschen. Dieser Befehl ist wichtig für das Daten-Lifecycle-Management und hilft, eine organisierte und effiziente Datenumgebung zu erhalten, indem veraltete oder unnötige Daten entfernt werden.

Befehlsverwendung¶

dignacli clean-up <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]

Argumente¶

• PROJECT_NAME: Der Name des Projekts, aus dem Daten entfernt werden sollen (erforderlich). Die Verwendung des Schlüsselworts all-projects in diesem Argument weist digna an, über alle vorhandenen Projekte zu iterieren und diesen 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, nach 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-Prozesses an.
• --help: Zeigt Hilfeinformationen 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:

dignacli clean-up ProjectA 2023-01-01 2023-06-30

Um Daten nur aus einer bestimmten Tabelle namens Table1 zu entfernen:

dignacli clean-up ProjectA 2023-01-01 2023-06-30 --table-name Table1

Dieser Befehl unterstützt die Verwaltung des Datenvolumens und stellt sicher, dass das Repository nur relevante Informationen enthält.

Verwendung des Befehls 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.

Befehlsverwendung¶

dignacli inspect <PROJECT_NAME> <FROM_DATE> <TO_DATE> [options]

Argumente¶

• PROJECT_NAME: Der Name des Projekts, für das Daten inspiziert werden sollen (erforderlich). Die Verwendung des Schlüsselworts all-projects in diesem Argument weist digna an, über alle vorhandenen Projekte zu iterieren und diesen 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, nach 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.
• --do-profile: Löst die Neuerfassung von Profilen aus. Standard ist do-profile.
• --no-do-profile: Verhindert die Neuerfassung von Profilen.
• --do-prediction: Löst die Neuberechnung von Vorhersagen aus. Standard ist do-prediction.
• --no-do-prediction: Verhindert die Neuberechnung von Vorhersagen.
• --do-alert-status: Löst die Neuberechnung von Alert-Status aus. Standard ist do-alert-status.
• --no-do-alert-status: Verhindert die Neuberechnung von Alert-Status.
• --iterative: Löst die Inspektion eines Zeitraums in täglichen Iterationen aus. Standard ist iterative.
• --no-iterative: Löst die Inspektion des gesamten Zeitraums in einem Durchlauf aus.
• --timing, -tm: Zeigt nach Abschluss die Dauer des Inspektionsprozesses an.

Beispiel¶

Um Daten für das Projekt ProjectA vom 1. Januar 2024 bis zum 31. Januar 2024 zu inspizieren:

dignacli inspect ProjectA 2024-01-01 2024-01-31

Um nur eine bestimmte Tabelle zu inspizieren und die Neuberechnung von Vorhersagen zu erzwingen:

dignacli inspect ProjectA 2024-01-01 2024-01-31 --table-name Table1 --force-prediction

Verwendung des Befehls tls-status¶

Der Befehl tls-status in der digna CLI wird verwendet, um den Status des Traffic Light Systems (TLS) für eine bestimmte Tabelle innerhalb eines Projekts an einem gegebenen Datum abzufragen. Das Ampelsystem liefert Einblicke in die Datenqualität und -gesundheit und weist auf Probleme oder Alarme hin, die Aufmerksamkeit erfordern könnten.

Befehlsverwendung¶

dignacli tls-status <PROJECT_NAME> <TABLE_NAME> <DATE>

Argumente¶

• PROJECT_NAME: Der Name des Projekts, für das der TLS-Status abgefragt wird (erforderlich).
• TABLE_NAME: Die spezifische Tabelle innerhalb des Projekts, für die der TLS-Status benötigt wird (erforderlich).
• DATE: Das Datum, für das der TLS-Status abgefragt wird, typischerweise im Format %Y-%m-%d (erforderlich).

Beispiel¶

Um den TLS-Status für eine Tabelle namens UserData im Projekt ProjectA am 1. Juli 2024 zu prüfen:

dignacli tls-status ProjectA UserData 2024-07-01

Dieser Befehl hilft Benutzern, die Datenqualität zu überwachen und zu pflegen, indem er einen klaren und handlungsorientierten Statusbericht basierend auf vordefinierten Kriterien liefert.

Verwendung des Befehls list-projects¶

Der Befehl list-projects in der digna CLI wird verwendet, um eine Liste aller im digna System verfügbaren Projekte anzuzeigen.

Befehlsverwendung¶

dignacli list-projects

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.

Verwendung des Befehls 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 nützlich, um die verfügbaren Datenressourcen für Analyse und Verwaltung im digna System zu verstehen.

Befehlsverwendung¶

dignacli list-ds <PROJECT_NAME>

Argumente¶

• PROJECT_NAME: Der Name des Projekts, für das die Datenquellen aufgelistet werden (erforderlich).

Beispiel¶

Um alle Datenquellen im Projekt ProjectA aufzulisten:

dignacli list-ds ProjectA

Dieser Befehl gibt Benutzern einen Überblick über die im Projekt verfügbaren Datenquellen und unterstützt sie dabei, die Datenlandschaft effektiver zu navigieren und zu verwalten.