ExPEditor - Editor for SQL Server Extended Properties

Mit dem Artikel möchte ich auch was zum Thema „Datenbankdokumentation“ beitragen, und zwar ein Tool ExPEditor vorstellen.

Zu einer Datenbankdokumentation gehören auf jeden Fall ein ER-Diagramm und eine technische und fachliche Beschreibung von Datenbankobjekten (Tabellen, Spalten, usw.). Die beiden Arten von der DB-Dokumentation kann man generieren lassen und es sind bereits ein oder anderes der kostenpflichtigen Tools, die es ermöglichen, bekannt.
SQL Server z.B. bietet Extended Properties zum Speichern der „fachlichen“ Beschreibung von Datenbankobjekten an. Es ist möglich, mehrere Extended Properties zu einem Datenbankobjekt hinzuzufügen. Die Extended Properties kann man direkt im SQL Server Management Studio editieren, es sind dafür leider mehrere Mouse-Klicks notwendig, bis man eine Eigenschaft editieren kann.

ExPEditor

Um die Arbeit mit Extended Properties zu vereinfachen und bequemer zu machen, habe ich die Entwicklung von dem ExPEditor gestartet und möchte heute eine Alpha-Version vorstellen.
Es sind folgende Features geplant

• Navigation durch alle Datenbanken einer SQL Server Instanz
• Bearbeitung von Extended Properties
• Generieren von Beschreibung des Datenbankschemas im Word-Format
• Generieren von DDL-Skripten zum Hinzufügen und Aktualiseren von Extended Properties
• Anzeige von Definitionen der Datenbankobjekten

Implementierungsstand

Der ExPEditor ermöglicht ein bequemeren Zugriff auf die Extended Properties als das SQL Server Management Studio es anbietet
In der Alpha-Version kann man vorhandene Extended Properties und das Property Description, das automatisch durch ExPEditor zu jedem Objekt hinzugefügt wird und den Hauptteil der fachlichen Dokumentation darstellt, bearbeiten. In einer der nächsten Versionen wird es möglich sein, mehrere freibenannten EP’s zu einem Datenbankobjekt hinzuzufügen.
Das Generieren der Datenbankbeschreibung im Word-Format ist implementiert. Es gibt die Möglichkeit den Inhalt des Dokumentes nur für ausgewählte Datenbankobjekttypen generieren zu lassen.
Es kann ein DDL Skript generiert werden um alle Extended Properties einer Datenbank zu einer anderen Instanz zu übertragen.
Außerdem zeigt das Tool die DDL-Definition/T-SQL von Views, SP’s, Funktionen und Trigger an, was eine Datenbankentwicklung beschleunigen könnte und einem neuen Kollegen einen schnelleren Einstieg in die Entwicklung ermöglicht.

User Interface

Abbildung 1: Hauptfenster mit einem Objekt Explorer und einer tabellarischen Sicht, in der die Extended Properties des ausgewählen Objektes editiert werden können

 Abbildung 2: Ein zusätzliches Dialog zum Editieren von Extended Properties, ermöglicht bequemere Erfassen von mehrzeiligen Beschreibung

Abbildung 3: Dialog zum Auswahl von Datenbankobjekttypen, für die die Datenbankdokumentation im Word-Format generiert wird. Man kann im Dialog den Pfad zum Speichern des generierten Dokuments auswählen. Wenn die Checkbox "Save and Open" markiert ist, wird das generierte Dokument im Word automatisch geöffnet.

Abbildung 4: Definition einer gespeicherten Prozedur

Technischen Voraussetzungen

Für Verwendung des ExPEditor's müssen Microsoft Word ab 2007 und .Net Framework 4.0 auf dem Rechner installiert sein.

Anmerkung

Der ExPEditor wird kostenfrei zur Verfügung gestellt und von mir weiterentwickelt. Ich freue mich auf jede Rückmeldung, die man an die E-Mail im About-Dialog des ExPEditor's senden kann.

Download