700字范文 > 一键导出PostgreSQL数据库表设计为word文档

一键导出PostgreSQL数据库表设计为word文档

时间：2019-04-07 16:01:12

背景

项目开始时，数据库表设计是从概要设计到详细设计，再到数据库中的表结构，有一套完整的文档；

然而，随着项目的演进，需求的变更，导致数据库表结构发生了比较大的变化（加表，加字段，改类型等），对于大多数小公司的项目，由于项目管理流程的不规范，在这个时候大概率是数据库设计文档没有同步跟进而过时；

现在，问题来了，出于各种原因吧，需要提供当前数据库的设计文档（总不能一张张表、一个个字段去手写吧。。）；

那么，怎么从现有的数据库表自动导出一个相对比较整齐的word文档呢？

从网上看了下，有人提供了方案＼(☆o☆)／，可一键导出MySQL数据库设计为.doc文件，见参考地址；我这里在作者的基础上，实现一键导出PostgreSQL数据库设计为.doc文件。

效果

这里以开源物联网平台jetlinks项目的数据表为例进行PostgreSQL数据库设计的导出。

运行

MySQL版作者的实现是写了一个Controller，提供了一个RESTful接口来生成文档，这里是在单元测试类中提供了一个方法：

运行com.heartsuit.db2word.postgresql.service.impl.DataSourceDetailServiceImplTest中的toWord()测试方法，可直接生成.doc文件。

参考SQL

查询所有表名

select relname as table_name,(select description from pg_description where objoid=oid and objsubid=0) as table_comment from pg_class where relkind ='r' and relname NOT LIKE 'pg%' AND relname NOT LIKE 'sql_%'order by table_name;

查询每个表的字段信息

selecta.attname as 字段名称,format_type(a.atttypid,a.atttypmod) as 类型,(case when atttypmod-4>0 then atttypmod-4 else 0 end) as 长度,(case when (select count(*) from pg_constraint where conrelid = a.attrelid and conkey[1]=attnum and contype='p')>0 then 'PRI' when (select count(*) from pg_constraint where conrelid = a.attrelid and conkey[1]=attnum and contype='u')>0 then 'UNI'when (select count(*) from pg_constraint where conrelid = a.attrelid and conkey[1]=attnum and contype='f')>0 then 'FRI'else '' end) as 索引,(case when a.attnotnull=true then 'NO' else 'YES' end) as 允许为空,col_description(a.attrelid,a.attnum) as 说明from pg_attribute awhere attstattarget=-1 and attrelid = (select oid from pg_class where relname ='ok');