python将数据库导出为md文件

python 将数据库导出为 md 文件

介绍

  用于在数据库设计的时候,将设计的表字段,转化为数据字典。

环境

  • python38

代码

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
#!/usr/bin/env python
# -*- coding: utf-8 -*-
# Python version 3.7.1

import mysql.connector
import importlib
import sys


def generate(database_name):
"""
生成数据库字典表
"""
importlib.reload(sys)

# 使用前修改配置
conn = mysql.connector.connect(
host='127.0.0.1',
port='3306',
user='root',
password='123456',
use_pure=True
)

cursor = conn.cursor()

cursor.execute(
"SELECT TABLE_NAME, TABLE_COMMENT FROM information_schema.TABLES WHERE table_type='BASE TABLE' AND TABLE_SCHEMA='%s'" % database_name
)

tables = cursor.fetchall()

markdown_table_header = """\n\n\n### %s (%s) \n| 序号 | 字段名称 | 数据类型 | 是否为空 | 字段说明 |\n| :--: |----| ---- | ---- | ---- |\n"""
markdown_table_row = """| %s | %s | %s | %s | %s |"""

f = open(database_name + '.md', 'w')

for table in tables:

cursor.execute(
"SELECT ORDINAL_POSITION, COLUMN_NAME, COLUMN_TYPE, IS_NULLABLE, COLUMN_COMMENT "
"FROM information_schema.COLUMNS WHERE TABLE_SCHEMA='%s' AND TABLE_NAME='%s'" % (
database_name, table[0]
)
)

tmp_table = cursor.fetchall()
p = markdown_table_header % (table[0], remove_newline(table[1]))
for col in tmp_table:
p += (remove_newline(markdown_table_row % col) + "\n")
print(p)
f.writelines(p)

f.close()
1
2
3
4
5
def remove_newline(text):
"""
去除文本中的换行符号
"""
return text.replace("\r", "").replace("\n", "")
1
2
if __name__ == '__main__':
generate('输入要生成的数据库名')