mysql，postgresql导出数据库结构(文档)描述信息

目标

根据要求，需要补全以前的数据库文档，如果一个表一个表的去手写，很麻烦，所以想着使用数据库工具进行导出，查看了navicat并没有期望的功能，powerDesign配置了半天也没配置好，但是在Typora工具中发现可以将md文档导出为各种格式的文件，所以只需要将数据库表结构信息生成为md文档就可以

实现

最终选择使用python(python连接数据库比jdbc来的方便，天生的list，map处理也很方便)来进行数据库连接，查询数据库表结构然后返回为md文档，思路

1. 根据用户传递的数据库连接信息，查询数据库指定库和schema下的表

2. 遍历所有表，查询表的结构信息

3. 根据每个表和表结构信息构造为md文档的表格格式的数据

   |参数|类型|长度|描述|
   |----|----|----|----|
   |id|int|32|主键|
   |name|varchar|16|名称|
   

4. 写出生成md文档

5. 使用typora软件打开md文档，导出-》选择导出格式

   项目源码地址https://gitee.com/elitetyc/database-structure-export：需要使用pip安装的库psycopg2, pymysql

使用

# mysql数据库测试导出
    prostgre_pro = DBProperties('ry-cloud', 'root', '123456', 'localhost', '3306')
    db = MysqlDB(prostgre_pro)
    db.init_data()
    db.export_md(r"C:\Users\tanyuanchao\Desktop\export",
                 export_fields=(ExportField(name='name'), ExportField(name='type'), ExportField(name='length'),
                                ExportField(name='nullable',
                                            # 自定义字段格式换函数，每个是否可空后面加一个---test
                                            format_fun=lambda field, fields_dict: str(fields_dict['nullable'])+"---test"),
                                ExportField(name='desc')))

使用步骤分为

1. 创建数据库连接信息DBProperties

   数据库配置信息
   database:库名称
   user：用户名
   password：密码
   host：数据库主机地址
   port：端口号
   ignore_table_fun：忽略表函数，即根据表名和表注释来判断是否不生产这个表信息，返回true表示忽略生产，返回false表示需要生成，默认生成所有表
   schema：表所在schema，例如postgresql，mysql未用到这个参数（mysql直接使用的database）
   

2. 创建数据库

   db = MysqlDB(prostgre_pro)
   

3. 初始化数据:调用数据初始化便会进行数据库查询，查询表信息，表结构信息，最终封装为一个Table的list

   db.init_data()
   

4. 导出为md文件，export_md第二个参数导出参数列表可以不用传递，有一个默认导出列表，如果需要自定义格式可要进行传递

   db.export_md(r"C:\Users\tanyuanchao\Desktop\export",
                export_fields=(ExportField(name='name',c_name='参数名称'), ExportField(name='type'), ExportField(name='length'),
                               ExportField(name='nullable',
                                           # 自定义字段格式换函数，每个是否可空后面加一个---test
                                           format_fun=lambda field, fields_dict: str(fields_dict['nullable'])+"---test"),
                               ExportField(name='desc')))
   

   • 参数1：导出位置，可以包含全文件名，例如C:\Users\tanyuanchao\Desktop\export\数据库文档.md,这将直接使用改文件名进行导出，如果不包含具体文件，只是传递文件夹路径，将会使用【主机地址(数据库)】.md来进行生成

   • 参数2：导出参数，是一个ExportField的列表，表格列导出顺序就是列表的顺序，能使用的列为name，type，length，nullable，desc，

     format_fun表示需要导出指定格式化的列，fields_dict是一个字典，可以获取到某一个字段的name，type，length，nullable，desc，

   下面为ExportField 的定义信息，即如果传递了format_fun这个函数，其实name参数已经不那么重要了，具体返回逻辑是你的这个函数的定义的：

   class ExportField:
       """
       表结构字段导出规则
       name:表字段名
       c_name:自定义的表字段中文名，未指定时将使用默认，例如name=type,c_name=参数类型，生产的表头为“参数类型”
       format_fun:格式化函数，这个字段如何进行显示，接收两个参数，一个是当前对象，一个是实际的数据字典，
               example:默认是将【类型】和【长度】分开展示导出，我们如果需要将类型展示为  varchar(100)这种格式就可以定义一个函数如下
               def type_len(field, field_dict):
                   return filed_dict['type']+'('+filed_dict['length']+')'
       """
   
       def __init__(self, name, c_name=None, format_fun=default_format_fun):
           self.name = name
           if c_name is None:
               if name == 'name':
                   self.c_name = '参数'
               elif name == 'type':
                   self.c_name = '类型'
               elif name == 'length':
                   self.c_name = '长度'
               elif name == 'nullable':
                   self.c_name = '允空'
               elif name == 'desc':
                   self.c_name = '注释'
               else:
                   self.c_name = '未知参数'
           self.format_fun = format_fun
   

结果

image-20210902154922896.png

将md文档导出为world文档：typora->文件->导出->Word(有可能需要下载指定软件)：

image-20210902155127086.png