Pular para o conteúdo

CLI de schema

O Saiku traz uma pequena ferramenta de schema dentro do jar do launcher. Ela converte um schema do Mondrian entre XML e YAML, e faz lint dele antes de você subir. Três subcomandos, sem servidor, rápida o bastante para colocar num hook do git.

Rode direto do jar que você já tem:

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

Isso é muito para digitar mais de uma vez, então os exemplos abaixo assumem um alias de shell:

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

Comandos

to-yaml — converter XML para YAML

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

Lê um schema XML Mondrian-4 e escreve a representação YAML equivalente. Se -o for omitido, o YAML é escrito no stdout.

Exemplo — converter FoodMart:

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

Exemplo — preview sem salvar:

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

to-xml — converter YAML para XML

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

Lê um schema YAML Mondrian-4 e escreve o XML equivalente. Se -o for omitido, o XML é escrito no stdout. Esta é a mesma conversão que o engine do Saiku executa automaticamente em runtime — executá-la manualmente é útil para inspecionar a saída antes do deploy ou para migrar de volta para uma toolchain XML-nativa.

Exemplo — converter de volta para XML:

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

Exemplo — pipe para diff para verificar fidelidade de round-trip:

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

lint — validar um arquivo de schema

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

Parseia e valida um arquivo de schema — YAML ou XML. Erros e warnings são escritos no stderr. Em caso de sucesso, o comando sai silenciosamente com código 0.

Exemplo — fazer lint de um schema YAML:

Terminal window
mondrian-schema lint demo/FoodMart.yaml

Exemplo — fazer lint de um schema XML:

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

Códigos de saída

CódigoSignificado
0Sucesso — sem erros
1Argumentos ruins ou arquivo de entrada faltando
2Falha de parse ou validação — diagnóstico escrito no stderr

Esses códigos são adequados para uso em pipelines de CI e hooks de pre-save.


Workflows típicos

  1. Converta seu schema XML existente para YAML:

    Terminal window
    mondrian-schema to-yaml my-schema.xml -o my-schema.yaml
  2. Faça lint do YAML para confirmar que é válido:

    Terminal window
    mondrian-schema lint my-schema.yaml
  3. Revise e anote my-schema.yaml com comentários, depois faça upload para o Saiku pela página Schemas.


Pré-requisitos

Só Java no seu $PATH, e o jar do launcher. Os dois vêm com qualquer instalação do Saiku; não há repositório para clonar nem nada para construir.

Se você é cliente do Saiku Cloud sem um jar local, não precisa dessa ferramenta de jeito nenhum — a página de Schemas te entrega o mesmo schema como XML, YAML ou JSON de canvas pelo menu da linha, e valida ao salvar.


Relacionado

  • Schemas YAML — a referência completa de elementos YAML.
  • Schemas — faça upload e gerencie schemas no dashboard do Saiku.
  • Schema designer — gere um schema a partir de uma descrição em linguagem natural.