1. 概述
1.1 版本
| 信创版帆软产品版本 | 功能变动 |
|---|---|
FineReport11.0.9 FineBI6.0.4 FineDataLink4.0.19 | 支持外接数据库类型：OceanBase MySQL模式 |
FineReport11.0.13 FineBI6.0.8 FineDataLink4.0.20 | 新增支持外接数据库类型：OceanBase Oracle模式 |
FineReport11.0.17 FineBI6.0.12 FineDataLink4.0.26 | OceanBase 外接数据库功能以插件形式提供 |
| FineReport11.5.8 | 对于OceanBase MySQL模式数据库，支持使用 utf8mb4 字符集 |
1.2 功能简介
FineReport、FineBI、FineDataLink系统配置外接数据库后，遇到集群环境或数据量较大情况时，可保证系统的稳定性。
用户可配置 OceanBase 类型的外接数据库。
注：若配置了外接数据库，请勿轻易修改外接数据库的用户名和密码，否则会导致工程启动失败。
如需修改，请参照：修改外接数据库账号密码 。
2. 准备配置库
用户需要自行准备并部署 OceanBase 数据库和表空间。
帆软不提供相关资料和指导，仅对必要内容进行指明，请查阅数据库官网获取其他帮助。
2.1 数据库版本
本文列出的是帆软测试通过的环境。
本文提及的配置库，仅适用于信创版本帆软产品
本文未提及的更低版本，一般默认不支持，或存在一些漏洞，不建议使用
本文未提及的更高版本，用户可自行测试验证。如果出现问题，付费用户可联系技术支持获取帮助。技术支持联系方式：「服务平台>在线支持」
| 数据库类型 | 信创版帆软产品最低支持版本 | 数据库版本 |
|---|---|---|
| OceanBase MySQL模式 | FineReport11.0.9 FineBI6.0.4 FineDataLink4.0.19 | V3.2.3 |
| OceanBase Oracle模式 | FineReport11.0.13 FineBI6.0.8 FineDataLink4.0.20 | V2.3.0 |
2.2 服务器配置
| 配置类型 | 最低配置 | 推荐配置 | 注意事项 |
|---|---|---|---|
| 内存 | 1GB | 2GB | 内存，是指分配给配置库的内存，而非服务器的所有内存 如有条件，建议配置库独占一台服务器 如条件不足，至少确保部署配置库的服务器中，不部署帆软应用以外的任何内容，且确保分配给配置库的内存足够 |
| CPU | 4核 | 8核 | - |
| 网速 | 50Mbps | 100Mbps | 配置库和应用工程、其他组件建议在同一网段，避免网络波动等问题 配置库和应用工程、其他组件之间需要网络畅通，互相端口可访问 |
| finedb占用空间 | 1GB | 2GB | 占用空间，请结合工程使用度进行调整 建议根据推荐配置，增大1~2倍，预留足够空间 |
| 服务器磁盘空间 | 100GB | 200GB | - |
| 服务器磁盘读写速度 | 50MB/S | 100MB/S | - |
2.3 新建表空间
不同帆软工程，不可共用同一个数据库表空间作为配置库，否则数据可能会出现错乱。
因此建议在数据库中新建一个表空间，用于存储相关配置数据。
请注意并准备以下内容：
| 配置 | 说明 |
|---|---|
| 表空间名称 | 推荐使用finedb |
| 数据库用户名 | 自定义 如为Oracle模式数据库，用户名称建议仅包含数字、字母，不建议包含任何特殊字符 |
| 数据库用户密码 | 配置库对接成功后，请勿轻易修改所使用的数据库用户名和密码，否则会导致工程启动失败 如需修改，详情请参见：修改外接数据库账号密码 |
| 数据库用户权限 | 用户需要具备 create、delete、alter、update、select、insert、index 权限 |
| 表空间存储内容 | 该表空间内不建议存放其他任何数据，包括业务数据、日志数据等 |
2.4 配置库其他要求
对于OceanBase MySQL模式 5.X 版本数据库：
1）优先推荐使用 utf8mb3 字符集以获得最佳兼容性
2）对于11.5.8及以上版本的FineReport，支持使用 utf8mb4 字符集，但需确保开启了 innodb_large_prefix = ON
原因说明：utf8mb4 单字符占 4字节，索引长度可能超限，而 innodb_large_prefix 开启后允许使用更长的索引前缀长度。不开启该参数可能导致表索引创建失败，继而引发工程异常。
配置方法：请参考 OceanBase 官方文档，帆软不提供配置指导。
3. 对接准备
3.1 安装插件
FineReport11.0.17 及之后的信创版本，OceanBase 外接库依赖插件：oceanbase 外置数据库
获取插件：联系对接的销售人员
设计器插件安装方法参照 设计器插件管理
服务器安装插件方法参照 服务器插件管理
3.2 注册插件
若工程未正式注册，安装插件即可试用插件全功能。
若工程已正式注册，需要联系帆软销售增购OceanBase外接数据库功能点。
帆软会提供 90 天的免费试用，用户可在试用期内进行功能测试和试用。
试用到期后，未注册OceanBase外接数据库功能点的工程使用受到限制，详情请参见：外接数据库注册 。
3.3 检查工程启动用户权限
请确保启动帆软应用的服务器用户，有帆软应用工程文件的读写权限，否则无法正确对接配置库。
3.4 准备配置库信息
请准备好表空间的相关信息，用于接入项目作为配置库。
| 设置项 | OceanBase MySQL模式 | OceanBase Oracle模式 |
|---|---|---|
| 数据库类型 | OceanBase | OceanBase |
| 版本 | MySQL版 | Oracle版 |
| 驱动 | 无需手动修改，使用默认值 | |
| 数据库名称 | 填写2.3节新建的表空间的名称 只允许包含数字、字母、下划线、「-」和「.」 | |
| 主机/端口 | 填写2.3节配置库所在服务器的IP和端口 | |
| 用户名/密码 | 数据库占用的服务器端口 | |
| 用户名 | 填写2.3节准备的数据库用户名称和密码 用户需要具备 create、delete、alter、update、select、insert、index 权限 | |
| 模式 | - | 一般无需手动输入，在配置外接库时，正确填写完上面几项设置后，点击模式下拉框中的「点击连接数据库」，系统将自动连接该数据库并读取所有模式，选择与用户名相同的即可
|
4. 配置外接数据库
在帆软应用的「管理系统>管理系统>常规」中，可接入自备的数据库作为配置库。
注：请确保启动帆软应用的用户，有工程文件的读写权限，否则无法正确接入。
4.1 确保单应用存活（多应用服务工程须完成，单应用服务工程无需）
对于多应用项目，需要确保接入/迁移配置服务时仅存活一个应用节点。
管理员登录运维平台，选中指定项目。点击「维护>组件管理」。检查是否有多个「bi-web」容器存活。
如果有，请点击容器的「停止」按钮，确保将其他「bi-web」容器关停至「exited」状态，仅保留一个容器存活。
注：如为非运维平台部署的项目，请参考「 关闭或重启FineBI工程」文档，关闭集群下的其他「bi/fr/fdl」应用，仅保留单个应用存活。
4.2 配置外接配置库
1）管理员登录帆软应用，点击「管理系统>管理系统>常规」。找到「外接数据库」，点击配置。
2）输入相关信息
填写3.4节准备的配置库信息即可
数据连接URL：一般无需手动修改，会由其他配置和预设参数共同组成
3）选择是否「迁移数据至要启用的数据库」
| 情况 | 新配置库情况 |
|---|---|
| 希望使用当前项目原有配置 | 1）必须勾选「迁移数据至要启用的数据库」 2）项目与该配置库对接成功后，会将工程原有配置数据，迁移到该表空间中 3）无论准备的新表空间中是否有数据，均会被清空，无法找回 |
希望使用其他项目配置 （例如将正式环境配置，拷贝一份给测试环境使用） | 1）自行将准备的配置数据上传到新表空间中 必须确保所准备的数据，对应的项目 JAR 包版本和当前项目的 JAR 包版本完全一致，否则无法使用 2）不勾选「迁移数据至要启用的数据库」 3）项目与该配置库对接成功后，会使用表空间中的数据，作为项目的配置 4）项目原有配置的对接信息，会备份到工程config目录下的db.properties.bak文件中 |
4）点击「启用数据库」，提示「迁移成功」，即代表可正常对接。
4.3 确保多应用配置同步（多应用服务工程须完成，单应用服务工程无需）
1）拷贝db.properties文件
前往唯一存活的「bi-web/fr/fdl」容器所在服务器，复制该组件外挂目录/config文件夹中的db.properties文件。
逐一粘贴到其他「bi-web/fr/fdl」容器所在服务器的组件外挂目录/config文件夹中。
注：如为非运维平台部署的项目，请将唯一存活的「bi/fr/fdl」应用目录/webroot/WEB-INF/embed文件夹中的db.properties文件，逐一拷贝到其他「bi/fr/fdl」应用目录/webroot/WEB-INF/embed文件夹中
2）停止所有应用
管理员登录运维平台，选中指定项目，点击「维护>组件管理」
请对「bi-web/fr/fdl」组件进行一键「停止」，确保所有「bi-web/fr/fdl」容器关停至「exited」状态。
注：如为非运维平台部署的项目，请参考「 关闭或重启FineBI工程」文档，关闭剩余唯一存活的「bi/fr/fdl」应用。
3）启动所有应用
管理员登录运维平台，选中指定项目，点击「维护>组件管理」。
请对「bi-web/fr/fdl」组件进行一键「启动」，确保所有「bi-web/fr/fdl」容器启动至「running」状态。
注：如为非运维平台部署的项目，请参考「 关闭或重启FineBI工程」文档，逐一重启集群下的所有「bi/fr/fdl」应用。
上一篇：对接腾讯云TDSQL作为外接配置库
