Report

针对数据库中，已经形成良好的注释，可以反向工程形成数据库结构说明。 思路如下，配置如下的report.xml

<?xml version="1.0" encoding="utf-8"?>
<report title="数据库设计说明">
  <system name="权限系统" version="1.0.0"/>
  <db>
    <dialect>org.beangle.data.jdbc.dialect.OracleDialect
    </dialect>
    <driver>oracle.jdbc.driver.OracleDriver</driver>
    <url>jdbc:oracle:thin:@localhost:1521:orcl</url>
    <user>user</user>
    <password>passwd</password>
    <props>
      <prop name="remarksReporting" value="true" />
    </props>
  </db>
  <pages template="singlehtml">
    <page name="index" />
  </pages>

  <modules>
    <module name="security" title="权限管理" tables="se_*">
      <image name="security_user" title="权限管理-用户管理"    tables="se_users,se_members,se_roles">
        用户和角色关系中存在管理、授权和成员关系
      </image>
      <image name="security_func" title="权限管理-功能权限" tables="se_func_resources,se_func_permissions" />
      <image name="security_data" title="权限管理-数据权限" tables="se_data_fields,se_data_permissions,se_data_resources,se_data_types" />
      <image name="security_menu" title="权限管理-菜单维护" tables="se_menus,se_menus_resources,se_menu_profiles" />
      <image name="security_menu" title="权限管理-会话监控" tables="se_session_profiles,se_session_stats" />
      <module name="user_group" title="权限管理-用户、组" tables="se_users,se_members,se_roles" />
      <module name="data" title="权限管理-数据级权限" tables="se_data_*" />
      <module name="func" title="权限管理-功能权限" tables="se_func_*" />
      <module name="menu" title="权限管理-菜单" tables="se_menu*" />
      <module name="misc" title="权限管理-其他" tables="se_*" />
    </module>

    <module name="misc" title="其他" tables="*"/>
  </modules>
</report>

运行java -cp lib/* org.beangle.db.report.Reporter report.xml 即可生成jekyll形式的数据库wiki