数据库文档导出工具screw 使用说明

原创

已于 2025-07-24 10:16:55 修改 · 498 阅读

5 ·

CC 4.0 BY-SA版权

文章标签：

#数据库

于 2025-07-24 10:12:50 首次发布

Screw 数据库文档导出工具使用指南

Screw（螺丝钉）是一款简洁好用的数据库表结构文档生成工具，支持多种格式输出，可以通过Java代码或Maven插件方式使用。

一、基本介绍

主要特性

支持MySQL、Oracle、PostgreSQL、SQL Server等常见数据库
支持多种输出格式：HTML、Word、Markdown、PDF
零外部依赖，纯Java实现
可通过代码或Maven插件方式调用

核心依赖

<dependency>
    <groupId>cn.smallbun.screw</groupId>
    <artifactId>screw-core</artifactId>
    <version>1.0.5</version> <!-- 使用最新版本 -->
</dependency>

二、代码方式使用

1. 基本配置示例

import cn.smallbun.screw.core.Configuration;
import cn.smallbun.screw.core.engine.EngineConfig;
import cn.smallbun.screw.core.engine.EngineFileType;
import cn.smallbun.screw.core.engine.EngineTemplateType;
import cn.smallbun.screw.core.execute.DocumentationExecute;
import cn.smallbun.screw.core.process.ProcessConfig;
import com.zaxxer.hikari.HikariConfig;
import com.zaxxer.hikari.HikariDataSource;

import javax.sql.DataSource;
import java.util.ArrayList;

public class ScrewExample {
   
   
    public static void main(String[] args) {
   
   
        // 数据源配置
        HikariConfig hikariConfig = new HikariConfig();
        hikariConfig.setDriverClassName("com.mysql.cj.jdbc.Driver");
        hikariConfig.setJdbcUrl("jdbc:mysql://127.0.0.1:3306/your_database");
        hikariConfig.setUsername("username");
        hikariConfig.setPassword