架构文档

功能的

生成数据库模式的 Markdown 文档,可直接放进仓库或维基。

生成 Markdown 一步生成数据库模式的文档:选择操作,选好保存位置,完成。我们刻意不提供任何配置项——文档直接从 SQLly 为 IntelliSense 加载的 schema 模型构建,因此不需要额外的服务器往返,内容也和应用所知的完全一致。

输出是一份数据字典,开头标明连接和数据库,分成 表, 视图, 存储过程, 函数,以及 其他对象。每个表都有一个列网格,含名称、类型、可空性、默认值和键标注(主键、标识、 外键 → 目标)——外加其外键列表;例程会带上参数签名和返回类型。特别大的模式会自动拆分为一个索引文件外加每个模式一个文件,这样在代码仓库或维基中结果仍然便于浏览。

SQLly
SQLly 架构文档(Markdown)输出SQLly 架构文档(Markdown)输出
架构文档:将数据库结构渲染为可直接保存的 Markdown 文档。

编写数据字典

  1. 请先连接,给模式模型一点加载时间(它正是为自动补全提供支持的同一个模型)。如果还没加载好,SQLly 会在状态栏说明,并且不会执行任何操作。
  2. 在资源管理器中右键单击数据库并选择 模式 › 生成模式文档 (Markdown)...,或者运行 架构文档(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 |  |
  • 表 - 每列一行。 可空 是 yes, no,或 ? 当模型不知道时。 键 单元格结合了 PK, FK → target,以及 identity.
  • 视图 - 一个列/类型网格,或者 未记录在模式模型中的列 当模型只知道视图的名称时。
  • 过程与函数 - 一个参数/类型/模式/默认值网格(模式是 in, out,或 in/out), 没有参数。 在没有参数时显示,而函数会有一行 返回: 函数则各占一行。
  • 其他对象 - 同义词会显示其目标;其余对象仅按名称列出,并附上 未记录结构详情。

值里的管道字符会被转义,换行会被展平,默认值和类型绝不会破坏表格布局。

大型模式

最多 2,000 个对象会写入你指定的单个文件。超过后,SQLly 会将该文件写成一个 索引 一个清单,列出每个模式及其对象数量和链接,旁边每个模式各有一个文件,以你的文件命名: schema-docs.sales.md, schema-docs.audit.md,以此类推。架构名称会被处理成对文件名安全的形式,两个会冲突的架构会加上数字后缀,而不是互相覆盖。任何内容都不会被截断。

需要了解的事项

  • 它适用于 SQLly 连接的每个引擎,因为它读取的是 SQLly 自身的模型,而不是特定引擎的目录。
  • 文档的完整性取决于加载的模型。如果模型从未记录某个视图的列,文档会说明这一点,而不会进行猜测。
  • 保存会直接写入文件;具有相同名称的现有文件将被替换。
  • 在浏览器预览中无法保存到文件;请使用桌面应用程序。