# 导出数据字典

**Repository Path**: w-abinbin/database-dictionary

## Basic Information

- **Project Name**: 导出数据字典
- **Description**: 1. 导出数据字典，支持MySQL，Oracle，SqlServer类型的数据库导出
2. 数据库全部表以及视图
3. Oracle数据库暂时不支持同义词
4. 目前只支持导出Excel
- **Primary Language**: Java
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 43
- **Forks**: 17
- **Created**: 2020-11-11
- **Last Updated**: 2025-05-08

## Categories & Tags

**Categories**: database-dev

**Tags**: None

## README

# database-dictionary

#### 介绍
 **仅支持JDK1.8及以上的项目使用** 
1. 导出数据字典，支持MySQL，Oracle，SqlServer类型的数据库导出
2. 数据库全部表以及视图
3. Oracle数据库暂时不支持同义词


#### 软件架构
软件架构说明

#### 安装教程


#### 使用说明
1. 引入jar包（/src/main/resources/database-dictionary-1.0.jar）

- 1.1 若项目为普通项目，可直接把该jar包放入lib下，导入项目中即可使用
- 1.2 若项目为maven项目，则需要把jar包放入本地的maven仓库（暂时还不会把jar包发布到maven中央仓库）：
- 当项目运行Maven install时，maven自动会把jar包自动保存至本地仓库
-      当新项目需要用到时只需要在pom.xml中配置如下，即可使用
       <dependency>
             <groupId>com.sfy.les</groupId>
             <artifactId>database-dictionary</artifactId>
             <version>1.0</version>
         </dependency>
        

   
2. 使用
```
//导出MYSQL数据库数据字典
DataBaseDictionary exportParam = new MysqlDataBaseDictionary();
//导出Oracle数据库数据字典
DataBaseDictionary exportParam = new OracleDataBaseDictionary();
//导出SqlServer数据库数据字典
DataBaseDictionary exportParam = new SqlServerDataBaseDictionary();
//赋值导出需要的参数
//导出的文件名称（必填）
exportParam.setFileName("xxx数据字典");
//jdbc连接所需的驱动（可不填）
exportParam.setDbDriver("oracle.jdbc.driver.OracleDriver");
//数据库连接地址（必填）
exportParam.setDbUrl("jdbc:oracle:thin:@127.0.0.1:1549:MYORACLE");
//数据库名称（必填）
exportParam.setDbName("study");
//数据库连接账号（必填）
exportParam.setDbUserName("a");
//数据库连接密码（必填）
exportParam.setDbPassword("b");
//表名前缀（用于同1个数据库，导出不同模块的表，选填）
exportParam.setTableNamePrefix("sys_");
//线程数，线程池大小（可不填，默认10）
exportParam.setnThreads(20);
//导出文件地址（必填）
exportParam.setFileUrl("/data/xx/xx/xx/");
//执行导出，返回文件存放地址
String path = exportParam.createExcel();
```
3. 效果展示
首页：
![首页](https://images.gitee.com/uploads/images/2020/1214/174201_bed52d06_8288917.png "屏幕截图.png")
详情：
![详情](https://images.gitee.com/uploads/images/2020/1214/174305_0f785701_8288917.png "屏幕截图.png")
#### 参与贡献

1.  abinbin
2.  W-abinbin
3.  卫
4.  weibin
5.  hpp
6.  hl
*****
> 最后，此工具类共享出来给大家使用，希望大家能够帮助一起完善，通过开源的方式互助。发现有什么bug，或者有什么想法欢迎 PR.

#### 更新日志
***
2021-04-14
1. 增加支持根据表前缀导出

***
新发布