如何将表结构导出为数据字典_结合PDF/HTML生成文档

轻雪酱_8741

轻雪酱_8741

2026-03-29

922人浏览

原创

导出数据字典应优先使用pg_dump -s或mysqldump -d获取纯净ddl,再用sqlparse解析生成结构化字段列表,手动拼html并显式控制列宽与中文字体,注释需strip归一化处理。

用 pg_dump 或 mysqldump 提取表结构,别碰数据

导出数据字典的第一步不是写脚本,而是让数据库自己吐出干净的 ddl。直接连库查 information_schema 容易漏约束、默认值、注释,还可能因权限或版本差异翻车。

实操建议:

  • pg_dump -s -U user db_name > schema.sql(PostgreSQL,-s 表示只导结构)
  • mysqldump -d -u user -p db_name > schema.sql(MySQL,-d 等价于 --no-data)
  • 加 --skip-comments 避免导出时混入连接信息或时间戳注释
  • 如果要保留字段注释,PostgreSQL 需额外执行 pg_dump --schema-only --inserts --column-inserts 不行,得用 pg_dump -s -E utf8 --no-owner --no-privileges 再配合 COMMENT ON COLUMN 手动补——这点常被忽略

用 sqlparse 解析 SQL 生成结构化字段列表

原始 schema.sql 是给人看的,机器难读。硬正则匹配 CREATE TABLE 和括号内容极不可靠,尤其遇到嵌套括号、多行注释、反引号包裹名时必崩。

实操建议:

  • Python 用 sqlparse 库解析:它能正确识别语句边界和 token 类型,比手写正则稳得多
  • 重点提取 IdentifierList(字段名)、Function(如 jsonb 类型)、Comment(紧跟字段后的 -- 或 /* */ 注释)
  • 注意 MySQL 的 ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 是表级属性,别误判成字段类型
  • PostgreSQL 的 GENERATED ALWAYS AS (...) STORED 是计算列,需单独标记,不能当普通字段处理

生成 HTML 时用 table + colgroup 控制列宽,PDF 转换才不挤

用 pandas.DataFrame.to_html() 直接输出表格看着快,但生成的 HTML 缺少语义化列定义,weasyprint 或 wkhtmltopdf 渲染 PDF 时列宽乱跳,尤其字段名长、类型短的组合下,类型列会被压成“...”。

实操建议:

  • 手动拼 HTML,用 <colgroup> <col width="20%"> <col width="15%"> </colgroup> 显式控制每列宽度
  • 字段名列加 white-space: nowrap,类型列允许换行,避免单行撑爆整页
  • PDF 中中文字体必须显式指定,weasyprint 默认不认系统字体,得在 CSS 里写 @font-face 引入 Noto Sans CJK SC 或本地 simhei.ttf
  • 别用 border-collapse: collapse 配合细边框——PDF 渲染器对 subpixel 边框支持差,容易出现断线或虚影

字段注释为空时,COMMENT 不等于 NULL,也未必是空字符串

很多数据库导出的字段注释字段是 NULL,但有些 ORM 或管理工具会把它转成空字符串甚至 " "(带空格)。直接 if not comment: 判空会把后者当成有注释,结果文档里冒出一堆空白格子。

实操建议:

  • 统一用 comment.strip() if comment else "" 归一化处理
  • PostgreSQL 的 obj_description() 函数返回 NULL 表示无注释;MySQL 的 COLUMN_COMMENT 字段类型是 TEXT,空注释就是空字符串,两者行为不一致
  • 如果上游没开注释,别自动填“暂无”,更别填“未填写”——这属于元数据污染,后续有人真写了注释反而难区分真假

字段注释的来源链路太长:建表时写、后期用 COMMENT ON 加、ORM 迁移脚本带、DBA 手动补……任何一个环节掉链子,字典就缺一块。别指望一次导出全对,得留个校验入口,比如按表名比对 pg_tables 和实际解析出的表数量。

前端入门到VUE实战笔记:立即使用
在学习笔记中,你将探索 前端 的入门与实战技巧!

极轻PDF
极轻PDF

专业的在线PDF工具,支持PDF编辑、转换、合并、压缩等多种功能,操作简单,处理高效,满足日常办公与学习中的PDF处理需求。

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
html版权符号
html版权符号

html版权符号是“©”,可以在html源文件中直接输入或者从word中复制粘贴过来,php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.14

6215

7

html在线编辑器
html在线编辑器

html在线编辑器是用于在线编辑的工具,编辑的内容是基于HTML的文档。它经常被应用于留言板留言、论坛发贴、Blog编写日志或等需要用户输入普通HTML的地方,是Web应用的常用模块之一。php中文网为大家带来了html在线编辑器的相关教程、以及相关文章等内容,供大家免费下载使用。

2023.06.21

3492

4

html网页制作
html网页制作

html网页制作是指使用超文本标记语言来设计和创建网页的过程,html是一种标记语言,它使用标记来描述文档结构和语义,并定义了网页中的各种元素和内容的呈现方式。本专题为大家提供html网页制作的相关的文章、下载、课程内容,供大家免费下载体验。

2023.07.31

3150

5

html空格
html空格

html空格是一种用于在网页中添加间隔和对齐文本的特殊字符,被用于在网页中插入额外的空间,以改变元素之间的排列和对齐方式。本专题为大家提供html空格的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.01

3179

5

html是什么
html是什么

HTML是一种标准标记语言,用于创建和呈现网页的结构和内容,是互联网发展的基石,为网页开发提供了丰富的功能和灵活性。本专题为大家提供html相关的各种文章、以及下载和课程。

2023.08.11

4919

6

html字体大小怎么设置
html字体大小怎么设置

在网页设计中,字体大小的选择是至关重要的。合理的字体大小不仅可以提升网页的可读性,还能够影响用户对网页整体布局的感知。php中文网将介绍一些常用的方法和技巧,帮助您在HTML中设置合适的字体大小。

2023.08.11

3121

3

html转txt
html转txt

html转txt的方法有使用文本编辑器、使用在线转换工具和使用Python编程。本专题为大家提供html转txt相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.31

2929

3

html文本框代码怎么写
html文本框代码怎么写

html文本框代码:1、单行文本框【<input type="text" style="height:..;width:..;" />】;2、多行文本框【textarea style=";height:;"></textare】。

2023.09.01

2588

6

HTML嵌入CSS样式的方法
HTML嵌入CSS样式的方法

HTML嵌入CSS样式的方法有内联样式、内部样式表和外部样式表。本专题为大家提供CSS样式相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.20

2648

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.7万人学习