# ScrewDatabaseDoc-GUI

**Repository Path**: tonguibin/screw-database-doc-gui

## Basic Information

- **Project Name**: ScrewDatabaseDoc-GUI
- **Description**: 基于screw可视化数据库文档工具
- **Primary Language**: Java
- **License**: LGPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 1
- **Created**: 2024-06-17
- **Last Updated**: 2025-08-29

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# ScrewDatabaseDoc-GUI

#### 介绍
基于screw可视化数据库文档生成工具
项目地址：[https://gitee.com/leshalv/screw]https://gitee.com/leshalv/screw)
原项目说明： screw (螺丝钉)  ~ 简洁好用的数据库表结构文档生成工具

#### 特点

- Java 原生GUI 可视化操作
- 多数据库支持
- 没了

#### 截图
![image-20240617105110570](/Image/image-20240617105110570.png)

#### 使用说明

git到本地后使用maven打包即可。运行时需要jre>=1.8。直接运行或者使用java -jar

#### 功能说明

1. 设置连接

   1. 进入数据库连接窗体

   2. 选择数据库类型

   3. 输入数据库信息

   4. 点击[保存并关闭]

      注：点击保存后会测试数据库连通性，联通后会自动以明文形式保存数据库连接信息

2. 使用帮助

   1. 可查看使用帮助

3. 地址：JDBC连接，只读

4. 获取数据库

   1. 点击后加载数据库列表，并加载到数据库下拉框中
   2. 以下库名不会存在于列表中
      - pg_catalog
      - information_schema
      - sys
      - performance_schema
      - mysql

5. 加载表

   1. 先点击[获取数据库]，在数据库下拉框中选择想要导出的库名再点击[加载表]
   2. 点击[加载表]后，会在列表中显示库下所有的表（不区分schema）

6. 全选：全选

7. 反选：反选

8. 只选：只选择有表描述的

9. 前缀为、后缀为、选择 ：通过 前后缀筛选选择的表

10. 输出路径-浏览：选择导出路径

11. 文件名称：输入文件名

12. 文件类型：screw支持的类型

    - Word
    - HTML
    - Markdown

13. 文档描述-版本：请参看screw描述

14. 生成并保存

    1. 根据选择的表去执行screw生成操作
    2. 生成成功后自动打开所在路径

#### 支持数据库

- MySQL

- Oracle

- PostgreSQL

- SqlServer（未测试）

- MariaDB（未测试）

- TIDB（screw支持，本项目未实现）

- Cache DB（2016）（screw支持，本项目未实现）

- 没了

  

#### 参与贡献

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