背景

一般企业在做信息化项目的时候，等到验收环节需要承建单位提供如需求规格说明书、概要设计、详细设计、开发计划、数据库设计等等。这么多材料中数据库设计这份材料编制特别费时，费时的编制内容部分来自于数据库表结构的定义，每张表都需要定义成word表格形式。若是项目业务规模比较多，则数据库的表数量有可能上百个。这种情况下想要一个一个编制表结构，太浪费时间了。

本文通过python编程来解决这个问题。实现目标为了：通过连接某个数据库，将数据库的所有表结构信息导出至word中。

依赖库安装

环境激活

本人是通过python conda虚拟环境来进行开发的。首先通过本地安装好的虚拟环境命令来查看一下已创建好的虚拟环境目录。如下：

conda env list
# conda environments:
#
base                     E:\Users\65451\anaconda3
paddle_ocr               E:\Users\65451\anaconda3\envs\paddle_ocr
ppocr_label              E:\Users\65451\anaconda3\envs\ppocr_label
pytorch_project          E:\Users\65451\anaconda3\envs\pytorch_project
test_python           *  E:\Users\65451\anaconda3\envs\test_python

可以看到默认我已经激活至test_python这个虚拟环境下。若想激活进入其它虚拟环境，可通过命令：

conda deactivate
conda activate pytorch_project

这样就激活进入pytorch_project虚拟环境了。本文依旧使用test_python虚拟环境进行实践。进入该虚拟环境下，可通过pip命令进行安装扩展包信息。

环境依赖安装

若想实现本文目标，需安装python-docx、pymysql 两个扩展包，安装命令如下：

 pip install python-docx --upgrade

打印输出内容为：

Looking in indexes: https://pypi.tuna.tsinghua.edu.cn/simple
Requirement already satisfied: python-docx in e:\users\65451\anaconda3\envs\test_python\lib\site-packages (1.1.2)
Requirement already satisfied: lxml>=3.1.0 in e:\users\65451\anaconda3\envs\test_python\lib\site-packages (from python-docx) (5.4.0)
Requirement already satisfied: typing-extensions>=4.9.0 in e:\users\65451\anaconda3\envs\test_python\lib\site-packages (from python-docx) (4.13.2)

正常情况下会顺利的安装，我这边因为已经安装过了这个扩展，所以会提示Requirement already satisfied。所以下载速度慢，可以更换pip镜像源，推进使用清华大学的地址。如下：

https://pypi.tuna.tsinghua.edu.cn/simple

执行镜像源地址下载安装包命令如下：

 pip install python-docx -i https://pypi.tuna.tsinghua.edu.cn/simple

pymysql扩展包安装与python-docx一样。举简单例子：

 pip install pymysql -i https://pypi.tuna.tsinghua.edu.cn/simple

默认情况下是下载两个包的最新版本。通过命令查看扩展包是否已经安装完成。如下：

pip list

打印内容为：

------------------ ---------
certifi            2025.1.31
charset-normalizer 3.4.1
idna               3.10
lxml               5.4.0
pip                25.0
PyMySQL            1.1.1
python-docx        1.1.2
requests           2.32.3
setuptools         75.8.0
typing_extensions  4.13.2
urllib3            2.3.0
wheel              0.45.1

发现两个包已经顺利安装完成了。

实现过程

连接数据库获取表信息

数据库连接，采用标准的扩展库连接方式，连接信息如下：

def generate_word_dict(dbhost, user, password, database):
	# 连接数据库
	conn = pymysql.connect(host=dbhost, user=user, password=password, database=database)
	# 获取库里所有表的信息
	cursor = conn.cursor()
	# 执行获取表信息
	cursor.execute("SHOW TABLES")
	tables = cursor.fetchall()

定义输出表格

创建表格信息，定义生成表结构信息包含字段名称、字段类型、是否为空、默认值、主键信息、字段描述等字段，所以需要定义一个6列N行的表格。如下：

    # 创建Word文档
	doc = Document()
	# 循环数据库表信息
	for table in tables:
		table_name = table[0]
		# 查询某张表的表描述信息TABLE_COMMENT
		cursor.execute(f"SELECT TABLE_COMMENT FROM information_schema.TABLES WHERE "
					   f"TABLE_SCHEMA = '{database}' and TABLE_NAME = '{table_name}'")
         
        # 获取表描述信息，并设置word头表信息描述，如 表名：cs_user 表说明：用户管理表
		for desc in cursor.fetchall():
			table_desc = desc[0]
			doc.add_heading("表名：{}    表说明：{}".format(table_name, table_desc), level=3)
		# 创建表格
		table_obj = doc.add_table(rows=1, cols=6)
		# 设置第一行单元格背景颜色
		set_row_background_color(table_obj.rows[0], "#D0893C")
		# 设置全局表格样式，主要是为了描单元格边框
		tbl = table_obj._tbl
		tbl_pr = tbl.tblPr  # 替代原get_or_add_tblPr()
		tbl_borders = OxmlElement('w:tblBorders')
		    for border_type in ['top', 'left', 'bottom', 'right', 'insideH', 'insideV']:
				border = OxmlElement(f'w:{border_type}')
				border.set(qn('w:val'), 'single')
				border.set(qn('w:sz'), '12')
				#设置单元格边框颜色
				border.set(qn('w:color'), '6E6E6E')
				tbl_borders.append(border)
		tbl_pr.append(tbl_borders)

这里设置单元格背景颜色的方法如下：

def set_row_background_color(row, color_hex):
	"""
    设置表格行的背景颜色
    :param row: 表格行对象（如 table.rows[0]）
    :param color_hex: 十六进制颜色值（例如 "FF0000" 表示红色）
    """
	for cell in row.cells:
		tc_pr = cell._tc.get_or_add_tcPr()
		shd = OxmlElement('w:shd')
		shd.set(qn('w:fill'), color_hex)
		tc_pr.append(shd)

添加表格数据

创建表格信息，定义生成表结构信息包含字段名称、字段类型、是否为空、默认值、主键信息、字段描述等字段，所以需要定义一个6列N行的表格。如下：

    # 创建Word文档
	doc = Document()
	# 循环数据库表信息
	for table in tables:
		table_name = table[0]
		# 查询某张表的表描述信息TABLE_COMMENT
		cursor.execute(f"SELECT TABLE_COMMENT FROM information_schema.TABLES WHERE "
					   f"TABLE_SCHEMA = '{database}' and TABLE_NAME = '{table_name}'")
         
        # 获取表描述信息，并设置word头表信息描述，如 表名：cs_user 表说明：用户管理表
		for desc in cursor.fetchall():
			table_desc = desc[0]
			doc.add_heading("表名：{}    表说明：{}".format(table_name, table_desc), level=3)
		# 创建表格
		table_obj = doc.add_table(rows=1, cols=6)
		# 设置第一行单元格背景颜色
		set_row_background_color(table_obj.rows[0], "#D0893C")
		# 设置全局表格样式，主要是为了描单元格边框
		tbl = table_obj._tbl
		tbl_pr = tbl.tblPr  # 替代原get_or_add_tblPr()
		tbl_borders = OxmlElement('w:tblBorders')
		    for border_type in ['top', 'left', 'bottom', 'right', 'insideH', 'insideV']:
				border = OxmlElement(f'w:{border_type}')
				border.set(qn('w:val'), 'single')
				border.set(qn('w:sz'), '12')
				#设置单元格边框颜色
				border.set(qn('w:color'), '6E6E6E')
				tbl_borders.append(border)
		tbl_pr.append(tbl_borders)

验证

最后把上述分解的任务模块进行合并，设置测试数据库连接信息。输入打印查看结果。完整的项目代码如下：

from docx import Document
from docx.oxml import OxmlElement
from docx.oxml.ns import qn
import pymysql


def set_row_background_color(row, color_hex):
	"""
    设置表格行的背景颜色
    :param row: 表格行对象（如 table.rows[0]）
    :param color_hex: 十六进制颜色值（例如 "FF0000" 表示红色）
    """
	for cell in row.cells:
		tc_pr = cell._tc.get_or_add_tcPr()
		shd = OxmlElement('w:shd')
		shd.set(qn('w:fill'), color_hex)
		tc_pr.append(shd)




def generate_word_dict(dbhost, user, password, database):
	# 连接数据库
	conn = pymysql.connect(host=dbhost, user=user, password=password, database=database)

	# 创建Word文档
	doc = Document()

	# 获取所有表
	cursor = conn.cursor()

	cursor.execute("SHOW TABLES")
	tables = cursor.fetchall()

	for table in tables:
		table_name = table[0]

		cursor.execute(f"SELECT TABLE_COMMENT FROM information_schema.TABLES WHERE "
					   f"TABLE_SCHEMA = '{database}' and TABLE_NAME = '{table_name}'")

		for desc in cursor.fetchall():
			table_desc = desc[0]
			doc.add_heading("表名：{}    表说明：{}".format(table_name, table_desc), level=3)

		# 创建表格
		table_obj = doc.add_table(rows=1, cols=6)
		set_row_background_color(table_obj.rows[0], "#D0893C")
		# 设置全局表格样式
		tbl = table_obj._tbl
		tbl_pr = tbl.tblPr  # 替代原get_or_add_tblPr()
		tbl_borders = OxmlElement('w:tblBorders')

		for border_type in ['top', 'left', 'bottom', 'right', 'insideH', 'insideV']:
			border = OxmlElement(f'w:{border_type}')
			border.set(qn('w:val'), 'single')
			border.set(qn('w:sz'), '12')
			border.set(qn('w:color'), '6E6E6E')
			tbl_borders.append(border)
		tbl_pr.append(tbl_borders)

		hdr_cells = table_obj.rows[0].cells
		hdr_cells[0].text = '字段名'
		hdr_cells[1].text = '类型'
		hdr_cells[2].text = '允许为空'
		hdr_cells[3].text = '默认值'
		hdr_cells[4].text = '主键'
		hdr_cells[5].text = '字段说明'

		'''每个字段说明'''
		cursor.execute(f"SELECT COLUMN_NAME,COLUMN_COMMENT FROM information_schema.COLUMNS WHERE TABLE_SCHEMA = '{database}' and TABLE_NAME='{table_name}'")
		table_rows = []
		for row in cursor.fetchall():
			table_rows.append(list(row))

		# 填充数据
		cursor.execute(f"DESCRIBE {table_name}")
		num = 0
		for row in cursor.fetchall():
			table_details = table_rows[num]
			row_cells = table_obj.add_row().cells
			row_cells[0].text = row[0]  # 字段名
			row_cells[1].text = row[1]  # 类
			row_cells[2].text = '是' if row[2] == 'YES' else '否'
			row_cells[3].text = str(row[4]) if row[4] != '' else ''
			row_cells[4].text = row[5] if row[3] == 'PRI' else ''
			row_cells[5].text = table_details[1] if row[0] == table_details[0] else ''
			num = num + 1

	doc.save('database_dict.docx')


if __name__ == "__main__":
    # 定义你自己的数据库连接信息
	host = '114.216.172.33'
	user = 'root'
	password = 'shuton899001'
	database = 'detest'
	generate_word_dict(dbhost=host, user=user, password=password, database=database)

这里dbtest是我新建的数据库，里面包含了cs_user这张表。如下：

此时执行脚本，会生成word文档，文档里的内容如下：