codebuddy可基于sql文件或mysql直连自动生成带中文注释的数据库结构表文档，支持markdown/excel导出、字段排序筛选及类型映射定制。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜
你需要快速生成符合项目规范的数据库结构表文档，而不是手动敲写字段说明、类型和约束条件。CodeBuddy能基于SQL建表语句或数据库连接自动生成带中文注释、字段说明、索引信息的结构表文档，省去反复复制粘贴和格式整理的时间。
从本地SQL文件生成结构表
第一步：打开CodeBuddy主界面，点击左侧菜单栏【文档生成】→【数据库结构表】。
第二步：在“数据源类型”下拉框中选择【SQL文件】，然后点击【选择文件】按钮，定位并上传你已写好的建表SQL文件（支持.sql或.txt格式，文件内需含CREATE TABLE语句）。
第三步：勾选【自动解析中文注释】——如果你的SQL里用了COMMENT '用户昵称'这类写法，这一步必须开启，否则字段说明会为空。【未勾选会导致所有字段描述栏显示“无”】
第四步：点击【生成】按钮，等待几秒后右侧预览区将显示带表名、字段名、类型、是否为空、默认值、注释、键类型（PK/UK/FK）的完整表格。确认无误后，点击右上角【导出为Markdown】或【复制为Excel格式】即可使用。
直连MySQL生成结构表
方法一：使用JDBC连接实时库
在【数据源类型】中选择【MySQL数据库】，依次填写主机地址、端口（默认3306）、数据库名、用户名、密码。测试连接成功后，系统自动列出该库下所有表。
CodeBuddy Code CLI 的安装、配置与使用指南。CodeBuddy Code 是腾讯推出的 AI 驱动 CLI 编程助手，支持自然语言驱动开发。 - 必备触发词：CodeBuddy, codebuddy, AI CLI, Tencent AI coding, @tencent-ai/codebuddy-code, terminal AI assistant - 适用场景：安装 CodeBuddy CLI、配置 CodeBuddy、使用 CodeBuddy 命令、排查 CodeBuddy 问题
勾选需要生成结构表的目标表（可多选），注意【不要勾选系统表如information_schema.*或mysql.*开头的表】，否则可能触发权限错误或生成大量无效内容。
点击【生成】，CodeBuddy会执行SHOW CREATE TABLE语句提取DDL，并结合DESCRIBE和SELECT COLUMN_COMMENT查询字段注释，最终合成结构表文档。
方法二：导入Navicat或DBeaver导出的结构快照
先在Navicat中右键数据库→【转储SQL文件】→【仅结构】，保存为snapshot.sql；或在DBeaver中右键表→【生成SQL】→【DDL】，合并为单个文件。再回到CodeBuddy，切换到【SQL文件】模式上传该快照文件即可。这招适合无法开放数据库外网访问但又需要离线生成的场景。
调整字段显示顺序与筛选条件
生成预览后，若发现字段顺序混乱（如主键没排第一、时间戳字段散落在中间），点击表格上方的【排序设置】按钮：
- 选择【按字段位置排序】保持原始建表顺序；
- 或选择【主键优先→非空字段→普通字段】，让关键字段集中靠前；
- 输入关键词（如“create”“update”）可临时隐藏不含该词的字段行，方便聚焦审计字段。
修改后无需重新生成，实时生效。导出前可再次检查字段类型缩写是否统一（例如把TINYINT(1)自动映射为BOOLEAN，INT(11)简化为INT），该映射规则在【设置】→【类型映射】中可自定义。
