Documentação automágica de strings

planejado

Rastreie um valor sem explicação pelo DDL e deixe uma nota útil para a próxima pessoa, talvez você mesmo no futuro.

Encontrou um código misterioso em um conjunto de resultados? Quando o SQLly consegue seguir o valor através da Introspecção DDL, ele deixa uma nota inline explicando de onde o valor veio, para que a consulta responda um pouco mais das próprias curiosidades dela.

SELECT status /* ← enum: orders.status_id → status_codes.code */

De onde vem a explicação

Do esquema, em ordem de confiabilidade - e a nota indica qual foi usada:

  1. Uma chave estrangeira. O valor é um id em outra tabela: siga-o e indique o nome da tabela referenciada e da coluna legível dela.
  2. Uma restrição CHECK. Uma coluna restrita a uns poucos literais é uma enumeração na prática, e a restrição deixa o conjunto permitido explícito.
  3. Uma tabela de busca. Uma tabela pequena de linhas de código e descrição conectadas pelo nome em vez de por uma chave declarada, muito comum e que vale a pena reconhecer.
  4. Uma propriedade estendida ou comentário de coluna - onde sua equipe já anotou a resposta e nada estava mostrando isso para você.
Uma nota é um comentário, nunca uma reescrita. A explicação é inserida como um comentário SQL, então é inerte em qualquer outro lugar, sobrevive ao commit em um repositório e pode ser apagada com uma única tecla. Sua consulta significa exatamente o que significava antes.

Documentação como subproduto

A parte boa é a direção que as coisas estão tomando: você ia procurar isso de qualquer forma, e a nota significa que a próximo pessoa, muito possivelmente você no futuro, não precisa fazer isso. É o mesmo instinto que Documentar esquema, aplicando um valor intrigante por vez, em vez de um banco de dados inteiro de uma vez.

Planejado. O modelo de relacionamento e restrição que ele precisa já existe e já alimenta sugestão de junção e resolução de valor de exibição; é uma nova superfície sobre ele, não um conhecimento novo.