Der Prozess der Dokumentation einer SQL Server-Datenbank ist ein vollständiger und kontinuierlicher Prozess, der während der Datenbankdesign- und -entwicklungsphase beginnen und während aller datenbankbezogenen Lebenszyklen so fortgesetzt werden sollte, dass sichergestellt ist, dass eine aktuelle Version der Datenbankdokumentation vorhanden ist spiegelt die Realität zu jedem Zeitpunkt wider. Bei richtiger Ausführung enthält die generierte Datenbankdokumentationsdatei eine aktuelle und vollständige Liste der Datenbankobjekte und eine kurze Beschreibung dieser Datenbankobjekte.
Der Dokumentationsprozess der SQL Server-Datenbank kann auf verschiedene Arten durchgeführt werden. Sie können einfach ein Datenbankdiagramm erstellen, das eine Liste aller Datenbanktabellen und -spalten anzeigt und dieses Diagramm aktualisiert, wenn Änderungen vorgenommen werden. Aber das Lesen und Verwalten eines solchen Diagramms ist kein einfacher Prozess für große Datenbanken mit Dutzenden von Datenbanktabellen, wobei jede Tabelle Dutzende von Spalten enthält.
Beginnend mit SQL Server 2005 hat Microsoft ein neues Feature namens Extended Properties eingeführt, das in der Datenbank selbst gespeichert ist und auf das über das Systemobjekt sys.extended_properties zugegriffen wird, und Metadateninformationen zurückgibt, die der angegebenen Datenbank oder den angegebenen Datenbankobjekten zugeordnet sind. Das Dokumentieren der SQL Server-Datenbank mithilfe der erweiterten Eigenschaften ist nicht die beste Wahl, da Sie jeweils nur eine Datenbank dokumentieren können, keine historischen Daten, da die Eigenschaften der Datenbankobjekte gelöscht werden, wenn dieses Objekt gelöscht wird, es ist kein Kinderspiel da es gute Entwicklungsfähigkeiten erfordert, große Anstrengungen erfordert und viel Zeit in Anspruch nimmt.
Mit Visual Studio
Entwickler, die mit Microsoft Visual Studio vertraut sind, können die Vorteile des SQL Server-Projekttyps problemlos nutzen, um eine Verbindung zu einer SQL Server-Datenbank herzustellen und die Metadaten zu den Datenbankobjekten zu überprüfen.
Öffnen Sie dazu das Visual Studio-Tool und erstellen Sie ein neues SQL Server-Datenbankprojekt im Fenster „Neues Projekt“ wie folgt:
Geben Sie im Fenster „Neues Projekt“ einen eindeutigen Namen für dieses Projekt ein, wo dieses Projekt gespeichert werden soll, und klicken Sie dann auf „OK“, um das SQL Server-Datenbankprojekt zu erstellen. Wenn das Projekt erstellt ist, klicken Sie auf die Projekteigenschaften und konfigurieren Sie den Zielplattformwert mit der SQL Server-Version der Zieldatenbank, wie unten gezeigt:
Um eine Verbindung zu einer bestimmten Datenbank herzustellen, klicken Sie mit der rechten Maustaste auf das erstellte Projekt und wählen Sie die Option Importieren -> Datenbank wie folgt:
Wählen Sie im Fenster „Datenbank importieren“ eine Verbindung aus der zuvor gespeicherten Verbindungsliste aus oder geben Sie wie folgt den Servernamen, die authentifizierten Anmeldeinformationen und den Datenbanknamen an, um eine Verbindung mit der zu dokumentierenden Datenbank herzustellen:
Wenn Sie über die Schaltfläche „Verbinden“ eine Verbindung herstellen, beginnt das Tool mit dem Sammeln von Metadateninformationen zu allen Datenbankobjekten, wie unten gezeigt:
Nach dem Sammeln und Importieren aller Datenbankinformationen werden die ausgewählten Datenbankobjekte im Lösungsexplorer angezeigt, kategorisiert nach Schema, wie folgt:
Um Metadateninformationen zu einem beliebigen Datenbankobjekt anzuzeigen, erweitern Sie das Schema aus dem Lösungs-Explorer und klicken Sie auf dieses Objekt. Ein neues Fenster wird geöffnet, das die gesamte Beschreibung für das ausgewählte Objekt mit dem T-SQL-Skript zum Erstellen dieses spezifischen Objekts anzeigt, wie unten gezeigt:
Es bietet Ihnen auch die Möglichkeit, die Beschreibungsspalte für jedes Datenbankobjekt anzuzeigen, indem Sie mit der rechten Maustaste auf den freien Bereich neben der ausgewählten Tabelle klicken und die Option Beschreibung auswählen. Es wird eine neue Spalte mit einer Beschreibung für jede Spalte angezeigt, mit der Möglichkeit, die Beschreibung zu bearbeiten, wie unten gezeigt:
Obwohl es zu einfach ist, Ihre Datenbank mit Visual Studio zu dokumentieren, bietet es keinen zentralen Ort zum Überprüfen mehrerer Datenbankobjekte, liefert Informationen zu einzelnen Datenbanken pro Projekt und kann nicht in ein benutzerfreundliches oder druckbares Format exportiert werden!
DbForge Documenter für SQL Server verwenden
Um Ihre Zeit und Mühe zu sparen und Ihre Datenbankdokumentation auf dem neuesten Stand zu halten, ist es besser, ein Tool eines Drittanbieters zu verwenden, das den Dokumentationsprozess vereinfacht. dbForge Documenter for SQL Server ist ein Datenbankdokumentationstool, das einfach mit Ihrer Datenbank verbunden werden kann und mit wenigen Klicks eine Dokumentation aller SQL Server-Datenbankobjekte erstellt.
dbForge Documenter for SQL Server bietet uns eine große Auswahl an Stilvorlagen und Optionen, die dabei helfen, die generierte Dokumentation an Ihre eigenen Anforderungen anzupassen. In wenigen Sekunden der Konfiguration extrahiert dbForge Documenter for SQL Server alle Informationen und umfangreichen Details über die ausgewählte Datenbank sowie Abhängigkeiten zwischen Objekten und DDL T-SQL-Skripte, um diese Objekte zu erstellen, mit der Möglichkeit, die Dokumentation in durchsuchbares HTML zu exportieren , PDF und Markdown-Dateiformate. Das HTML-Format hilft bei der Veröffentlichung der Datenbank im Web, und das PDF-Format eignet sich zur Verteilung an andere Systeme und zur gemeinsamen Nutzung mit anderen Geräten. Auf dbForge Documenter for SQL Server kann auch zugegriffen werden, um die Datenbank direkt über das SQL Server Management Studio zu dokumentieren, da es in SSMS integriert ist.
dbForge Documenter for SQL Server kann vom Devart Download Center heruntergeladen und auf Ihrem Server installiert werden, indem Sie den unkomplizierten Installationsassistenten wie folgt durchlaufen:
Wenn Sie auf die Schaltfläche Installieren klicken, um den Installationsvorgang zu starten, werden Sie aufgefordert, den Installationspfad für das Tool anzugeben. Wenn Sie es schaffen, ein Desktop-Symbol für das Tool zu erstellen, können die Versionen von SQL Server Management Studio schneller darauf zugreifen dieses Tool als Add-In installiert haben, die Dateierweiterungen, die mit dem Tool dbForge Documenter for SQL Server verknüpft werden, und schließlich werden Sie aufgefordert, den Startoptimierungsmodus für das Tool anzugeben. Danach beginnt der Installationsprozess mit einem nützlichen Fortschrittsbalken, der anzeigt, was gerade installiert wird, wie unten gezeigt:
Wenn der Installationsvorgang erfolgreich abgeschlossen wurde, benachrichtigt Sie der Assistent und bietet Ihnen die Möglichkeit, das Tool wie folgt direkt zu starten:
Die erste Ansicht von dbForge Documenter for SQL Server ähnelt dem Fenster unten. Um mit dbForge Documenter for SQL Server eine Dokumentation für Ihre Datenbank zu erstellen, klicken Sie wie folgt auf das Fenster „Neue Dokumentation“ auf der Willkommensseite:
Klicken Sie im geöffneten Dokumentationsfenster auf Verbindung hinzufügen, um eine vorhandene Verbindung auszuwählen oder eine neue Verbindung hinzuzufügen, indem Sie den Namen des Servers, gültige Anmeldeinformationen und den Namen der Datenbank angeben, zu der eine Verbindung hergestellt werden soll, indem Sie die benutzerfreundliche Seite unten verwenden:
Nach erfolgreicher Verbindung zur Datenbank listet dbForge Documenter for SQL Server alle Datenbanken und Datenbankobjekte unter der verbundenen SQL Server-Instanz auf. Am Anfang bietet es Ihnen die Möglichkeit, einen eindeutigen Namen und eine Beschreibung für die zu generierende Dokumentation bereitzustellen, zusätzlich zu Ihrem eigenen Logo, Namen und Datum, das in dieser Dokumentation angezeigt werden soll, wie unten gezeigt:
Um eine bestimmte Datenbank oder Datenbankobjekte zu dokumentieren, überprüfen Sie den Namen der Datenbank in der Datenbankliste, überprüfen und optimieren Sie die verschiedenen Datenbankeigenschaften und -optionen, die in die Dokumentation aufgenommen werden sollen, aktivieren oder deaktivieren Sie jedoch die Schaltfläche "Einschließen" neben jeder Eigenschaft und Option. wie unten gezeigt:
Nachdem Sie angepasst haben, was in Ihre Dokumentation aufgenommen werden soll, klicken Sie auf die Option „Generieren“, um eine Datenbankdokumentation basierend auf Ihrer Auswahl wie folgt zu generieren:
Geben Sie im Fenster Dokumentation generieren das Format der generierten Dokumentation sowie den Pfad und die Eigenschaften des generierten Dateinamens an, wie unten gezeigt:
Wenn Sie auf die Schaltfläche Generieren klicken, beginnt der Dokumentationsgenerierungsprozess mit einer benutzerfreundlichen Checkliste und einem Fortschrittsbalken, um den aktuellen Status des Generierungsprozesses anzuzeigen, wie unten gezeigt:
Wenn der Prozess der Dokumentationserstellung erfolgreich abgeschlossen wurde, benachrichtigt Sie dbForge Documenter for SQL Server mit dem Endergebnis wie folgt:
Wenn Sie zu dem Pfad navigieren, in dem die Datei gespeichert ist, werden Sie sehen, dass die Datenbankdokumentation unter diesem Pfad im PDF-Format generiert wird, wie unten gezeigt:
Der Bericht wird auch im Tool dbForge Documenter für SQL Server geöffnet und zeigt eine Beschreibung für die Datenbank, eine Liste aller Datenbankobjekte und -dateien sowie die Eigenschaften und Optionen für die ausgewählte Datenbank, wie unten gezeigt:
dbForge Documenter for SQL Server bietet Ihnen auch die Möglichkeit, tief in jedes Datenbankobjekt einzutauchen. Klicken Sie beispielsweise auf den Hyperlink Tabellen, wählen Sie die Tabelle aus, die Sie interessiert, und die vollständigen Informationen über die ausgewählte Tabelle werden im Bericht angezeigt, wie unten gezeigt:
Aus dem folgenden Beispiel geht hervor, wie wir das Drittanbieter-Tool dbForge Documenter for SQL Server mit wenigen Klicks verwenden können, um eine anpassbare Dokumentation für Ihre Datenbanken zu erstellen, die für mehrere Zwecke verwendet werden kann. Versuchen Sie, Ihre Datenbank mit dbForge Documenter for SQL Server zu dokumentieren!
