SchemaSpy处理MariaDB Oracle包时的输出问题解析

问题背景

在使用SchemaSpy工具分析MariaDB数据库时，当数据库包含Oracle风格的包(Package)定义时，SchemaSpy的输出结果存在一个显著问题：它只会生成包定义(PACKAGE)或包体(PACKAGE BODY)中的一种，而不会同时输出两者。这导致数据库文档不完整，影响开发人员对数据库结构的全面理解。

问题根源分析

经过深入调查，发现问题的核心在于SchemaSpy生成输出文件时的命名机制：

1. 文件名冲突：SchemaSpy使用包名作为输出文件名，而Oracle包在MariaDB中会创建两个独立的数据库对象（包定义和包体），它们共享相同的名称但类型不同。

2. 查询机制限制：当前SchemaSpy对MariaDB的处理继承自MySQL的实现，而MariaDB虽然最初是MySQL的替代品，但已发展出许多特有的功能，如Oracle包支持。

3. 元数据查询不完整：默认的SQL查询未能区分包定义和包体这两种不同类型的对象，导致SchemaSpy无法正确处理这两种对象。

解决方案

通过修改SchemaSpy的配置文件可以解决此问题：

1. 修改mariadb.properties文件：位于resources/org/schemaspy/types目录下

2. 关键修改内容：在selectRoutinesSql配置项中，对包定义和包体进行区分处理，通过添加类型后缀使它们成为不同的实体：

select if(routine_type LIKE 'PACKAGE%',
          concat(routine_name,'_',replace(lower(routine_type),' ','_')),
          routine_name) as routine_name,
       routine_type, dtd_identifier, routine_body, routine_definition,
       is_deterministic LIKE 'Yes' as is_deterministic,
       sql_data_access, security_type, sql_mode, routine_comment
from information_schema.routines
where routine_schema=:schema

3. 修改效果：此修改会在包名后添加"_package"或"_package_body"后缀，确保包定义和包体生成不同的输出文件，从而完整展示数据库结构。

技术实现细节

1. 条件判断：使用if函数判断对象是否为包类型(routine_type LIKE 'PACKAGE%')

2. 名称构造：对于包类型对象，将原始名称与处理后的类型名称连接起来

   • 使用replace函数将类型中的空格替换为下划线
   • 使用lower函数将类型转换为小写

3. 信息保留：查询保留了所有必要的元数据信息，包括定义内容、确定性标志、访问类型等

应用场景

此解决方案特别适用于以下情况：

1. 从Oracle迁移到MariaDB的数据库系统
2. 在MariaDB中使用Oracle兼容特性的项目
3. 需要完整文档化包含包的数据库结构的场景

注意事项

1. 修改前应备份原始配置文件
2. 此修改仅影响新生成的文档，不影响已有文档
3. 对于已存在的文档，需要重新运行SchemaSpy以获取完整输出

总结

通过这一简单的配置修改，SchemaSpy能够完整展示MariaDB中的Oracle包结构，为开发团队提供更全面的数据库文档。这一解决方案不仅解决了当前问题，也为处理其他类似特性的数据库对象提供了参考思路。