Referência YAML

Tipo

Referência

Para

Desenvolvedor, Engenharia de dados

Cada recurso do workspace é um arquivo YAML com dois documentos: o cabeçalho (id, kind, lumo: v2, tenantId) e, depois de ---, o corpo. A forma do arquivo e o nome <slug>--<id>.yaml estão em Conceitos. As tabelas de campos destas páginas saem dos esquemas do Lumo CLI.

Tipos

kind	Na plataforma	Pasta	Página
flow	Dataflow	flows/	flow
table	Tabela do HorusDW	tables/	table
writeback	Cadastro	writebacks/	writeback
app	Aplicação	apps/	app
(dentro do app)	Dashboard	apps/	app-dashboard
credential	Credencial	credentials/	credential
schedule	Agendamento	schedules/	schedule
agent	Agente ETL	agents/	agent
dw-desk	Mesa de Dados	dw-desks/	desk
bi-desk	Mesa de Aplicação	bi-desks/	desk
variables	Variáveis do Tenant	variables/tenant.yaml	variables
investigation	Investigação	investigations/	investigation
deck	Deck	decks/	deck
presentation	Apresentação	presentations/	presentation

Esquemas

Os esquemas JSON ficam publicados em https://docs.horusbi.com.br/schemas/v2/<kind>.schema.json: flow, table, writeback, app, app-dashboard, credential, schedule, agent, dw-desk, bi-desk, desk (formato antigo), variables, investigation, deck, presentation e shared, que os outros referenciam. Com a extensão YAML do editor, uma linha no topo do arquivo liga autocompletar e validação:

# yaml-language-server: $schema=https://docs.horusbi.com.br/schemas/v2/flow.schema.json

Conferir antes do push

lumo lint flows/fato-vendas--5101.yaml   # forma do arquivo, offline e sem workspace
lumo scaffold ls                         # todos os modelos comentados
lumo scaffold flow                       # o modelo de um tipo
lumo list app                            # ids e nomes de um tipo
lumo info app:7302 --full                # ids de tabelas, colunas e indicadores

Sem argumento, na raiz do workspace, o lint confere todos os arquivos rastreados. Ele sai com código 8 quando encontra erro e, com --strict, com código 2 quando só há avisos. Ele confere a forma; regras que dependem do servidor, como Dataflow publicado ou Agente ETL diferente, só aparecem no push.