Saltar para o conteúdo
BeryX
Voltar ao guia do aplicativo

Documentação do BeryX

Regras

As regras de qualidade do workspace, que o scan avalia automaticamente e que abrem issues quando falham. Usa esta página para criar, editar, ativar ou apagar regras e para importar regras do dbt, Great Expectations, SodaCL ou ODCS.

O que podes fazer

  • Criar uma «Nova regra»: escolhe o dataset (ou todos), o tipo de regra (não nulo, único, padrão, intervalo, atualidade, mínimo de linhas, dígito de controlo, lista de referência ou regras de stream), a coluna, os limites e a severidade.
  • Ver, antes de gravar e se o dataset já tiver perfil, as estatísticas da coluna escolhida e uma estimativa de se a regra passaria ou falharia com o último perfil; numa regra nova, os limites vêm pré-preenchidos a partir dele.
  • Ativar ou desativar uma regra no interruptor da coluna «Ativa», mudá-la com «Editar» ou removê-la com «Apagar» (deixa de ser avaliada nos próximos scans).
  • Importar regras com «Importar (dbt/GX/Soda)»: cola um schema.yml do dbt, uma suite Great Expectations, checks SodaCL ou um contrato ODCS, usa «Pré-visualizar» e depois «Importar»; as regras ligam-se aos datasets pelo nome da tabela.
  • Trazer os testes singulares do dbt: no formato dbt, carrega os ficheiros tests/*.sql (com o schema.yml e o manifest.json, se quiseres) e cada teste vira uma regra SQL só de leitura; o que não converte aparece na lista do que ficou de fora, com o motivo.
  • Carregar o ficheiro manifest.json em «manifest.json do dbt» para juntar a linhagem ao grafo, comparar os testes dbt com as tuas regras num relatório de gaps e trazer as descrições dos modelos para o catálogo; ao aplicar, as sugestões de regra que daí resultam aguardam aprovação nas Sugestões.
  • Seguir o selo «ajuste proposto» até às Sugestões, onde revês a recalibração do limite proposta a partir do histórico de resultados da regra.

Ver também

  • Packs de regras — regras curadas por indústria, com o porquê de cada limite.
  • Sugestões — aceitar regras propostas e ajustes de limite.
  • Métodos — como o BeryX calcula cada número e recalibra os limiares.

English

Rules

The workspace's quality rules, which the scan evaluates automatically and which open issues when they fail. Use this page to create, edit, enable or delete rules and to import rules from dbt, Great Expectations, SodaCL or ODCS.

What you can do

  • Create a "New rule": choose the dataset (or all of them), the rule type (not null, unique, pattern, range, freshness, minimum row count, check digit, reference list or stream rules), the column, the thresholds and the severity.
  • See, before saving and if the dataset already has a profile, the chosen column's statistics and an estimate of whether the rule would pass or fail with the latest profile; for a new rule, the thresholds are pre-filled from it.
  • Enable or disable a rule with the switch in the "Active" column, change it with "Edit" or remove it with "Delete" (it is no longer evaluated in upcoming scans).
  • Import rules with "Import (dbt/GX/Soda)": paste a dbt schema.yml, a Great Expectations suite, SodaCL checks or an ODCS contract, use "Preview" and then "Import"; the rules are linked to datasets by table name.
  • Bring in dbt singular tests: with the dbt format, upload the tests/*.sql files (with the schema.yml and the manifest.json, if you like) and each test becomes a read-only SQL rule; whatever does not convert shows up in the list of what was left out, with the reason.
  • Upload your manifest.json file under "dbt manifest.json" to add its lineage to the graph, compare dbt tests with your rules in a gap report and bring model descriptions into the catalogue; once applied, the resulting rule suggestions await approval in Suggestions.
  • Follow the "tuning proposed" badge to Suggestions, where you review the threshold recalibration proposed from the rule's result history.

See also

  • Rule packs — rules curated by industry, with the reasoning behind each threshold.
  • Suggestions — accept proposed rules and threshold tunings.
  • Methods — how BeryX calculates each number, including threshold recalibration.