MySQL导出数据库⽂档到word
最近部门订单业务调整，收拢其他业务线的下单⼊⼝，做个统⼀⼤订单平台。需要梳理各业务线的数据表，但每个业务线库都有近百张和订单相关的表，挨个表⼀个⼀个字段的弄脑⽠⼦嗡嗡的。
为了不重复 CV 操作，抱着⼀丝希望开始在GitHub⾥，看看有没有什么⼯具可以⽤，结果就真的发现了宝藏，screw（螺丝钉），居然可以⽣成数据库⽂档，优秀啊~。
数据库⽀持
MySQL
MariaDB
TIDB
Oracle
SqlServer
PostgreSQL
Cache DB
配置
1、pom⽂件
引⼊screw核⼼包，HikariCP数据库连接池，HikariCP号称性能最出⾊的数据库连接池。
2、配置数据源
配置数据源，设置 useInformationSchema 可以获取tables注释信息。
spring.datasource.url=jdbc:mysql://45.93.1.5:3306/fire?useUnicode=true&characterEncoding=UTF-8&useSSL=false spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.sql.cj.jdbc.Driver
spring.datasource.xa.properties.useInformationSchema=true
3、screw 核⼼配置
screw有两种执⾏⽅式，第⼀种是pom⽂件配置，另⼀种是代码执⾏。
配置完以后在 maven project->screw 双击执⾏ok。
代码⽣成⽅式也⾮常简单。
@SpringBootTest
public class ScrewApplicationTests {
@Autowired
ApplicationContext applicationContext;
@Test
void contextLoads() {
DataSource dataSourceMysql = Bean(DataSource.class);    // ⽣成⽂件配置
EngineConfig engineConfig = EngineConfig.builder()
// ⽣成⽂件路径，⾃⼰mac本地的地址，这⾥需要⾃⼰更换下路径
.fileOutputDir("D:/")
// 打开⽬录
.openOutputDir(false)
// ⽂件类型
.fileType(EngineFileType.HTML)
// ⽣成模板实现
.produceType(EngineTemplateType.freemarker).build();
// ⽣成⽂档配置（包含以下⾃定义版本号、描述等配置连接）
Configuration config = Configuration.builder()
.
version("1.0.3")
.description("⽣成⽂档信息描述")
.dataSource(dataSourceMysql)
.engineConfig(engineConfig)
mysql下载add produce.produceConfig(getProcessConfig())
.build();
// 执⾏⽣成
new DocumentationExecute(config).execute();
}
/**
* 配置想要⽣成的表+ 配置想要忽略的表
*
* @return ⽣成表配置
*/
public static ProcessConfig getProcessConfig() {
// 忽略表名
List<String> ignoreTableName = Arrays.asList("a", "test_group");
// 忽略表前缀，如忽略a开头的数据库表
List<String> ignorePrefix = Arrays.asList("a", "t");
// 忽略表后缀
List<String> ignoreSuffix = Arrays.asList("_test", "czb_");
return ProcessConfig.builder()
/
/根据名称指定表⽣成
.designatedTableName(Arrays.asList("fire_user"))
//根据表前缀⽣成
.designatedTablePrefix(new ArrayList<>())
//根据表后缀⽣成
.designatedTableSuffix(new ArrayList<>())
//忽略表名
.ignoreTableName(ignoreTableName)
//忽略表前缀
.ignoreTablePrefix(ignorePrefix)
//忽略表后缀
.
ignoreTableSuffix(ignoreSuffix).build();
}
}
4、⽂档格式
screw 有 HTML、DOC、MD 三种格式的⽂档。
代码中的修改
.fileType(EngineFileType.HTML)
或者pom⽂件
MD
DOC⽂档样式HTML⽂档样式MD⽂档样式

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。