Generatore di dizionario dei dati

ErdDocs genera il dizionario dei dati da un dump SQL, uno schema Prisma o i modelli del tuo framework. Tabelle, colonne, tipi, valori predefiniti, indici e relazioni finiscono in un unico documento di riferimento. Lo salvi in PDF dalla finestra di stampa del browser, e accanto hai il diagramma ER. Non serve registrarsi né installare nulla. Lo schema viene analizzato nel browser.

Il tuo 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 'Clienti registrati; una riga per persona';
COMMENT ON COLUMN customers.email IS 'Email di accesso, univoca in tutto il negozio';

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 'Catalogo; i prodotti eliminati conservano lo SKU';
COMMENT ON COLUMN products.stock IS 'Giacenza, aggiornata dal magazzino';

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, oppure 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 'Righe d’ordine; il prezzo resta quello dell’acquisto';

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 'Clienti registrati; una riga per persona';
COMMENT ON COLUMN customers.email IS 'Email di accesso, univoca in tutto il negozio';

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 'Catalogo; i prodotti eliminati conservano lo SKU';
COMMENT ON COLUMN products.stock IS 'Giacenza, aggiornata dal magazzino';

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, oppure 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 'Righe d’ordine; il prezzo resta quello dell’acquisto';

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.

Lo schema qui sotto ha commenti in italiano. Passa a «Dizionario dati» per vederli nella colonna descrizione.

Dal database al dizionario in tre passi

01Esporta lo schema: pg_dump --schema-only mydb > schema.sql per PostgreSQL, mysqldump --no-data mydb > schema.sql per MySQL, oppure prendi il tuo schema.prisma di Prisma così com’è.
02Incollalo qui sopra o trascina il file sul pannello. Il dizionario compare mentre lo schema viene letto.
03Fai clic su Salva come PDF e la finestra di stampa del browser produce il documento. Anche questo non passa da nessun server.

Le descrizioni vengono dal tuo schema

Le descrizioni hanno già un posto nei database, ma è raro vederle in un documento.

PostgreSQL: COMMENT ON TABLE orders IS '…' e COMMENT ON COLUMN orders.status IS '…'. pg_dump li esporta insieme allo schema, da solo.
MySQL: la clausola COMMENT '…' su colonne e tabelle dentro CREATE TABLE. mysqldump la conserva.
Prisma: i commenti di documentazione /// sopra modelli e campi finiscono nel dizionario come descrizioni.

Nella colonna Descrizione finiscono questi commenti. Se lo schema non ne ha, la colonna non compare, così il documento non mostra caselle vuote.

Tutto il resto si legge dal DDL stesso: i tipi come sono scritti, se una colonna ammette NULL, i valori predefiniti, le chiavi, gli indici e le partizioni raccolte sotto la tabella madre. Alcuni dump non dichiarano nessuna chiave esterna (Rails e Django lo fanno di rado). Allora le relazioni vengono ricostruite dai nomi delle colonne e segnate come tali. Così un revisore distingue sempre le chiavi dichiarate da quelle dedotte.

Chi ha bisogno di un dizionario dei dati

Audit e conformità. «Mandateci il dizionario dei dati» è una richiesta standard. ErdDocs risponde in pochi minuti partendo dal dump dello schema incollato. Costruirne uno a mano interrogando un database attivo richiede giorni.
Consegna al cliente. Le agenzie chiudono i progetti con la documentazione. ErdDocs la produce come un documento che il cliente può stampare e conservare.
Inserimento nel team. Chi arriva legge un solo documento invece di interrogare information_schema una tabella alla volta.
Esami e progetti universitari. Il dizionario dei dati si chiede anche lì, accanto allo schema E-R.

Cos’è un dizionario dei dati?

È il documento che descrive un database tabella per tabella. Per ogni campo riporta nome, tipo, se ammette NULL e valore predefinito. Elenca anche chiavi primarie ed esterne, indici e una descrizione di cosa contiene ogni cosa. Si chiede negli esami e nei progetti universitari, negli audit e nella consegna di un sistema al cliente.

Meglio di un modello in Excel o Word

Un modello si compila a mano e smette di coincidere con il database appena qualcuno cambia una tabella. Qui basta incollare di nuovo il dump e il dizionario torna aggiornato. Puoi rigenerarlo a ogni consegna.

Domande frequenti

Cosa contiene il dizionario dei dati generato?

ErdDocs descrive ogni tabella. Per ciascuna elenca le colonne con i tipi di dato esattamente come sono dichiarati, se ammettono NULL e i valori predefiniti. Aggiunge le chiavi primarie ed esterne con le colonne a cui fanno riferimento, i vincoli di unicità, gli indici ed entrambe le direzioni di ogni relazione. I commenti su tabelle e colonne dello schema diventano descrizioni. Le tabelle partizionate compaiono una volta sola, con le partizioni elencate sotto la tabella madre.

Come genero il dizionario dei dati di un database esistente?

Esporta lo schema in SQL. Per PostgreSQL usa pg_dump --schema-only, per MySQL mysqldump --no-data o MySQL Workbench. Incollalo qui sopra e passa alla vista «Dizionario dati». Stampando la pagina dal browser ottieni il PDF. Non si installa nulla e il SQL non lascia il tuo computer.

Come arrivano le descrizioni nel dizionario?

Dallo schema stesso. Nella colonna Descrizione finiscono gli statement COMMENT ON TABLE e COMMENT ON COLUMN di PostgreSQL, la clausola COMMENT 'testo' di MySQL e i commenti di documentazione /// di Prisma. Se lo schema non ha commenti, ErdDocs toglie del tutto la colonna Descrizione invece di stamparla vuota.

È gratis?

Il diagramma si disegna gratis fino a 25 tabelle. Il dizionario descrive per intero le tre tabelle più collegate. Le tabelle successive compaiono come riquadri con il nome, nel posto che occuperebbero, e le restanti vengono contate. Basta per vedere esattamente il documento che otterresti. Un pagamento unico di 9 USD sblocca il dizionario completo e l’intero diagramma, senza abbonamento, senza rinnovo e senza account.

Il mio schema viene caricato da qualche parte?

No. Analisi, diagramma e dizionario si fanno nel browser, e il PDF lo genera il browser stesso stampando la pagina. Lo schema non arriva a nessun server, perché non c’è nessun posto dove caricarlo.

Vedi anche

Generatore di dizionario dei dati per MySQL: le particolarità di mysqldump, la sintassi COMMENT in linea.
Generatore di dizionario dei dati per PostgreSQL: gli usi di pg_dump, COMMENT ON, le partizioni.
Modello di dizionario dei dati: le sette colonne, un CSV da scaricare e come compilarle una per una a mano.
Strumenti per documentare i database: generatori open source, strumenti code-first e piattaforme a confronto.
Alternativa a Dataedo: quando basta un documento e una piattaforma è troppo.
Da SQL a diagramma ER: lo stesso strumento, aperto sulla vista del diagramma.
Agent Link API: collega qualsiasi schema a un diagramma e a un dizionario dal vivo, da un README o da una risposta di un’IA.