PostgreSQL para diagrama ER

Como funciona

1. 01

   Cole ou solte a saída do pg_dump

   Um dump em texto puro, um arquivo de migração ou instruções CREATE TABLE vindas do psql, do pgAdmin ou de um ORM. Não é preciso limpar o dump antes.

2. 02

   Veja cada tabela com suas chaves

   As chaves que o pg_dump escreve no fim do arquivo são ligadas às suas tabelas, cada conexão de chave estrangeira começa na própria coluna, e um dump com vários esquemas ganha uma moldura por esquema.

3. 03

   Abra no Archboard

   Salve como um novo diagrama para reorganizar, anotar, compartilhar um link ou exportar em SVG e PNG. Para se cadastrar basta uma conta Google ou GitHub.

Extraia o esquema de banco de dados do PostgreSQL

Rode este comando no banco de dados e depois cole o schema.sql ou solte o arquivo:

1. --schema-only deixa as linhas de dados de fora, e --no-owner e --no-privileges removem as linhas OWNER TO, GRANT e REVOKE. Acrescente --schema=sales para gerar o dump de um só esquema. Troque mydb pelo nome do banco e acrescente -h e -U ou uma URI de conexão, se precisar.

   pg_dump --schema-only --no-owner --no-privileges mydb > schema.sql

Sintaxe do PostgreSQL em um dump

O que acontece com cada construção de um arquivo do pg_dump:

serial · GENERATED … AS IDENTITY

Lidas como colunas comuns que mantêm o tipo como está escrito; o padrão de identidade ou de sequência não aparece. Uma coluna serial só é marcada como PK quando uma PRIMARY KEY diz isso, porque serial sozinho não cria uma chave.

CREATE TYPE … AS ENUM

O nome do tipo enum vira o tipo da coluna, por exemplo order_status; os rótulos dele não aparecem no cartão.

CREATE SCHEMA

Quando o dump tem mais de um esquema, cada esquema com tabelas vira uma moldura em volta delas, e as chaves estrangeiras entre esquemas atravessam as molduras.

ALTER TABLE ONLY … ADD CONSTRAINT

Lido. O pg_dump escreve chaves primárias, restrições únicas e chaves estrangeiras bem no fim, e elas são aplicadas quando todas as tabelas já são conhecidas.

PARTITION OF

Recolhidas na tabela pai, então uma tabela dividida por mês vira um único cartão; a prévia informa quantas partições foram recolhidas. ATTACH PARTITION é tratado da mesma forma.

$$ … $$

Corpos de funções e procedimentos entre cifrões são ignorados por inteiro, então os pontos e vírgulas dentro deles não cortam uma instrução no meio. Dentro de um bloco DO, CREATE TABLE e ALTER TABLE … ADD CONSTRAINT continuam sendo lidos.

COPY … FROM stdin

As linhas de dados seguintes são ignoradas sem serem lidas, até a linha \. que as encerra.

\restrict

Ignorado. Versões recentes do pg_dump colocam linhas \restrict e \unrestrict em volta do dump; essas linhas e outros metacomandos do psql, como \connect, são ignorados.

O que um diagrama do pg_dump deixa de fora

• Os dados das tabelas. Linhas em blocos COPY e em instruções INSERT não são lidas, então um dump com dados desenha o mesmo diagrama que um feito com --schema-only.
• Funções, procedimentos, triggers e código de blocos DO. Os corpos são ignorados e contados; de um bloco DO só entram as tabelas e as restrições.
• Políticas de acesso por linha (RLS), GRANT e REVOKE e os donos dos objetos. Quem pode ler ou alterar uma tabela não aparece no diagrama.
• O que vem de um servidor PostgreSQL em execução. Nenhuma conexão é aberta, então tamanhos de tabela, contagens de linhas e extensões instaladas não aparecem.