2020.06 2021.06

Die Kommandozeilenschnittstelle (CLI)

Der Abschnitt beschreibt die Arbeit mit der Kommandozeilenschnittstelle. Die hier beschiebenen Teile beziehen sich auf die Arbeit auf der Kommandozeile des jeweiligen OS. Für die Nutzung via Web gibt es eine gesonderte Beschreibung.

Allgemeines

Das Command Line Interface (CLI) soll dem Administrator von MyCoRe Anwendungen gestatten, via Batch-Betrieb Daten und Systemeinträge zu behandeln. Die eignet sich besonders für Massenverarbeitungen, wie sie beispielsweise in Migrationen vorkommen. Die Kommandos können dabei auch aus einer externen Datei kommen. Kommentarzeilen müssen mit einem # beginnen.

Aufruf des CLI

Die MyCoRe-CLI wird in der Regel in einem komplexeren Script, welches alle erforderlichen Pfadeinstellungen vornimmt, aufgerufen. Hier das Beispiel von mycore.sh in der Linux-Version. Diese Datei wird z. B. auch mit der aktuellen MIR-CLI ausgeliefert. Entscheidend ist dabei der Aufruf der Klasse org.mycore.frontend.cli.MCRCommandLineInterface . In diese Grundklasse werden per Konfiguration alle weiteren Kommandoklassen, welche die MyCoRe-Module mitbringen, integriert. Auf dem selben Weg lassen sich eigene Kommandos dem System hinzufügen.

Die Grundkommandos

help: Das Kommando listet alle zur Verfügung stehenden Kommandos aus.
help {0}: Das Kommando listet alle zur Verfügung stehenden Kommandos mit dem Anfang {0} aus.
process {0} oder ! {0}: Das Kommando führt die Kommandodatei {0} aus.
exit oder quit: Das Kommando beendet die Stapelverarbeitung mit dem CLI.
show file {0}: Das Kommando mach ein 'cat' der Datei {0} auf die für das Logging definierte Ausgabe.
whoami: Das Kommando zeigt den aktuellen Benutzer an.
show command statistics: Das Kommando zeigt eine aktuelle Statistik der verwendeten Kommandos an.
cancel on error: Das Kommando setzt einen Schalter, welcher die Stapelverarbeitung abbricht, wenn ein Fehler aufgetreten ist.
skip on error: Das Kommando setzt einen Schalter, welcher die Stapelverarbeitung fortsetzt, wenn ein Fehler aufgetreten ist.

Anfragen an das System per Kommandozeile

Es ist über das CLI auch möglich, Queries gegen die Anwendung abzusetzen und die Resultate im Batch-Betrieb zu verarbeiten.

run query from file {0}: das Kommando startet eine Anfrage mit einer Query, welche im File {0} steht.
run local query {0}: das Kommando startet eine Anfrage gegen das lokale System mit einer Query, welche im String {0} steht.
run distributed query {0}: das Kommando startet eine Anfrage gegen alle bekannten Systeme mit einer Query, welche im String {0} steht.

Übersicht der weiteren MyCoRe Kommandos

Weitere Kommandos werden in den Abschnitten dokumentiert, die die entsprechende Kompontente oder Funktionalität beschreiben.