在開發和維護數據庫的過程中，能夠快速且準確地獲取表結構信息是至關重要的。本文將向您展示一種簡單而有效的方法，利用Python腳本從MySQL數據庫中提取指定表的結構信息，并將其導出為格式化的Word文檔。此方法不僅提高了工作效率，還確保了文檔的一致性和準確性。
使用步驟：
第一步：安裝必要的庫
首先，你需要確保你的環境中安裝了mysql-connector-python和python-docx這兩個Python庫。你可以通過以下命令來安裝它們：
pip install mysql-connector-python python-docx
第二步：準備代碼
復制以下Python代碼，并保存為.py文件（例如export_table_structure.py）。
import mysql.connector
from docx import Documentdef get_table_structure_with_comments(host, port, user, password, database, table):try:cnx = mysql.connector.connect(user=user,port=port,password=password,host=host,database=database)cursor = cnx.cursor()# 獲取表結構和字段信息（包含comment）columns_query = """SELECT COLUMN_NAME, COLUMN_TYPE, IS_NULLABLE, COLUMN_KEY, COLUMN_DEFAULT, EXTRA,COLUMN_COMMENTFROM information_schema.COLUMNSWHERE TABLE_SCHEMA = %s AND TABLE_NAME = %sORDER BY ORDINAL_POSITION;"""cursor.execute(columns_query, (database, table))columns_info = cursor.fetchall()# 獲取表的commenttable_comment_query = """SELECT TABLE_COMMENTFROM information_schema.TABLESWHERE TABLE_SCHEMA = %s AND TABLE_NAME = %s;"""cursor.execute(table_comment_query, (database, table))table_comment = cursor.fetchone()[0]cursor.close()cnx.close()return table_comment, columns_infoexcept mysql.connector.Error as err:print(f"Database Error: {err}")return None, Nonedef write_to_docx_with_comments(table_name, table_comment, columns_info, output_path):document = Document()# 表標題帶注釋document.add_heading(f'Table Structure for {table_name} ({table_comment})', level=1)document.add_heading('Columns Information', level=2)# 創建表格：table = document.add_table(rows=1, cols=6)hdr_cells = table.rows[0].cellshdr_cells[0].text = 'Field'hdr_cells[1].text = 'Type'hdr_cells[2].text = 'Null'hdr_cells[3].text = 'Key'hdr_cells[4].text = 'Default'#hdr_cells[5].text = 'Extra'hdr_cells[5].text = 'Comment'for column in columns_info:row_cells = table.add_row().cellsrow_cells[0].text = column[0] or ''row_cells[1].text = column[1] or ''row_cells[2].text = column[2] or ''row_cells[3].text = column[3] or ''row_cells[4].text = str(column[4]) if column[4] is not None else ''#row_cells[5].text = column[5] or ''row_cells[5].text = column[6] or ''document.save(output_path)# 使用示例
if __name__ == '__main__':host = '127.0.0.1'port = 3306user = 'user'password = 'password'database = 'database'table = 'goods'output_path = './goods.docx'# 獲取表注釋和字段信息table_comment, columns_info = get_table_structure_with_comments(host, port, user, password, database, table)if table_comment and columns_info:write_to_docx_with_comments(table, table_comment, columns_info, output_path)print(f"文檔已保存至：{output_path}")else:print("無法讀取數據庫表結構，請檢查連接或表是否存在。")
第三步：配置數據庫連接參數
在代碼的末尾，找到如下部分，根據您的數據庫實際信息修改這些變量值：
host = '127.0.0.1' # 數據庫主機地址
port = 3306 # 端口號
user = 'user' # 用戶名
password = 'password' # 密碼
database = 'database' # 數據庫名
table = 'goods' # 表名
output_path = './goods.docx' # 輸出文件路徑
第四步：運行腳本
打開終端或命令提示符，導航至包含上述腳本的目錄，然后運行該腳本：
python export_table_structure.py
如果一切設置正確，腳本將自動生成一個名為goods.docx的Word文檔，其中包含了指定表的結構信息。
第五步：檢查輸出結果
打開生成的Word文檔，檢查內容是否符合預期。每個字段的信息都應清晰地列出，包括名稱、數據類型、是否允許NULL、鍵信息、默認值以及注釋等。
通過這種方式，您可以輕松地為數據庫中的任何表創建詳細的結構文檔，這在項目交接、文檔編寫或是日常維護工作中都非常有用。希望這個小技巧能幫助您更高效地管理數據庫資源！
)
