Gerador de dicionário de dados

O ErdDocs gera o dicionário de dados a partir de um dump SQL, de um schema Prisma ou dos models do seu framework. Todas as tabelas, colunas, tipos, valores padrão, índices e relacionamentos ficam num único documento de referência. Você salva esse documento em PDF pela caixa de impressão do navegador, com o diagrama entidade relacionamento ao lado. Não precisa de cadastro nem instalação. O schema é analisado no seu navegador.

Seu schema

CREATE TABLE customers (
    id          bigserial PRIMARY KEY,
    email       varchar(255) NOT NULL UNIQUE,
    full_name   varchar(120),
    created_at  timestamptz  NOT NULL DEFAULT now()
);
COMMENT ON TABLE customers IS 'Clientes cadastrados; uma linha por pessoa';
COMMENT ON COLUMN customers.email IS 'E-mail de login, único em toda a loja';

CREATE TABLE products (
    id        bigserial     PRIMARY KEY,
    sku       varchar(40)   NOT NULL UNIQUE,
    title     varchar(200)  NOT NULL,
    price     numeric(10,2) NOT NULL,
    stock     int           NOT NULL DEFAULT 0
);
COMMENT ON TABLE products IS 'Catálogo; produtos excluídos mantêm o SKU';
COMMENT ON COLUMN products.stock IS 'Estoque disponível, atualizado pelo armazém';

CREATE TABLE orders (
    id           bigserial     PRIMARY KEY,
    customer_id  bigint        NOT NULL REFERENCES customers(id),
    status       varchar(20)   NOT NULL DEFAULT 'pending',
    total        numeric(10,2) NOT NULL,
    placed_at    timestamptz   NOT NULL DEFAULT now()
);
COMMENT ON COLUMN orders.status IS 'pending -> paid -> shipped -> done, ou cancelled';

CREATE TABLE order_items (
    order_id    bigint        NOT NULL REFERENCES orders(id),
    product_id  bigint        NOT NULL REFERENCES products(id),
    qty         int           NOT NULL,
    unit_price  numeric(10,2) NOT NULL,
    PRIMARY KEY (order_id, product_id)
);
COMMENT ON TABLE order_items IS 'Itens do pedido; o preço fica fixo na compra';

CREATE TABLE shipments (
    id         bigserial   PRIMARY KEY,
    order_id   bigint      NOT NULL REFERENCES orders(id),
    carrier    varchar(60) NOT NULL,
    tracking   varchar(80),
    shipped_at timestamptz
);

CREATE INDEX idx_orders_customer ON orders(customer_id);
CREATE INDEX idx_shipments_order ON shipments(order_id);

CREATE TABLE customers (
    id          bigserial PRIMARY KEY,
    email       varchar(255) NOT NULL UNIQUE,
    full_name   varchar(120),
    created_at  timestamptz  NOT NULL DEFAULT now()
);
COMMENT ON TABLE customers IS 'Clientes cadastrados; uma linha por pessoa';
COMMENT ON COLUMN customers.email IS 'E-mail de login, único em toda a loja';

CREATE TABLE products (
    id        bigserial     PRIMARY KEY,
    sku       varchar(40)   NOT NULL UNIQUE,
    title     varchar(200)  NOT NULL,
    price     numeric(10,2) NOT NULL,
    stock     int           NOT NULL DEFAULT 0
);
COMMENT ON TABLE products IS 'Catálogo; produtos excluídos mantêm o SKU';
COMMENT ON COLUMN products.stock IS 'Estoque disponível, atualizado pelo armazém';

CREATE TABLE orders (
    id           bigserial     PRIMARY KEY,
    customer_id  bigint        NOT NULL REFERENCES customers(id),
    status       varchar(20)   NOT NULL DEFAULT 'pending',
    total        numeric(10,2) NOT NULL,
    placed_at    timestamptz   NOT NULL DEFAULT now()
);
COMMENT ON COLUMN orders.status IS 'pending -> paid -> shipped -> done, ou cancelled';

CREATE TABLE order_items (
    order_id    bigint        NOT NULL REFERENCES orders(id),
    product_id  bigint        NOT NULL REFERENCES products(id),
    qty         int           NOT NULL,
    unit_price  numeric(10,2) NOT NULL,
    PRIMARY KEY (order_id, product_id)
);
COMMENT ON TABLE order_items IS 'Itens do pedido; o preço fica fixo na compra';

CREATE TABLE shipments (
    id         bigserial   PRIMARY KEY,
    order_id   bigint      NOT NULL REFERENCES orders(id),
    carrier    varchar(60) NOT NULL,
    tracking   varchar(80),
    shipped_at timestamptz
);

CREATE INDEX idx_orders_customer ON orders(customer_id);
CREATE INDEX idx_shipments_order ON shipments(order_id);

Your diagram appears here.

O schema abaixo tem comentários em português. Mude para «Dicionário de dados» para vê-los na coluna de descrição.

Do banco ao dicionário em três passos

01Exporte o schema: pg_dump --schema-only mydb > schema.sql no PostgreSQL, mysqldump --no-data mydb > schema.sql no MySQL, ou pegue o schema.prisma do Prisma como ele está.
02Cole acima ou arraste o arquivo para o painel. O dicionário aparece conforme o schema é lido.
03Clique em Salvar como PDF, e a caixa de impressão do navegador gera o documento. Ele também não passa por servidor nenhum.

As descrições vêm do seu schema

Os bancos de dados já têm um lugar para as descrições, mas quase ninguém as vê num documento.

PostgreSQL: COMMENT ON TABLE orders IS '…' e COMMENT ON COLUMN orders.status IS '…'. O pg_dump exporta esses comentários junto com o schema automaticamente.
MySQL: a cláusula COMMENT '…' em colunas e tabelas dentro do CREATE TABLE. O mysqldump a mantém.
Prisma: os comentários de documentação /// acima de models e campos chegam ao dicionário como descrições.

Tudo isso vai para a coluna Descrição. Se o schema não tem comentários, a coluna não aparece, e o documento não mostra campos vazios.

Todo o resto é lido do próprio DDL: os tipos como foram escritos, se aceitam nulo, os valores padrão, as chaves, os índices e as partições agrupadas sob a tabela mãe. Alguns dumps não declaram nenhuma chave estrangeira (Rails e Django raramente declaram). Nesse caso, os relacionamentos são recuperados pelos nomes das colunas e marcados como deduzidos. Assim um auditor sempre distingue as chaves declaradas das deduzidas.

Quem precisa de um dicionário de dados

Auditorias e compliance. «Mandem o dicionário de dados» é um pedido comum. O ErdDocs atende a partir de um dump do schema em minutos, enquanto montar um à mão consultando um banco ao vivo leva dias.
Entrega ao cliente. Agências fecham projetos com documentação. O ErdDocs produz essa entrega como um documento que o cliente pode imprimir e guardar.
Onboarding. Quem chega no time lê um único documento em vez de consultar o information_schema tabela por tabela.

O que é um dicionário de dados?

É o documento que descreve um banco de dados tabela por tabela. Para cada campo, ele traz o nome, o tipo, se aceita nulo e o valor padrão. Também lista as chaves primárias e estrangeiras, os índices e uma descrição do que cada campo guarda. É pedido em trabalhos de faculdade e TCC, em auditorias e na entrega de um sistema ao cliente.

Melhor que um modelo em Excel ou Word

Um modelo é preenchido à mão e deixa de bater com o banco assim que alguém muda uma tabela. Aqui você cola o dump de novo e o dicionário volta a estar em dia. Dá para refazê-lo a cada entrega.

Perguntas frequentes

O que tem no dicionário de dados gerado?

O ErdDocs descreve todas as tabelas. Para cada uma, ele lista as colunas com o tipo de dado exatamente como foi declarado, se aceitam nulo e o valor padrão. Ele acrescenta as chaves primárias e estrangeiras com as colunas para onde apontam, as restrições únicas, os índices e as duas direções de cada relacionamento. Os comentários de tabelas e colunas do schema viram descrições. Tabelas particionadas aparecem uma vez só, com as partições listadas sob a tabela mãe.

Como gerar o dicionário de dados de um banco que já existe?

Exporte o schema em SQL. No PostgreSQL, use pg_dump --schema-only. No MySQL, use mysqldump --no-data ou o MySQL Workbench. Cole acima e mude para a visão «Dicionário de dados». Ao imprimir a página no navegador, você obtém o PDF. Nada é instalado e o SQL não sai do seu computador.

Como as descrições entram no dicionário?

Elas vêm do próprio schema. Para a coluna Descrição vão os comandos COMMENT ON TABLE e COMMENT ON COLUMN do PostgreSQL, a cláusula COMMENT 'texto' do MySQL e os comentários de documentação /// do Prisma. Se o schema não tem comentários, o ErdDocs tira a coluna Descrição em vez de imprimi-la vazia.

É grátis?

O diagrama é desenhado de graça até 25 tabelas. Na versão grátis, o dicionário descreve por completo as três tabelas mais conectadas. As seguintes aparecem como quadros com o nome, no lugar que ocupariam, e o restante é contado. Isso basta para você ver exatamente o documento que receberia. Um pagamento único de US$ 9 libera o dicionário completo e o diagrama inteiro, sem assinatura, sem renovação e sem conta.

Meu schema é enviado para algum lugar?

Não. A análise, o diagrama e o dicionário acontecem no seu navegador, e o PDF é gerado pelo próprio navegador ao imprimir a página. O schema nunca chega a um servidor, porque não existe nenhum para onde enviá-lo.

Veja também

Gerador de dicionário de dados para MySQL: o que é próprio do mysqldump e a sintaxe do COMMENT na linha.
Gerador de dicionário de dados para PostgreSQL: os hábitos do pg_dump, COMMENT ON e partições.
Modelo de dicionário de dados: as sete colunas, um CSV para baixar e como preencher cada uma à mão.
Ferramentas de documentação de banco de dados: comparativo de geradores open source, ferramentas baseadas em código e plataformas.
Alternativa ao Dataedo: quando um documento basta e uma plataforma é demais.
De SQL para diagrama ER: a mesma ferramenta, aberta na visão do diagrama.
Agent Link API: ligue qualquer schema a um diagrama e um dicionário ao vivo a partir de um README ou de uma resposta de IA.