Generador de diccionario de datos

ErdDocs genera el diccionario de datos a partir de un volcado SQL, un esquema Prisma o modelos de tu framework. Todas las tablas, columnas, tipos, valores por defecto, índices y relaciones quedan en un solo documento de referencia. Lo guardas en PDF desde el diálogo de impresión del navegador, y al lado tienes el diagrama entidad relación. No hace falta registro ni instalación. El esquema se analiza en tu navegador.

Tu esquema

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 registrados; una fila por persona';
COMMENT ON COLUMN customers.email IS 'Correo de acceso, único en toda la tienda';

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; los productos dados de baja conservan su SKU';
COMMENT ON COLUMN products.stock IS 'Existencias, actualizadas por el almacén';

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, o 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 'Detalle del pedido; el precio queda fijo al comprar';

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 registrados; una fila por persona';
COMMENT ON COLUMN customers.email IS 'Correo de acceso, único en toda la tienda';

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; los productos dados de baja conservan su SKU';
COMMENT ON COLUMN products.stock IS 'Existencias, actualizadas por el almacén';

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, o 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 'Detalle del pedido; el precio queda fijo al comprar';

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.

El esquema de abajo trae comentarios en español. Cambia a «Diccionario de datos» para verlos en la columna de descripción.

De la base de datos al diccionario en tres pasos

01Exporta el esquema: pg_dump --schema-only mydb > schema.sql en PostgreSQL, mysqldump --no-data mydb > schema.sql en MySQL, o toma tu schema.prisma de Prisma tal como está.
02Pégalo arriba o arrastra el archivo al panel. El diccionario aparece a medida que se lee el esquema.
03Haz clic en Guardar como PDF, y el diálogo de impresión del navegador genera el documento. Tampoco pasa por ningún servidor.

Las descripciones salen de tu esquema

Las bases de datos ya tienen un lugar para las descripciones, pero casi nadie las ve en un documento.

PostgreSQL: COMMENT ON TABLE orders IS '…' y COMMENT ON COLUMN orders.status IS '…'. pg_dump los exporta junto con el esquema automáticamente.
MySQL: la cláusula COMMENT '…' en columnas y tablas dentro de CREATE TABLE. mysqldump la conserva.
Prisma: los comentarios de documentación /// sobre modelos y campos llegan al diccionario como descripciones.

Todo eso pasa a la columna Descripción. Si el esquema no trae comentarios, la columna no aparece, y el documento no muestra casillas vacías.

Todo lo demás se lee del propio DDL: los tipos tal como están escritos, si admiten nulos, los valores por defecto, las claves, los índices y las particiones agrupadas bajo su tabla madre. Algunos volcados no declaran ninguna clave foránea (Rails y Django casi nunca lo hacen). En ese caso las relaciones se recuperan por los nombres de las columnas y quedan marcadas como deducidas. Así un auditor siempre distingue las claves declaradas de las deducidas.

Quién necesita un diccionario de datos

Auditorías y cumplimiento. «Envíennos el diccionario de datos» es una solicitud habitual. ErdDocs la responde en minutos a partir de un volcado del esquema, mientras que armarlo a mano contra una base en vivo lleva días.
Entrega a un cliente. Las agencias cierran los proyectos con documentación. ErdDocs produce ese entregable como un documento que el cliente puede imprimir y conservar.
Incorporación al equipo. Quien llega nuevo lee un solo documento en lugar de consultar information_schema tabla por tabla.

¿Qué es un diccionario de datos?

Es el documento que describe una base de datos tabla por tabla. Para cada campo indica el nombre, el tipo, si admite nulos y el valor por defecto. También recoge las claves primarias y foráneas, los índices y una descripción de qué guarda cada cosa. Se pide en trabajos y proyectos de la universidad, en auditorías y al entregar un sistema a un cliente.

Mejor que una plantilla en Excel o Word

Una plantilla se llena a mano y deja de coincidir con la base en cuanto alguien cambia una tabla. Aquí pegas el volcado de nuevo y el diccionario vuelve a estar al día. Puedes regenerarlo en cada entrega.

Preguntas frecuentes

¿Qué contiene el diccionario de datos generado?

ErdDocs describe todas las tablas. Para cada una lista las columnas con su tipo de dato exactamente como se declaró, si admiten nulos y su valor por defecto. Añade las claves primarias y foráneas con las columnas a las que apuntan, las restricciones únicas, los índices y las dos direcciones de cada relación. Los comentarios de tablas y columnas del esquema se convierten en descripciones. Las tablas particionadas aparecen una sola vez, con sus particiones nombradas bajo la tabla madre.

¿Cómo genero el diccionario de datos de una base que ya existe?

Exporta el esquema en SQL. En PostgreSQL se hace con pg_dump --schema-only, y en MySQL, con mysqldump --no-data o MySQL Workbench. Pégalo arriba y cambia a la vista «Diccionario de datos». Al imprimir la página desde el navegador obtienes el PDF. No se instala nada y el SQL no sale de tu equipo.

¿Cómo entran las descripciones en el diccionario?

Salen del propio esquema. A la columna Descripción pasan las sentencias COMMENT ON TABLE y COMMENT ON COLUMN de PostgreSQL, la cláusula COMMENT 'texto' de MySQL y los comentarios de documentación /// de Prisma. Si el esquema no trae comentarios, ErdDocs quita la columna Descripción en lugar de imprimirla vacía.

¿Es gratis?

El diagrama se dibuja gratis hasta 25 tablas. Gratis, el diccionario describe completas las tres tablas más conectadas. Las siguientes aparecen como recuadros con su nombre, en el lugar que ocuparían, y el resto se cuenta. Basta para que veas el documento exacto que obtendrías. Un pago único de 9 US$ desbloquea el diccionario completo y el diagrama entero, sin suscripción, sin renovación y sin cuenta.

¿Mi esquema se sube a algún sitio?

No. El análisis, el diagrama y el diccionario se hacen en tu navegador, y el PDF lo genera el propio navegador al imprimir la página. El esquema nunca llega a un servidor, porque no hay ninguno al que subirlo.

Relacionado

Generador de diccionario de datos para MySQL: lo propio de mysqldump y la sintaxis de COMMENT en línea.
Generador de diccionario de datos para PostgreSQL: las costumbres de pg_dump, COMMENT ON y las particiones.
Plantilla de diccionario de datos: las siete columnas, un CSV para descargar y cómo llenar cada una a mano.
Herramientas de documentación de bases de datos: comparativa de generadores de código abierto, herramientas basadas en código y plataformas.
Alternativa a Dataedo: cuando basta con un documento y una plataforma es demasiado.
De SQL a diagrama ER: la misma herramienta, abierta en la vista del diagrama.
Agent Link API: enlaza cualquier esquema a un diagrama y un diccionario en vivo desde un README o una respuesta de IA.