Zum Inhalt springen

Schema-CLI

Saiku liefert ein kleines Schema-Werkzeug im Launcher-JAR mit. Es konvertiert ein Mondrian-Schema zwischen XML und YAML und lintet es, bevor Sie es hochladen. Drei Unterbefehle, kein Server nötig, schnell genug für einen Git-Hook.

Führen Sie es direkt aus dem JAR aus, das Sie ohnehin schon haben:

Terminal-Fenster
java -cp saiku-<version>.jar mondrian.schema.yaml.SchemaCli <command>

Das tippt sich kein zweites Mal gern, daher gehen die Beispiele unten von einem Shell-Alias aus:

Terminal-Fenster
alias mondrian-schema='java -cp /path/to/saiku-<version>.jar mondrian.schema.yaml.SchemaCli'

Befehle

to-yaml — XML zu YAML konvertieren

Terminal-Fenster
mondrian-schema to-yaml <input.xml> [-o output.yaml]

Liest ein Mondrian-4-XML-Schema und schreibt die äquivalente YAML-Darstellung. Wenn -o weggelassen wird, wird das YAML nach stdout geschrieben.

Beispiel — FoodMart konvertieren:

Terminal-Fenster
mondrian-schema to-yaml demo/FoodMart.mondrian.xml -o demo/FoodMart.yaml

Beispiel — Vorschau ohne Speichern:

Terminal-Fenster
mondrian-schema to-yaml demo/FoodMart.mondrian.xml | head -40

to-xml — YAML zu XML konvertieren

Terminal-Fenster
mondrian-schema to-xml <input.yaml> [-o output.xml]

Liest ein Mondrian-4-YAML-Schema und schreibt die äquivalente XML. Wenn -o weggelassen wird, wird die XML nach stdout geschrieben. Dies ist dieselbe Konvertierung, die die Saiku-Engine zur Laufzeit automatisch ausführt — sie manuell auszuführen ist nützlich, um die Ausgabe vor dem Deployment zu inspizieren oder zu einem XML-nativen Toolchain zurück zu migrieren.

Beispiel — zurück zu XML konvertieren:

Terminal-Fenster
mondrian-schema to-xml demo/FoodMart.yaml -o FoodMart-generated.xml

Beispiel — durch ein Diff pipen, um die Round-Trip-Treue zu verifizieren:

Terminal-Fenster
mondrian-schema to-xml demo/FoodMart.yaml | diff demo/FoodMart.mondrian.xml -

lint — eine Schema-Datei validieren

Terminal-Fenster
mondrian-schema lint <input.{yaml,xml}>

Parst und validiert eine Schema-Datei — entweder YAML oder XML. Fehler und Warnungen werden nach stderr geschrieben. Bei Erfolg beendet sich der Befehl still mit Code 0.

Beispiel — ein YAML-Schema linten:

Terminal-Fenster
mondrian-schema lint demo/FoodMart.yaml

Beispiel — ein XML-Schema linten:

Terminal-Fenster
mondrian-schema lint demo/FoodMart.mondrian.xml

Exit-Codes

CodeBedeutung
0Erfolg — keine Fehler
1Falsche Argumente oder fehlende Eingabedatei
2Parse- oder Validierungsfehler — Diagnose in stderr geschrieben

Diese Codes sind für die Verwendung in CI-Pipelines und Pre-Save-Hooks geeignet.


Typische Workflows

  1. Konvertieren Sie Ihr bestehendes XML-Schema in YAML:

    Terminal-Fenster
    mondrian-schema to-yaml my-schema.xml -o my-schema.yaml
  2. Linten Sie das YAML, um zu bestätigen, dass es gültig ist:

    Terminal-Fenster
    mondrian-schema lint my-schema.yaml
  3. Überprüfen und annotieren Sie my-schema.yaml mit Kommentaren, dann laden Sie es über die Schemas-Seite zu Saiku hoch.


Voraussetzungen

Nur Java auf Ihrem $PATH und das Launcher-JAR. Beides bringt jede Saiku-Installation mit; es gibt kein Repository zu klonen und nichts zu bauen.

Wenn Sie Saiku-Cloud-Kunde ohne lokales JAR sind, brauchen Sie dieses Werkzeug gar nicht — die Schema-Seite gibt Ihnen dasselbe Schema als XML, YAML oder Canvas-JSON aus dem Zeilenmenü und validiert beim Speichern.


Verwandt

  • YAML-Schemas — die vollständige YAML-Element-Referenz.
  • Schemas — Schemas im Saiku-Dashboard hochladen und verwalten.
  • Schema-Designer — ein Schema aus einer Natural-Language-Beschreibung generieren.