Documentar esquema

funcional

Gerar documentação em Markdown do esquema do banco de dados, pronta para um repositório ou wiki.

Gerar Markdown documentação do esquema do banco de dados em uma etapa: escolha a ação, escolha onde salvar, pronto. De propósito, não há nada para configurar: o documento é gerado a partir do modelo de esquema que o SQLly já carregou para o IntelliSense, então não precisa de uma ida e volta extra ao servidor e reflete exatamente o que o aplicativo conhece.

O resultado é um dicionário de dados com cabeçalho da conexão e do banco de dados, dividido em Tabelas, Visualizações, Procedimentos, Funções, e Outros objetos. Cada tabela ganha uma grade de colunas, nome, tipo, nulabilidade, padrão e anotações de chave (chave primária, identity, FK → alvo) - mais as chaves estrangeiras como uma lista; rotinas ganham suas assinaturas de parâmetros e tipos de retorno. Esquemas muito grandes são divididos automaticamente em um arquivo de índice mais um arquivo por esquema, para que o resultado continue navegável em um repositório ou wiki.

SQLly
Saída de Esquema de Documento (Markdown) do SQLLYSaída de Esquema de Documento (Markdown) do SQLLY
Documentar Esquema: a estrutura do banco de dados renderizada como documentação Markdown pronta para salvar.

Escrevendo um dicionário de dados

  1. Conecte-se e dê um momento para o modelo do esquema carregar (é o mesmo modelo que alimenta o autocompletar). Se ainda não tiver carregado, o SQLly informa na barra de status e não faz nada.
  2. Clique com o botão direito no banco de dados no explorador e escolha Esquema › Documentar Esquema (Markdown)..., ou execute Documentar esquema (Markdown)... do paleta de comandos. Ao abrir a partir do explorador, esse banco de dados é ativado primeiro.
  3. A caixa de diálogo de salvar abre com schema-docs.md sugerido. Escolha uma pasta e um nome.
  4. A barra de status confirma onde foi salvo e quantos arquivos foram gerados quando o esquema foi dividido.

Como o Markdown fica

Os objetos são ordenados por seção e depois por nome. Um pequeno esquema produz algo assim:

# Data Dictionary — Shop / sales

Generated by SQLLY from the loaded schema model. 2 objects.

## Tables

### dbo.Orders

| Column | Type | Nullable | Default | Key |
|---|---|---|---|---|
| OrderId | int | no |  | PK, identity |
| CustomerId | int | no |  | FK → dbo.Customers |
| Total | decimal | yes |  |  |

- Foreign key (CustomerId) → dbo.Customers (CustomerId)

## Procedures

### dbo.PlaceOrder

| Parameter | Type | Mode | Default |
|---|---|---|---|
| @CustomerId | int | in |  |
  • Tabelas - uma linha por coluna. Anulável é yes, no, ou ? quando o modelo não sabe. A Chave célula combina PK, FK → target, e identity.
  • Visualizações - uma grade de Coluna / Tipo, ou Colunas não registradas no modelo de esquema quando o modelo só conhece o nome da visão.
  • Procedimentos e funções - uma grade Parâmetro / Tipo / Modo / Padrão (o modo é in, out, ou in/out), Sem parâmetros. quando não há nenhum, e um Retorna: linha para funções.
  • Outros objetos - sinônimos mostram o destino deles; qualquer outra coisa é listada pelo nome com Nenhum detalhe estrutural registrado.

Caracteres pipe nos valores são escapados e as quebras de linha viram espaços, para que padrões e tipos nunca quebrem o layout da tabela.

Esquemas grandes

Até 2.000 objetos vão para o arquivo único que você nomeou. Passado isso, o SQLly escreve esse arquivo como um índice listando cada esquema com sua contagem de objetos e um link, além de um arquivo por esquema ao lado dele, nomeado após o seu arquivo: schema-docs.sales.md, schema-docs.audit.md, e assim por diante. Os nomes de esquema viram nomes de arquivo válidos, e dois esquemas que colidiriam recebem um sufixo numérico em vez de sobrescrever um ao outro. Nada é truncado.

Coisas a saber

  • Funciona em todos os mecanismos aos quais o SQLly se conecta, porque lê o modelo do próprio SQLly em vez de um catálogo específico do mecanismo.
  • O documento é tão completo quanto o modelo carregado. Se o modelo nunca registrou as colunas de uma view, o documento diz isso em vez de adivinhar.
  • Salvar grava o arquivo diretamente; arquivos existentes com os mesmos nomes são substituídos.
  • Salvar em um arquivo não está disponível na visualização do navegador; use o aplicativo para desktop.