描述
功能的编辑表、视图和列的描述,并作为注释 DDL 写回服务器。
表、视图和列都可以带有 描述,即数据库本身随对象一起存储的注释。SQLly 在所有显示模式信息的地方都会读取这些描述(对象清单的 Comment 列、模式文档导出、AI 上下文),而且你可以在两个地方编写它们,无需手写引擎的注释语法。
编辑位置
- 编辑结构 - 一个 描述 表的描述字段位于列列表下方,每一列都有自己的描述框。对描述的编辑会出现在更改列表中,表现为 设置描述。在大多数引擎上,注释会在结构更改之后单独成句;注释属于列本身,因此重命名或改类型不需要额外语句。在 MySQL 和 MariaDB 上,更改一列就要重述其完整定义,被重命名、改类型、改默认值或新增的列会在同一条子句里带上自己的描述,因此注释得以保留(或新添),结构更改也不会被撤销。
- 对象属性 - 这里的 常规 表或视图的页面一经读取,就会在可编辑字段中显示其当前描述;更改描述会把该页标记为已修改; 审查更改 在任何操作执行之前就显示确切的语句。
清除文本即会移除描述。两个入口都遵循常规的审查规则:编辑结构会生成脚本放入编辑器选项卡,对象属性则只能通过其审查表单执行。
如果当前描述无法读取(例如权限问题),两个界面都会隐藏描述字段并显示原因。编辑绝不会针对猜测的值生成脚本,因为在 SQL Server 上,应使用哪个存储过程取决于描述是否已存在。
SQLly 会在每种引擎上运行什么
| 引擎 | 表/视图描述 | 列描述 |
|---|---|---|
| SQL Server / Azure SQL | 这 MS_Description 扩展属性: sp_addextendedproperty 当不存在时, sp_updateextendedproperty 已存在时(包括内容为空文本的情况), sp_dropextendedproperty 来清除。视图按视图来寻址。 | 列级别使用同样的存储过程。 |
| PostgreSQL | COMMENT ON TABLE / COMMENT ON VIEW … IS '…'; IS NULL 清除。 | COMMENT ON COLUMN … IS '…'. |
| CockroachDB | COMMENT ON TABLE … IS '…'。CockroachDB 没有 COMMENT ON VIEW,因此视图的描述字段会被隐藏,并注明原因。 | COMMENT ON COLUMN … IS '…'. |
| DuckDB | COMMENT ON TABLE / COMMENT ON VIEW; IS NULL 清除。 | COMMENT ON COLUMN. |
| Oracle 数据库 | COMMENT ON TABLE … IS '…' (Oracle 用 TABLE 关键字引用视图); IS '' 清除。 | COMMENT ON COLUMN. |
| MySQL / MariaDB | ALTER TABLE … COMMENT = '…'。视图无法存储描述(服务器将每个视图的注释报告为 VIEW),因此视图的字段会被隐藏,并注明原因。 | MySQL 没有仅更改注释的语句,因此 SQLly 执行 ALTER TABLE … MODIFY COLUMN。对于只改描述的更改,它会把该列原样重述为 SHOW CREATE TABLE 打印它并仅替换 COMMENT '…' 子句,同时保留其他所有内容,包括注释后面的子句,例如 MariaDB 的 CHECK (json_valid(…));如果无法读取该文本,SQLly 会拒绝更改而不是去猜。当同一次编辑还要重命名、改类型、改默认值或添加该列时, COMMENT 会放入该 CHANGE/MODIFY/ADD 子句中。 |
| ClickHouse | ALTER TABLE … MODIFY COMMENT '…'。视图创建后无法再添加注释;SQLly 会提示你重建视图来加上 COMMENT 子句。 | ALTER TABLE … COMMENT COLUMN … '…'. |
| SQLite / libSQL | 没有服务器端注释存储。描述字段会被隐藏,编辑器改为显示原因。 | |
文本会按引擎规则加引号:内嵌引号在所有引擎中都写成两个,SQL Server 的值以 Unicode 形式发送 N'…' 字面量,而 MySQL 和 ClickHouse 还会转义反斜杠。
在 MySQL 和 MariaDB 上,被“编辑结构”重命名、改类型或改默认值的列会按编辑器中的字段重建:类型、可空性、默认值、自增,以及它的 ON UPDATE (针对 timestamp 和 datetime 列),以及其描述。字符集或排序规则覆盖、生成的表达式, INVISIBLE,或列级 CHECK 不会被重述;如果当前定义里已有,脚本会在 -- WARNING 行里写明,方便你在运行前把它加进类型。

