Jeder Entwickler arbeitet gerne an einem Code, der ausführlich dokumentiert ist. Die Dokumentation ist sinnvoll und bietet angemessene Einblicke und Informationen, um die Funktionalität des Codes zu verstehen. Die meisten Programmiersprachen bieten spezielle Tools zum Generieren von Dokumentation. Das JavaDoc-Tool wird beispielsweise zum Generieren der API-Dokumentation im HTML-Format aus verfügbaren Dokumentkommentaren in Java-Programmen verwendet. Leider enthält Microsoft SQL Server keine Methode zum Generieren der Tabellenschemadokumentation. Wir müssen Tools von Drittanbietern verwenden, um das Tabellenschema in SQL Server zu dokumentieren.
DB> doc für Microsoft SQL Server ist ein Tool, das zur Generierung von Tabellenschemadokumentationen angepasst ist. Dieses Tool verwendet die Systemtabellen von SQL Server, in denen Informationen zu Tabellenstrukturen, Ansichten und Einschränkungen zum Generieren der Schemadokumentation gespeichert werden. Die mit DB> doc erstellte Dokumentation enthält eine Liste von Tabellen, die nach verschiedenen Schemanamen klassifiziert sind, sodass sie als Referenz verwendet werden kann. Es verwendet die erweiterten Eigenschaften des SQL-Servers, mit denen Entwickler Datenbankobjekte dokumentieren.
DB> doc für Microsoft SQL Server generiert Dokumentation in zahlreichen Formaten, einschließlich HTML, WikiPlex und XML. Das am meisten bevorzugte Dokumentformat ist HTML. Es generiert ein einseitiges HTML-Dokument mit einer Liste von Tabellen, sortiert nach ihrem Schemanamen, und stellt außerdem Hyperlinks zu Fremdschlüsseln bereit, um die Beziehungen zwischen zwei Tabellen zu identifizieren.
Ich habe das DB> doc-Tool mit den Editionen von Microsoft SQL Server 2008, 2008 R2, 2012 und 2014 getestet. Es ist ein Windows-Befehlszeilenanwendung. Sie müssen das Exe-Dateiformat von der CodePlex-Seite von DB> doc project herunterladen. Der direkte Link zum Herunterladen des Tools lautet DB> doc für Microsoft SQL Server.
Verwenden Sie DB> doc für Microsoft SQL Server, um HTML-Dokumentation für das Tabellenschema zu generieren
1. Navigieren Sie zu dem Ordner, in den Sie das heruntergeladen haben "Sqldbdoc.exe" Anwendungsdatei.
2. Gehen Sie zur Adressleiste und geben Sie ein "Cmd" um den aktuellen Pfad im Befehlsexplorer zu öffnen.
3. Typ "Sqldbdoc.exe /?" um alle zulässigen Parameter zu sehen.
Wichtige Parameterinformationen
1. Verbindung - Verbindungszeichenfolge, Datenbankserver-IP-Adresse, Instanzname, Benutzername, Kennwort und Datenbankname
2. Dateiname - Name der Ausgabedatei
3. [/ y] - Diese Option wird verwendet, um den vorhandenen generierten Dateinamen zu überschreiben.
HTML-Dokument erstellen
Sie können dem Beispiel unten folgen, um ein HTML-Dokument zu erstellen.
Für die Windows-Authentifizierung
sqldbdoc "SERVER = ANDRO100 \ SQLSERVER2014; TRUSTED_CONNECTION = yes; DATABASE = AdventureWorks2014" Dateiname = AdventuresWork2014Doc.htm / y
Für die SQL Server-Authentifizierung mit Benutzer-ID und Kennwort
sqldbdoc "SERVER = ANDRO100 \ SQLSERVER2014; TRUSTED_CONNECTION = yes; DATABASE = AdventureWorks2014 Benutzer-ID = sa; [email protected];" Dateiname = AdventuresWork2014Doc.htm / y
Sie können HTML-generierte Dokumente in den folgenden Formaten anzeigen.
Dieses Lernprogramm soll Ihnen beim Erstellen und Verwalten der Tabellenschemadokumentation für Microsoft SQL Server helfen. Weitere Informationen finden Sie in den Lernprogrammen zu Tech-Recipes-SQL Server-Archiven.