Skip to content

Repository files navigation

Database Column Comments

在 IntelliJ IDEA Ultimate(含 Database Tools)的数据库表数据和 SQL Result Grid 表头中,直接显示字段类型和字段注释。

┌───────────────────┐
│ user_id       ▾ ⏷ │
│ bigint(64)         │
│ 用户ID             │
└───────────────────┘

实现方式

插件不会替换 IDEA 的 JTableHeader,也不会用自定义组件替换原表头 renderer 的返回对象:

  1. 从 IDEA 已加载的 DataGrid 元数据中解析 GridColumn → DasColumn → 数据类型/注释,不执行额外 SQL。
  2. 委托原 renderer,仅增加一个底部 inset,为字段类型和注释预留空间。
  3. contains(x, y) = false 的透明绘制层直接添加到原 JTableHeader
  4. 绘制阶段只读取不可变的字段类型和注释快照,不访问数据库元数据。
  5. 插件禁用、结果页关闭或表头被替换时,恢复原 renderer 并移除所有监听器。

因此排序、筛选、右键菜单、列拖动、列缩放和横向滚动仍由 IDEA 原组件处理。

支持与验证范围

插件安装声明为:

  • since-build=251(IntelliJ IDEA 2025.1)
  • 不设置 until-build,允许安装到 2025.1 及后续版本
  • 普通关系型数据库 Result Grid
  • 非转置、非层级表头

项目使用最低支持版本 IntelliJ IDEA Ultimate 2025.1 作为编译和自动化测试基线,避免引用较新版本才存在的 API。Plugin Verifier 矩阵覆盖各个已发布分支的当前最新补丁版:2025.1.7.2、2025.2.6.3、2025.3.6.1、2026.1.5 和 2026.2.1。

开放 until-build 表示后续版本可尝试安装,不等于尚未发布的 IDE 已完成验证。JetBrains 发布新分支后仍应运行 Plugin Verifier,并在真实 Result Grid 中完成一次 smoke test。

下列场景会安全跳过或留空字段类型和注释:

  • 转置视图
  • Mongo/JSON 层级表头
  • CSV 等没有数据库字段元数据的表格
  • COUNT(*)CASE 等没有真实来源字段的表达式
  • JOIN/别名无法由 JDBC 元数据确定来源的列

插件不会根据字段名猜测注释,避免同名库表显示错误信息。

安装

在 IDEA 中打开 Settings | Plugins,点击齿轮按钮并选择 Install Plugin from Disk...,然后选择构建生成的 ZIP;IDEA 提示时重启。

构建

需要 JDK 21。项目预置 IDEA 2025.1 至当前最新版本的验证矩阵;DataGrip 需要在真实版本完成独立验证后再声明支持:

.\gradlew.bat clean test buildPlugin verifyPluginProjectConfiguration verifyPluginStructure verifyPlugin

本机开发时可以复用已经安装或解压的 IDEA,避免重复下载平台包:

.\gradlew.bat test buildPlugin `
  -PlocalIdePath=C:\path\to\IntelliJ-IDEA

安装包输出到:

build/distributions/database-column-comments-1.1.0.zip

设置

打开 Settings | Tools | Database Column Comments,可以:

  • 启用或停用字段类型和字段注释;
  • 设置单个注释最多显示的字符数;
  • 设置单个注释最多显示的行数,范围为 1–100,默认 2 行;
  • 设置字段类型和注释共用的字体;可选择“跟随 IDE”或本机字体;
  • 设置字段类型和注释共用的字号;0 表示跟随 IDE;
  • 设置字段类型和注释共用的文字颜色;可选择跟随系统或自定义颜色。

字段类型固定显示为一行;注释会按当前列宽自动换行。超过设置的最大行数时,最后一行以 截断。调整列宽后,插件会重新计算表头高度。

设置保存后会刷新已打开的结果表头。完整注释仍可通过 IDEA 原有的表头悬浮提示查看。

About

在 IntelliJ IDEA Ultimate(含 Database Tools)的数据库表数据和 SQL Result Grid 表头中,直接显示字段类型和字段注释。

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages