Aller au contenu

CLI de schema

Saiku embarque un petit outil de schema dans le jar du launcher. Il convertit un schema Mondrian entre XML et YAML, et le lint avant que vous ne le téléversiez. Trois sous-commandes, aucun serveur requis, et assez rapide pour tenir dans un hook git.

Lancez-le directement depuis le jar que vous avez déjà :

Fenêtre de terminal
java -cp saiku-<version>.jar mondrian.schema.yaml.SchemaCli <command>

C’est long à taper plus d’une fois, donc les exemples ci-dessous supposent un alias shell :

Fenêtre de terminal
alias mondrian-schema='java -cp /path/to/saiku-<version>.jar mondrian.schema.yaml.SchemaCli'

Commandes

to-yaml — convertir XML en YAML

Fenêtre de terminal
mondrian-schema to-yaml <input.xml> [-o output.yaml]

Lit un schema XML Mondrian-4 et écrit la représentation YAML équivalente. Si -o est omis, le YAML est écrit sur stdout.

Exemple — convertir FoodMart :

Fenêtre de terminal
mondrian-schema to-yaml demo/FoodMart.mondrian.xml -o demo/FoodMart.yaml

Exemple — prévisualiser sans enregistrer :

Fenêtre de terminal
mondrian-schema to-yaml demo/FoodMart.mondrian.xml | head -40

to-xml — convertir YAML en XML

Fenêtre de terminal
mondrian-schema to-xml <input.yaml> [-o output.xml]

Lit un schema YAML Mondrian-4 et écrit le XML équivalent. Si -o est omis, le XML est écrit sur stdout. C’est la même conversion que le moteur Saiku exécute automatiquement à l’exécution — l’exécuter manuellement est utile pour inspecter la sortie avant le déploiement ou pour migrer vers une chaîne d’outils XML native.

Exemple — convertir vers XML :

Fenêtre de terminal
mondrian-schema to-xml demo/FoodMart.yaml -o FoodMart-generated.xml

Exemple — pipe vers un diff pour vérifier la fidélité de l’aller-retour :

Fenêtre de terminal
mondrian-schema to-xml demo/FoodMart.yaml | diff demo/FoodMart.mondrian.xml -

lint — valider un fichier de schema

Fenêtre de terminal
mondrian-schema lint <input.{yaml,xml}>

Analyse et valide un fichier de schema — YAML ou XML. Les erreurs et avertissements sont écrits sur stderr. En cas de succès, la commande se termine silencieusement avec le code 0.

Exemple — linter un schema YAML :

Fenêtre de terminal
mondrian-schema lint demo/FoodMart.yaml

Exemple — linter un schema XML :

Fenêtre de terminal
mondrian-schema lint demo/FoodMart.mondrian.xml

Codes de sortie

CodeSignification
0Succès — pas d’erreurs
1Mauvais arguments ou fichier d’entrée manquant
2Échec d’analyse ou de validation — diagnostic écrit sur stderr

Ces codes conviennent à une utilisation dans les pipelines CI et les hooks pré-enregistrement.


Flux typiques

  1. Convertissez votre schema XML existant en YAML :

    Fenêtre de terminal
    mondrian-schema to-yaml my-schema.xml -o my-schema.yaml
  2. Lintez le YAML pour confirmer qu’il est valide :

    Fenêtre de terminal
    mondrian-schema lint my-schema.yaml
  3. Passez en revue et annotez my-schema.yaml avec des commentaires, puis téléversez-le dans Saiku via la page Schemas.


Prérequis

Juste Java sur votre $PATH, et le jar du launcher. Les deux arrivent avec n’importe quelle installation Saiku ; il n’y a aucun dépôt à cloner et rien à construire.

Si vous êtes client Saiku Cloud sans jar local, vous n’avez pas besoin de cet outil du tout — la page Schemas vous donne le même schema en XML, YAML ou JSON de canvas depuis le menu de la ligne, et valide à l’enregistrement.


Liens connexes

  • Schemas YAML — la référence complète des éléments YAML.
  • Schemas — téléversez et gérez les schemas dans le dashboard Saiku.
  • Schema designer — générez un schema à partir d’une description en langage naturel.