# 数据库字典生成脚本

**Repository Path**: cbt2442064484_admin/database-dictionary-shengc

## Basic Information

- **Project Name**: 数据库字典生成脚本
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-04
- **Last Updated**: 2026-03-04

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 数据字典生成工具使用文档

## 项目简介

本项目提供了两个数据字典生成脚本，分别用于MySQL和SQL Server数据库，能够自动生成包含表结构、字段注释和外键关联信息的数据字典。

## 环境要求

- Python 3.6+
- 相应的数据库驱动
  - MySQL: `mysql-connector-python`
  - SQL Server: `pyodbc`

## 安装依赖

### 安装MySQL驱动
```bash
pip install mysql-connector-python
```

### 安装SQL Server驱动
```bash
pip install pyodbc
```

## 脚本说明

### 1. MySQL数据字典生成脚本

#### 文件：`generate_data_dict.py`

##### 功能：
- 连接本地MySQL数据库
- 提取所有表的结构信息
- 收集表注释、字段注释和外键关联信息
- 生成JSON和HTML格式的数据字典
- 支持表名筛选功能

##### 配置：
默认连接信息：
- 主机：localhost
- 用户名：
- 密码：
- 数据库：

如需修改连接信息，请编辑脚本中的`config`字典。

##### 使用方法：
```bash
python generate_data_dict.py
```

### 2. SQL Server数据字典生成脚本

#### 文件：`generate_sqlserver_dict.py`

##### 功能：
- 连接远程SQL Server数据库
- 提取所有非系统数据库的表结构信息
- 收集表注释、字段注释和外键关联信息
- 生成JSON和HTML格式的数据字典
- 支持表名筛选功能

##### 配置：
默认连接信息：
- 服务器：
- 用户名：
- 密码：
- 初始数据库：

如需修改连接信息，请编辑脚本中的`connection_string`变量。

##### 使用方法：
```bash
python generate_sqlserver_dict.py
```

## 生成的文件

### MySQL数据字典
- `data_dictionary.json`：JSON格式的数据字典，包含所有表的详细信息
- `data_dictionary.html`：HTML格式的数据字典，包含表名筛选功能

### SQL Server数据字典
- `sqlserver_data_dictionary.json`：JSON格式的数据字典，包含所有数据库和表的详细信息
- `sqlserver_data_dictionary.html`：HTML格式的数据字典，包含表名筛选功能

## HTML数据字典使用说明

1. 打开生成的HTML文件（如`data_dictionary.html`或`sqlserver_data_dictionary.html`）
2. 在顶部的搜索框中输入表名关键字
3. 系统会实时筛选出匹配的表，隐藏不匹配的表
4. 点击表名查看详细结构信息
5. 查看字段注释和外键关联信息

## 常见问题及解决方法

### 1. 数据库连接失败

**症状**：运行脚本时出现连接错误

**解决方法**：
- 检查数据库服务是否运行
- 检查连接信息是否正确
- 检查网络连接是否正常
- 确保用户名和密码正确

### 2. 缺少依赖库

**症状**：运行脚本时出现`ModuleNotFoundError`

**解决方法**：
- 安装相应的依赖库：
  ```bash
  pip install mysql-connector-python  # MySQL
  pip install pyodbc  # SQL Server
  ```

### 3. SQL Server连接问题

**症状**：无法连接到SQL Server数据库

**解决方法**：
- 确保SQL Server服务已启动
- 确保SQL Server允许远程连接
- 检查防火墙设置
- 验证连接字符串中的服务器地址和端口

## 注意事项

1. 脚本会自动处理所有表，包括系统表
2. 生成的数据字典包含详细的表结构信息
3. HTML格式的数据字典支持实时搜索功能
4. JSON格式的数据字典可以用于进一步的数据分析

## 示例

### MySQL数据字典示例

```json
{
  "act_evt_log": {
    "columns": [
      {
        "field": "LOG_NR_",
        "type": "bigint(20)",
        "null": "NO",
        "key": "PRI",
        "default": null,
        "extra": "auto_increment",
        "comment": "日志编号"
      },
      ...
    ],
    "comment": "事件日志表"
  }
}
```

### SQL Server数据字典示例

```json
{
  "T9IMS": {
    "dbo.User": {
      "columns": [
        {
          "field": "UserID",
          "type": "int",
          "max_length": null,
          "null": "NO",
          "default": null,
          "extra": "IDENTITY",
          "comment": "用户ID"
        },
        ...
      ],
      "comment": "用户表",
      "foreign_keys": [
        {
          "name": "FK_User_Role",
          "columns": "(RoleID)",
          "referenced_table": "Role",
          "referenced_columns": "(RoleID)"
        }
      ]
    }
  }
}
```

## 联系方式

如果您在使用过程中遇到任何问题，请随时联系我们。