ドキュメントスキーマ

実装済み

データベースのスキーマのMarkdownドキュメントを生成し、リポジトリやwikiの準備ができます。

生成 Markdown データベースのスキーマのドキュメントを1ステップで作成します: アクションを選び、保存先を選ぶだけです。意図的に設定項目はありません。ドキュメントは、SQLlyがIntelliSense用にすでに読み込んでいるスキーマモデルから作成されるため、サーバーへの追加の往復は不要で、アプリが把握している内容がそのまま反映されます。

出力は、接続とデータベースを見出しに持つデータ ディクショナリで、次のセクションに分かれます: テーブル, ビュー, プロシージャ, 関数、そして その他のオブジェクト。各テーブルには列グリッドが付き、名前、型、NULL 許容、既定値、キー注釈(主キー、IDENTITY、 FK → ターゲット) - 外部キーもリストとして含みます。ルーチンにはパラメーターシグネチャと戻り値の型が含まれます。非常に大きなスキーマは、インデックスファイルとスキーマごとのファイルに自動的に分割されるため、リポジトリや Wiki でも結果を辿りやすくなります。

SQLly
SQLly のドキュメントスキーマ (Markdown) 出力SQLly のドキュメントスキーマ (Markdown) 出力
ドキュメントスキーマ: そのまま保存できる Markdown ドキュメントとして整形されたデータベースの構造。

データディクショナリを書く

  1. 接続し、スキーマモデルが読み込まれるまでしばらく待ちます(補完を支えているのと同じモデルです)。まだ読み込まれていない場合、SQLly はステータスバーにその旨を表示し、何もしません。
  2. エクスプローラーでデータベースを右クリックし、次を選択します スキーマ › スキーマをドキュメント化 (Markdown)…、または次を実行 ドキュメントスキーマ(マークダウン)... 次から コマンドパレット。エクスプローラーから開くと、そのデータベースが最初にアクティブになります。
  3. 保存ダイアログが開きます schema-docs.md 提案されます。フォルダーと名前を選んでください。
  4. ステータスバーには、保存先と、スキーマを分割した場合に書き込まれたファイル数が表示されます。

Markdown の見た目

オブジェクトは、まずセクション順に、その次に名前順に並びます。小さなスキーマでは、たとえば次のようになります:

# 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 |  |
  • テーブル - 列ごとに 1 行。 NULL 許容 です yes, no、または ? モデルがわからない場合。 キー セルは次を組み合わせます PK, FK → target、そして identity.
  • ビュー - 列/型のグリッド、または スキーマモデルに記録されていない列 モデルがビューの名前しか知らない場合。
  • プロシージャと関数 - パラメータ/型/モード/デフォルトのグリッド(モードは in, out、または in/out), パラメータなし。 ない場合、そして 戻り値: 関数用の行。
  • その他のオブジェクト - シノニムはその参照先を表示します。それ以外は名前で一覧表示され、次の情報が付きます 構造の詳細は記録されていません。

値に含まれるパイプ文字はエスケープされ、改行は 1 行にまとめられるため、既定値や型がテーブルのレイアウトを崩すことはありません。

大規模なスキーマ

最大 2,000 個のオブジェクトは、指定した 1 つのファイルに書き出されます。それを超えると、SQLly はそのファイルを インデックス 各スキーマをオブジェクト数とリンク付きで一覧にし、その隣にファイル名に合わせたスキーマごとのファイルを 1 つずつ置きます: schema-docs.sales.md, schema-docs.audit.md、など。スキーマ名はファイル名として安全な形になり、名前が衝突する 2 つのスキーマには、互いを上書きする代わりに数字の接尾辞が付きます。何も切り詰められません。

知っておくべきこと

  • SQLly が接続するすべてのエンジンで動作します。エンジン固有のカタログではなく、SQLly 独自のモデルを読み取るためです。
  • ドキュメントの完全さは、読み込まれたモデル次第です。モデルがビューの列を記録していなければ、ドキュメントは推測ではなく、その旨をはっきり示します。
  • 保存ではファイルに直接書き込まれ、同じ名前の既存のファイルは置き換えられます。
  • ブラウザープレビューではファイルに保存できません。デスクトップアプリを使用してください。