Data Dictionary erstellen

ErdDocs erzeugt das Data Dictionary aus einem SQL-Dump, einem Prisma-Schema oder den Modellen Ihres Frameworks. Alle Tabellen, Spalten, Typen, Standardwerte, Indizes und Beziehungen stehen in einem Nachschlagewerk. Über den Druckdialog des Browsers speichern Sie es als PDF, und daneben sehen Sie das ER-Diagramm. Sie brauchen weder Anmeldung noch Installation. Das Schema wird im Browser ausgewertet.

Ihr 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 'Registrierte Kunden; eine Zeile pro Person';
COMMENT ON COLUMN customers.email IS 'Login-Adresse, im ganzen Shop eindeutig';

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 'Katalog; gelöschte Artikel behalten ihre SKU';
COMMENT ON COLUMN products.stock IS 'Lagerbestand, vom Lager-Import aktualisiert';

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, oder 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 'Bestellpositionen; der Preis wird beim Kauf festgeschrieben';

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 'Registrierte Kunden; eine Zeile pro Person';
COMMENT ON COLUMN customers.email IS 'Login-Adresse, im ganzen Shop eindeutig';

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 'Katalog; gelöschte Artikel behalten ihre SKU';
COMMENT ON COLUMN products.stock IS 'Lagerbestand, vom Lager-Import aktualisiert';

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, oder 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 'Bestellpositionen; der Preis wird beim Kauf festgeschrieben';

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.

Das Schema unten trägt deutsche Kommentare. Schalten Sie auf „Data Dictionary“, um das Dokument mit Beschreibungsspalte zu sehen.

Von der Datenbank zum Data Dictionary in drei Schritten

01Schema exportieren: pg_dump --schema-only mydb > schema.sql für PostgreSQL, mysqldump --no-data mydb > schema.sql für MySQL, oder Sie nehmen Ihr Prisma-schema.prisma, wie es ist. In SQL Server geht das über „Skripts generieren“.
02Oben einfügen oder die Datei auf das Feld ziehen. Das Data Dictionary entsteht, während das Schema gelesen wird.
03Auf Als PDF speichern klicken. Der Druckdialog Ihres Browsers erzeugt das Dokument. Auch dabei wird kein Server berührt.

Die Beschreibungen kommen aus Ihrem Schema

Datenbanken haben längst einen Platz für Beschreibungen, aber in einem fertigen Dokument hat sie kaum jemand gesehen.

PostgreSQL: COMMENT ON TABLE orders IS '…' und COMMENT ON COLUMN orders.status IS '…'. pg_dump exportiert sie automatisch mit dem Schema.
MySQL: die Klausel COMMENT '…' an Spalten und Tabellen in CREATE TABLE. mysqldump behält sie bei.
Prisma: ///-Kommentare über Modellen und Feldern landen im Data Dictionary als Beschreibungen.

Diese Kommentare landen alle in der Spalte Beschreibung. Hat das Schema keine Kommentare, entfällt die Spalte ganz. So zeigt das Dokument keine leeren Felder.

Alles andere wird aus dem DDL selbst gelesen: Typen, wie sie geschrieben sind, NULL-Fähigkeit, Standardwerte, Schlüssel, Indizes und Partitionen, die unter ihrer Elterntabelle zusammengefasst werden. Manche Dumps deklarieren überhaupt keine Fremdschlüssel (Rails und Django tun das selten). Dann werden die Beziehungen aus der Benennung der Spalten abgeleitet und als abgeleitet markiert. So kann eine Prüferin immer unterscheiden, welche Schlüssel deklariert und welche abgeleitet sind.

Wer ein Data Dictionary braucht

Audits und Compliance. „Schicken Sie uns das Data Dictionary“ ist eine Standardanfrage. ErdDocs beantwortet sie aus einem eingefügten Schema-Dump in Minuten. Von Hand an einer laufenden Datenbank zusammengestellt, dauert das Tage.
Übergabe an Kunden. Agenturen schließen Projekte mit einer Dokumentation ab. ErdDocs liefert sie als Dokument, das der Kunde drucken und aufbewahren kann.
Einarbeitung. Eine neue Entwicklerin liest ein einziges Dokument, statt information_schema Tabelle für Tabelle abzufragen.

Was ist ein Data Dictionary?

Ein Data Dictionary beschreibt eine Datenbank Tabelle für Tabelle. Für jede Spalte nennt es Name und Typ, ob NULL erlaubt ist und den Standardwert. Dazu kommen Primär- und Fremdschlüssel, Indizes und eine Beschreibung, was in der Spalte steht. Man braucht es für die Einarbeitung, für Audits, bei der Übergabe an Kunden und in der Ausbildung.

Besser als eine Excel- oder Word-Vorlage

Eine Vorlage wird von Hand gepflegt und stimmt nicht mehr, sobald jemand eine Tabelle ändert. Hier fügen Sie den Dump einfach erneut ein, und das Data Dictionary ist wieder aktuell. So können Sie es zu jeder Auslieferung neu erzeugen.

Häufige Fragen

Was enthält das erzeugte Data Dictionary?

ErdDocs beschreibt jede Tabelle. Für jede nennt es die Spalten mit ihren Datentypen, genau wie deklariert, dazu NULL-Fähigkeit und Standardwerte. Es ergänzt Primär- und Fremdschlüssel mit den Spalten, auf die sie verweisen, Unique-Constraints, Indizes und beide Richtungen jeder Beziehung. Tabellen- und Spaltenkommentare aus dem Schema werden zu Beschreibungen. Partitionierte Tabellen erscheinen einmal, mit ihren Partitionen unter der Elterntabelle.

Wie erstelle ich ein Data Dictionary aus einer bestehenden Datenbank?

Exportieren Sie das Schema als SQL. Für PostgreSQL ist das pg_dump --schema-only, für MySQL mysqldump --no-data, in SQL Server „Skripts generieren“. Fügen Sie das Ergebnis oben ein und schalten Sie auf die Ansicht „Data Dictionary“ um. Wenn Sie die Seite drucken, entsteht das PDF. Es wird nichts installiert, und das SQL verlässt Ihren Rechner nicht.

Wie kommen die Beschreibungen ins Data Dictionary?

Aus dem Schema selbst. In die Spalte Beschreibung kommen COMMENT ON TABLE und COMMENT ON COLUMN aus PostgreSQL, die Klausel COMMENT 'Text' aus MySQL und ///-Kommentare aus Prisma. Hat das Schema keine Kommentare, lässt ErdDocs die Spalte ganz weg, statt sie leer zu drucken.

Ist es kostenlos?

Das Diagramm zeichnet bis zu 25 Tabellen kostenlos. In der kostenlosen Version beschreibt das Data Dictionary die drei am stärksten verbundenen Tabellen vollständig. Die folgenden Tabellen erscheinen als Rahmen mit ihrem Namen an der Stelle, die sie einnehmen würden, und der Rest wird gezählt. So sehen Sie genau, welches Dokument Sie bekämen. Eine einmalige Zahlung von 9 US-$ schaltet das vollständige Data Dictionary und das ganze Diagramm frei. Es gibt kein Abo, keine Verlängerung und kein Konto.

Wird mein Schema hochgeladen?

Nein. Auswertung, Diagramm und Data Dictionary entstehen im Browser, und das PDF erzeugt der Browser selbst beim Drucken. Das Schema erreicht nie einen Server, denn es gibt keinen, an den es gehen könnte.