SchemaSpy 高级使用指南：从连接配置到自定义数据库类型-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00541/article/details/148578191

SchemaSpy 高级使用指南：从连接配置到自定义数据库类型

schemaspy Database documentation built easy 项目地址: https://gitcode.com/gh_mirrors/sc/schemaspy

连接属性配置详解

在使用SchemaSpy连接MySQL等数据库时，可能会遇到SSL连接相关的警告信息。这是因为新版MySQL默认要求建立SSL连接。要解决这个问题，可以通过添加连接属性来明确指定SSL使用方式。

添加连接属性的方法

命令行直接指定：
```
-connprops useSSL\=false
```
属性文件指定：也可以将连接属性保存在属性文件中，然后通过-connprops参数引用该文件。

特殊字符处理规则

等号(=)需要使用反斜杠()转义
斜杠(/)也需要用反斜杠转义
多个属性对之间用分号(;)分隔
在Linux shell或Windows的Git Bash中，反斜杠本身也需要转义

自定义数据库类型实战

SchemaSpy允许用户创建自定义的数据库类型配置，这对于特殊连接需求或特定数据库特性非常有用。

基础自定义示例：禁用SSL的MySQL类型

创建配置文件mysql-nossl.properties

添加以下内容：

extends=mysql
connectionSpec=jdbc:mysql://<hostOptionalPort>/<db>?useSSL=false

使用时指定-t mysql-nossl

高级自定义：覆盖SQL查询

创建新配置文件myDbType.properties

继承基础类型并覆盖特定SQL：

extends=pgsql
selectRoutinesSql=自定义SQL查询语句
viewTypes=VIEW,MATERIALIZED VIEW

超高级技巧：通过Unix Socket连接MySQL

对于特殊连接需求，如通过Unix Socket连接MySQL，可以这样配置：

准备驱动库：
- 下载所需的Unix Socket库及其依赖
- 将所有JAR文件放在drivers子目录中

创建自定义类型：

connectionSpec=jdbc:mysql://<host>/<db>?socketFactory=<socketFactory>&socket=<socket>
socketFactory=org.newsclub.net.mysql.AFUNIXDatabaseSocketFactory
socket=/path/to/socket

运行命令示例：

java -jar schemaspy.jar -t my-mysql-socket \
-dp lib/mysql-connector-java-version.jar \
-loadjars \
-db DBName \
-host localhost \
-port 3306 \
-u User \
-socketFactory org.newsclub.net.mysql.AFUNIXDatabaseSocketFactory \
-socket /path/to/socket \
-o outputDir

使用Markdown增强文档注释

SchemaSpy支持在数据库注释中使用Markdown语法，这为文档添加了丰富的格式化能力。

通过元数据文件添加注释

创建XML元数据文件：

<schemaMeta>
  <comments>数据库级注释</comments>
  <tables>
    <table name="ACCOUNT" comments="表级Markdown注释">
      <column name="accountId" comments="列级Markdown注释" />
    </table>
  </tables>
</schemaMeta>