Schema dokumentieren
funktionalMarkdown-Dokumentation des Datenbankschemas generieren, bereit für ein Repo oder Wiki.
Generieren Markdown Dokumentation des Datenbankschemas in einem Schritt: Aktion auswählen, Speicherort wählen, fertig. Es gibt absichtlich nichts zu konfigurieren: Das Dokument wird aus dem Schemamodell erstellt, das SQLly bereits für IntelliSense geladen hat, daher ist kein zusätzlicher Server-Roundtrip nötig, und es spiegelt genau wider, was die App weiß.
Die Ausgabe ist ein Datenwörterbuch, das oben Verbindung und Datenbank nennt, gegliedert in Tabellen, Ansichten, Prozeduren, Funktionen, und Andere Objekte. Jede Tabelle bekommt ein Spaltenraster samt Name, Typ, Nullbarkeit, Standardwert und Schlüssel-Anmerkungen (Primärschlüssel, Identität, FK → Ziel) – dazu seine Fremdschlüssel als Liste; Routinen erhalten ihre Parametersignaturen und Rückgabetypen. Sehr große Schemata werden automatisch in eine Indexdatei sowie eine Datei pro Schema aufgeteilt, sodass das Ergebnis in einem Repository oder Wiki weiterhin übersichtlich bleibt.


Ein Datenwörterbuch schreiben
- Verbinden und dem Schemamodell einen Moment Zeit zum Laden geben (es ist dasselbe Modell, das auch die Vervollständigungen unterstützt). Wenn es noch nicht geladen ist, zeigt SQLly dies in der Statusleiste an und unternimmt nichts.
- Klicke im Explorer mit der rechten Maustaste auf die Datenbank und wähle Schema › Schema dokumentieren (Markdown)..., oder führe Schema dokumentieren (Markdown)... aus dem Befehlspalette. Öffnest du es über den Explorer, wird diese Datenbank zuerst aktiv.
- Ein Speichern-Dialog öffnet sich mit
schema-docs.mdvorgeschlagen. Wähle Ordner und Namen. - Die Statusleiste bestätigt, wo es gespeichert wurde und wie viele Dateien geschrieben wurden, als das Schema aufgeteilt wurde.
Wie das Markdown aussieht
Objekte werden nach Abschnitt und dann nach Namen sortiert. Ein kleines Schema erzeugt so etwas:
# Data Dictionary — Shop / sales Generated by SQLLY from the loaded schema model. 2 objects. ## Tables ### dbo.Orders | Column | Type | Nullable | Default | Key | |---|---|---|---|---| | OrderId | int | no | | PK, identity | | CustomerId | int | no | | FK → dbo.Customers | | Total | decimal | yes | | | - Foreign key (CustomerId) → dbo.Customers (CustomerId) ## Procedures ### dbo.PlaceOrder | Parameter | Type | Mode | Default | |---|---|---|---| | @CustomerId | int | in | |
- Tabellen - eine Zeile pro Spalte. Nullbar ist
yes,no, oder?wenn das Modell es nicht weiß. Die Schlüssel Zelle kombiniertPK,FK → target, undidentity. - Ansichten - ein Spalten- / Typ-Raster, oder Spalten, die im Schema-Modell nicht erfasst sind wenn das Modell nur den Namen der Ansicht kennt.
- Prozeduren und Funktionen - ein Parameter / Typ / Modus / Standard-Raster (Modus ist
in,out, oderin/out), Keine Parameter. wenn keine vorhanden sind, und ein Rückgabe: Zeile für Funktionen. - Andere Objekte - Synonyme zeigen ihr Ziel; alles andere wird namentlich aufgelistet, und zwar mit Keine strukturellen Details erfasst.
Pipe-Zeichen in Werten werden maskiert und Zeilenumbrüche geglättet, sodass Standardwerte und Typen das Tabellenlayout nie beschädigen.
Große Schemata
Bis zu 2.000 Objekte gehen in die eine Datei, die du benannt hast. Darüber hinaus schreibt SQLly diese Datei als
Index Liste, die jedes Schema mit seiner Objektanzahl und einem Link auflistet, plus eine Datei pro Schema daneben, benannt nach deiner Datei: schema-docs.sales.md,
schema-docs.audit.md, und so weiter. Schemanamen werden dateinamensicher gemacht, und zwei Schemas, die kollidieren würden, bekommen ein numerisches Suffix, statt sich gegenseitig zu überschreiben. Nichts wird abgeschnitten.
Gut zu wissen
- Es funktioniert mit jeder Engine, zu der SQLly eine Verbindung herstellen kann, da es SQLlys eigenes Modell liest und keinen engine-spezifischen Katalog.
- Das Dokument ist nur so vollständig wie das geladene Modell. Wenn das Modell die Spalten eines Views nie aufgezeichnet hat, sagt das Dokument das, statt zu raten.
- Speichern schreibt die Datei direkt; vorhandene Dateien mit denselben Namen werden ersetzt.
- Das Speichern in einer Datei ist in der Browser-Vorschau nicht verfügbar; verwende die Desktop-App.