# RuoYi-SchemaX

**Repository Path**: wsitm/RuoYi-SchemaX

## Basic Information

- **Project Name**: RuoYi-SchemaX
- **Description**: Schema（数据库结构）X（转换），DDL转换功能，迁移异构数据库。理论上可以转换常见的数据库方言的DDL语句。通过配置对应JDBC驱动，数据库连接，可以直接导出表结构、在线 查看表结构、跨数据库方言生成DDL语句。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 21
- **Forks**: 4
- **Created**: 2025-02-09
- **Last Updated**: 2025-11-15

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

<h1 align="center" style="margin: 30px 0 30px; font-weight: bold;">RuoYi-SchemaX v3.9.0</h1>
<h4 align="center">基于RuoYi框架开发的数据库结构转换工具</h4>
<p align="center">
	<a href="https://gitee.com/wsitm/RuoYi-SchemaX.git">
      <img src="https://img.shields.io/badge/SchemaX-v3.9.0-brightgreen.svg">
    </a>
	<a href="https://gitee.com/wsitm/RuoYi-SchemaX/blob/master/LICENSE">
      <img src="https://img.shields.io/github/license/mashape/apistatus.svg">
    </a>
</p>

## 简介

* Schema（数据库结构）X（转换）
* 迁移数据库库，而异构数据库时就DDL语句让人很头疼。<strong>DDL转换</strong>就可以解决这个问题，理论上可以转换市面上常见的数据库方言的DDL语句。
* 通过上传驱动文件，并<strong>配置对应JDBC驱动包</strong>，然后配置数据库连接，可以直接<strong>导出表结构</strong>
  、在线<strong>
  查看表结构</strong>、<strong>跨数据库方言生成DDL语句</strong>。
* 驱动包可以自定义上传，所以理论上支持所有关系型数据库。

### 免安装单机下载win版 [SchemaX-win32-x64-v1.1.0.zip](https://gitee.com/wsitm/SchemaX/releases/tag/v1.1.0)


## 功能介绍

<strong>一、DDL转换</strong>

- 工具的另一大亮点在于DDL转换功能。我们深知DDL语句在不同数据库之间的差异性，因此特别设计了这一功能来兼容输入各种类型的DDL语句。
- 用户只需输入原始的DDL语句，并指定目标数据库的方言，工具即可智能地将其转换为相应的DDL语句。

<strong>二、驱动管理</strong>

- 驱动管理功能，用户能够上传并配置各类数据库驱动包。无论是常见的MySQL、Oracle、PostgreSQL、SQL
  Server，还是更多小众的数据库类型，只需上传相应的驱动包，即可迅速完成配置。
- 这一功能不仅简化了驱动安装与更新的繁琐过程，还确保了工具能够与各类数据库无缝对接。

<strong>三、连接管理</strong>

- 在连接管理方面，工具支持用户配置 JDBC URL，通过简单的设置即可连接到目标数据库。
- 表结构导出：一键导出当前数据库中的所有表结构信息，便于用户进行查看和分析。
- 表信息查看：展示数据库中的所有表基本信息。
- 表结构查看：清晰展示当前数据库中的所有表结构信息，方便用户快速定位所需表结构。
- DDL查看与切换：支持查看所有表的 DDL语句，并且用户可以根据需要轻松切换DDL的数据库方言，在不同数据库之间的迁移和转换提供了极大的便利。

<strong>四、RuoYi原始功能</strong>

- 基于RuoYi平台，不定期同步RuoYi的代码

## 演示图

<ul>
  <li>
    <strong>DDL转换DDL</strong>
    <br>
    <img src="doc/img/DDL转换@01.png" alt="DDL转换@01">
  </li>
  <li>
    <strong>DDL转换，切换数据库方言</strong>
    <br>
    <img src="doc/img/DDL转换@02.png" alt="DDL转换@02">
  </li>
  <li>
    <strong>DDL转换表结构</strong>
    <br>
    <img src="doc/img/DDL转换@03.png" alt="DDL转换@03">
  </li>

  <li>
    <strong>驱动列表</strong>
    <br>
    <img src="doc/img/驱动管理@01.png" alt="驱动管理@01">
  </li>
  <li>
    <strong>添加驱动</strong>
    <br>
    <img src="doc/img/驱动管理@02.png" alt="驱动管理@02">
  </li>

  <li>
    <strong>连接配置列表</strong>
    <br>
    <img src="doc/img/连接配置@01.png" alt="连接配置@01">
  </li>
  <li>
    <strong>连接配置-导出表结构</strong>
    <br>
    <img src="doc/img/连接配置@02.png" alt="连接配置@02">
    <br>
    <img src="doc/img/连接配置@03.png" alt="连接配置@03">
    <br>
    <img src="doc/img/连接配置@04.png" alt="连接配置@04">
  </li>
  <li>
    <strong>连接配置-查看详情-基本列表</strong>
    <br>
    <img src="doc/img/连接配置@05.png" alt="连接配置@05">
  </li>
  <li>
    <strong>连接配置-查看详情-表结构信息</strong>
    <br>
    <img src="doc/img/连接配置@06.png" alt="连接配置@06">
  </li>
  <li>
    <strong>连接配置-查看详情-查看DDL语句</strong>
    <br>
    <img src="doc/img/连接配置@07.png" alt="连接配置@07">
  </li>

</ul>

## 实现原理

- 动态加载 ClassLoader，实现动态装卸 jdbc 驱动
- 基于 [Hutool](https://gitee.com/dromara/hutool)，间接操作jdbc驱动读取表信息
- 基于 [jdialects](https://gitee.com/drinkjava2/jdialects) 根据表结构信息生成DDL语句
- 基于 [jsqlparser](https://github.com/JSQLParser/JSqlParser.git) 逆向把DDL语句解析表结构信息
- 前端 [Univer](https://gitee.com/dream-num/univer) 用户在线渲染 sheet 表，渲染表结构信息
- 前端 [codemirror](http://github.com/marijnh/CodeMirror.git) 文本编辑器，渲染DDL语句
- 前端 [sqltools](https://github.com/mtxr/vscode-sqltools) 格式化SQL
- 前端 [xe-utils](https://gitee.com/x-extends/xe-utils) 函数库、工具类

## 迁移指引

- 迁移 jdbc-lib 目录，及驱动文件，目录对应 RdbmsConstants.LIB_PATH
- 后端迁移全部 ruoyi-schemax 模块，以及 ruoyi-common 下的 RedisCache
- 数据库 sql/rdbms_20250205.sql，该脚本建表以及初始化数据
- 前端迁移 api/rdbms 和 views/rdbms 目录下全部文件
- 前端补充 @sqltools/formatter、@univerjs/* 、vue-codemirror 和 xe-utils 这些三方库
- 前端 vue.config.js 的 plugins 配置补充 UniverPlugin

<!--  ## 捐献支持 -->
<!--  <img src="ruoyi-ui/src/assets/images/pay.png" width="50%" alt="捐献支持"> -->
<!--  <p>你可以请作者喝杯咖啡表示鼓励</p> -->