# database-doc

**Repository Path**: lijunsong/database-doc

## Basic Information

- **Project Name**: database-doc
- **Description**: 提供对外接口，实现数据库表文档(html,word或md)导出，并支持docker部署
- **Primary Language**: Unknown
- **License**: EPL-1.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 2
- **Forks**: 0
- **Created**: 2021-04-27
- **Last Updated**: 2023-01-30

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

基于 https://gitee.com/leshalv/screw 改造
## 配置数据库：
 
 spring.datasource.url=jdbc:mysql://127.0.0.1:3306/database_name?useUnicode=true&characterEncoding=UTF-8&useSSL=false

 spring.datasource.username=root

 spring.datasource.password=root

 spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

 spring.datasource.xa.properties.useInformationSchema=true
 
## 提供对外接口实现文档导出
fileType对应取值为:html,word或md
![输入图片说明](https://images.gitee.com/uploads/images/2021/0427/143036_d475a0b6_542207.png "屏幕截图.png")

## Docker进行部署
![输入图片说明](https://images.gitee.com/uploads/images/2021/0427/202634_840edf8e_542207.png "屏幕截图.png")
配置maven命令，生成jar包
![输入图片说明](https://images.gitee.com/uploads/images/2021/0427/144814_17a8bdbc_542207.png "屏幕截图.png")


## 数据库支持

- [x] MySQL 
- [x] MariaDB 
- [x] TIDB 
- [x] Oracle 
- [x] SqlServer 
- [x] PostgreSQL
- [x] Cache DB（2016）
- [ ] H2 （开发中）
- [ ] DB2  （开发中）
- [ ] HSQL  （开发中）
- [ ] SQLite（开发中）
- [ ] 瀚高（开发中）
- [ ] 达梦 （开发中）
- [ ] 虚谷  （开发中）
- [ ] 人大金仓（开发中）

## 文档生成支持

- [x] html
- [x] word
- [x] markdown

## 文档截图

+ **html**

<p align="center">
   <img alt="HTML" src="https://images.gitee.com/uploads/images/2020/0622/161414_74cd0b68_1407605.png">
</p>
<p align="center">
   <img alt="screw-logo" src="https://images.gitee.com/uploads/images/2020/0622/161723_6da58c41_1407605.png">
</p>

+ **word**

<p align="center">
   <img alt="word" src="https://images.gitee.com/uploads/images/2020/0625/200946_1dc0717f_1407605.png">
</p>

+ **markdwon**

<p align="center">
   <img alt="markdwon" src="https://images.gitee.com/uploads/images/2020/0625/214749_7b15d8bd_1407605.png">
</p>
<p align="center">
   <img alt="markdwon" src="https://images.gitee.com/uploads/images/2020/0625/215006_3601e135_1407605.png">
</p>