# export_database_dictionary

**Repository Path**: fingersnow/export_database_dictionary

## Basic Information

- **Project Name**: export_database_dictionary
- **Description**: 项目中需要用到数据库字典，但有时候更新了数据库并不会实时更新文档，我的想法是有一个工具可以导出数据库的表字典，这样就不用人来手动写，但是在网上没有找到相应的工具。
就依照下面的思路自己写一个：oracle-导出表结构数据（json格式）-java读取json-word模板-生成word文件
暂时提供了oracle的数据库脚本导出表结构为json（dbjson.sql文件），其他的还没有写。
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 3
- **Created**: 2018-12-06
- **Last Updated**: 2022-04-18

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# export_database_dictionary

#### 项目介绍

项目中需要用到数据库字典，但有时候更新了数据库并不会实时更新文档，我的想法是有一个工具可以导出数据库的表字典，这样就不用人来手动写，但是在网上没有找到相应的工具。

就依照下面的思路自己写一个：

oracle-导出表结构数据（json格式）-java读取json-word模板-生成word文件
暂时提供了oracle的数据库脚本导出表结构为json（dbjson.sql文件），其他的还没有写。

现在已经支持excel导出。

#### 软件架构

1. JDK1.8
2. fastjson
3. freemark
4. easyexcel


#### 安装教程

1. 项目下载 git clone git@gitee.com:fingersnow/export_database_dictionary.git
2. 用eclipse打开该maven项目
3. 更新相应的pom依赖

#### 使用说明

##### word使用

1. 创建t_temp表 create table t_temp(a clob);
2. 执行测试方法，将json数据保存在表t_temp
3. 检查json数据是否合法，具体可以复制粘贴到网上校验json。
4. 将json放到dbStructure.json文件中，或者其他的名称文件也行，不过要在执行过程中传入文件名，默认是dbStructure.json
5. 将word编排好格式，将需要写入的数据更改成freemark参数形式。
6. 将word另存为xml格式。并用notepad++ 打开进行编辑，将需循环或者其他处理的内容按照freemark模板语法进行编写。
7. 将xml文件修改后缀名为ftl，并放到资源ftl文件下。
8. 指定刚刚做好的模板后执行CreateWordMain类的main方法。

##### excel导出使用

1. 创建t_temp表 create table t_temp(a clob);
2. 执行测试方法，将json数据保存在表t_temp
3. 检查json数据是否合法，具体可以复制粘贴到网上校验json。
4. 将json放到dbStructure.json文件中，或者其他的名称文件也行，不过要在执行过程中传入文件名，默认是dbStructure.json
5. 指定刚刚做好的模板后执行CreateWordMain类的main方法。
6. 使用excel的公式 =HYPERLINK("#"&A2&"!A1","点击查看") 对每一个表格添加超链接到相应的sheet

#### 参与贡献

1. Fork 本项目
2. 新建 Feat_xxx 分支
3. 提交代码
4. 新建 Pull Request

#### 现有问题

1. 在使用过程中如果表数量太大，word打不开
2. 使用起来有些复杂
3. 暂时只有oracle脚本

#### 将要推出功能

1. 本项目只是一个java项目，json字符需要从数据库中copy，现开发一个springboot项目，配置好数据源可以直接登录使用。在分支springboot版本