validate comando

Valide um arquivo de configuração do construtor de API de dados sem iniciar o tempo de execução. Executa uma sequência de verificações (esquema, estrutura, permissões, conectividade, metadados) e retorna um código de saída para êxito (0) ou falha (diferente de zero). Útil em pipelines de CI/CD.

Sintaxe

dab validate [options]

Visão rápida

Códigos de saída

Exemplo de IC:

dab validate && echo "OK" || { echo "INVALID CONFIG"; exit 1; }

dab validate
if %errorlevel%==0 (echo OK) else (echo INVALID CONFIG & exit /b 1)

-c, --config

Caminho para o arquivo de configuração. Se omitido, o validador procura dab-config.<DAB_ENVIRONMENT>.json primeiro, depois dab-config.json.

Example

dab validate \
  --config ./dab-config.prod.json

dab validate ^
  --config ./dab-config.prod.json

Etapas de validação

A validação acontece em ordem. Se um estágio falhar, os estágios posteriores serão ignorados.

1. Esquema

Verifica se o JSON de configuração corresponde ao esquema.

Regras

• $schema é acessível ou estruturalmente válido
• data-source, runtimee entities as secções existem e estão bem formadas
• Propriedades inesperadas não permitidas (por esquema)
• Os valores de Enum (como database-type) são válidos

Falhas e correções

2. Propriedades de configuração

Verifica a consistência além do esquema.

Regras

• Válido database-type fornecido
• Para cosmosdb_nosql, o banco de dados e o caminho do esquema GraphQL são necessários. Um contêiner também pode ser necessário, dependendo das entidades. As configurações REST são ignoradas.
• Pelo menos um ponto de extremidade (REST, GraphQL, MCP) deve estar habilitado
• Os caminhos REST/GraphQL começam com / e não colidem
• Os sinalizadores herdados *.disabled emitem avisos, mas não falham
• Se estiver usando JWT, tanto o emissor quanto o público devem ser definidos

Falhas e correções

3. Permissões

Verifica se as permissões de cada entidade são válidas.

Regras

• Cada entrada tem uma função não vazia

• As ações devem ser válidas:

  • Tabelas/vistas: create, read, update, delete, *
  • Procs armazenados: execute, *

• Sem listas de ações vazias

• Um único conjunto de ações deve ser * OU ações explícitas, não ambas

Falhas e correções

4. Conexão com o banco de dados

Verifica se a conexão de banco de dados funciona.

Regras

• Cadeia de conexão analisável
• Credenciais válidas
• O banco de dados/contêiner existe

Falhas e correções

5. Metadados da entidade

Verifica as definições de entidade em relação ao banco de dados.

Regras

• O objeto de origem existe
• Tabelas/vistas: campos chave válidos, campos incluídos/excluídos existem
• As visualizações sempre precisam source.key-fields
• Procedimentos armazenados: assinatura de correspondência de parâmetros
• Relacionamentos: a entidade alvo existe, os campos de ligação alinham-se com as chaves; linking.object deve existir para muitos-para-muitos
• Campos válidos de referência de políticas
• Cache TTL não negativo

Falhas e correções

Exemplos de saída

Sucesso:

Data API builder <version>
Config is valid.

Falha:

Data API builder <version>
Error: View 'sales_summary' missing required key-fields.
Config is invalid.

Arquivos Environment-Specific

Se DAB_ENVIRONMENT estiver definido, validate carrega dab-config.<DAB_ENVIRONMENT>.json.

Example

export DAB_ENVIRONMENT=Staging
dab validate

set DAB_ENVIRONMENT=Staging
dab validate

Exemplo de Utilização

Básico:

dab validate

dab validate

Arquivo explícito:

dab validate \
  --config ./configs/dab-config.test.json

dab validate ^
  --config ./configs/dab-config.test.json

Multi-ambiente:

for env in Development Staging Production; do
  echo "Validating $env..."
  DAB_ENVIRONMENT=$env dab validate || exit 1
done

for %E in (Development Staging Production) do ^
  echo Validating %E... ^
  set DAB_ENVIRONMENT=%E ^& dab validate ^|^| exit /b 1

Falha rápida de CI:

dab validate && echo "OK" || { echo "INVALID CONFIG"; exit 1; }

dab validate
if %errorlevel%==0 (echo OK) else (echo INVALID CONFIG & exit /b 1)

Workflow

1. Executar dab validate
2. Corrigir o primeiro estágio com falha
3. Execute novamente até que o código de saída seja 0
4. Configuração validada de confirmação