MS SQLデータベースのドキュメントの作成

データベース開発者向けの小さなプロジェクトに注目します。 SQL Server Management Studioのレポート機能の研究として始まり、次のように終わりました。

データベースドキュメントレポート 、プロジェクトアドレス: http : //DbDocReports.CodePlex.com



Database Objects Report

これは、 拡張プロパティの説明を使用してデータベースドキュメントを作成するためのMS SQL Management StudioおよびMS SQL Reporting Servicesのレポートセットです。 レポートには、テーブル、ビュー、ストアドプロシージャなどのデータベースオブジェクトに関する詳細情報が含まれます。



SQL Server Management Studio 2005/2008およびSQL Server Reporting Services 2005/2008でサポートされています。 レポートエンジンを使用すると、受信したレポートをExcel、Word、PDF、およびその他の形式に簡単にエクスポートできます。



ユースケース: テーブル情報を含むレポートの例:

Table Details Report



機能説明



現在のバージョン( 0.9 Beta )には、次のレポートと機能が含まれています。

  1. データベースオブジェクトレポート - データベースオブジェクトに関する一般情報(その番号と説明付きのリスト)。 レポートでこれらのオブジェクトのいずれかを選択すると、対応するレポートが開き、オブジェクトに関する詳細情報が表示されます。

  2. テーブル詳細レポート -テーブルに関する詳細情報:
    • テーブルの説明。
    • 列の名前、タイプ、長さ、および属性はヌル可能です。
    • テーブル制約の説明。
    • テーブルインデックスの説明。
    • 外部キーによってこのテーブルを参照するテーブルのリスト
  3. 詳細レポートの表示 - 詳細の表示
    • ビューの説明。
    • 列の名前、そのタイプ、長さ。
    • プレゼンテーションテキスト。
  4. ストアドプロシージャの詳細レポート - ストアドプロシージャに関する詳細情報:
    • ストアドプロシージャの説明。
    • パラメーターの名前、そのタイプおよび長さ。
    • ストアドプロシージャのテキスト。


設置



レポートは* .rdlファイルです。 それらをSQL Management Studioに接続するには、[レポート] / [カスタムレポート]メニュー(SQL 2005 SP2 / SQL 2008)を使用します。 Reporting Servicesの場合、これらのファイルをサーバーにアップロードしてデータソースに接続するか、レポートビューアー(2005/2008)を使用できます。

すべてのインストール手順の詳細は、 ロシア語 / 英語の説明に記載されています。



データベースオブジェクトの文書化を容易にするSQLプロシージャ



さらに、TSQLからデータベースオブジェクトを文書化するための「MS_Description」プロパティと便利な操作の手順を共有したいと思います。 SQLスクリプトsp_addDescXXX_install.sqlをダウンロードします。



現在の実装では、次のオブジェクトを操作するためのストアドプロシージャが作成されています。 これは、かさばる構造の使用を容易にするために行われました: sp_addextendedproperty / sp_updateextendedproperty



sp_addextendedproperty/sp_updateextendedproperty



つまり sp_XXXextendedpropertyの代わりに、次を使用できます。



sp_addDesc_table_col



計画

  1. 文書化されたオブジェクト(スキーム、トリガー)のリストを拡張します。
  2. バグ修正。
  3. 願いと提案。



All Articles