Skip to content

Commit 2902f50

Browse files
author
Cary Huang
committed
update
1 parent 2b0eae3 commit 2902f50

File tree

3 files changed

+137
-1
lines changed

3 files changed

+137
-1
lines changed

docs/en/user-guide/configure_olr.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Configure Openlog Replicator for Oracle
2+
3+
## **Overview**
4+
5+
In addition to LogMiner-based replication, **SynchDB** supports **Openlog Replicator (OLR)** as a data source for Oracle connectors. This integration enables low-latency, redo log–based change data capture from Oracle databases via a standalone replication server.
6+
7+
This guide details the configuration steps necessary to associate an Oracle connector with an OLR endpoint using `synchdb_add_olr_conninfo()` and `synchdb_del_olr_conninfo()`.
8+
9+
## **Requirements**
10+
11+
- **Openlog Replicator Version**: `1.3.0` (verified compatibility for Debezium 2.7.x)
12+
- Oracle instance with redo logs accessible to OLR
13+
- Openlog Replicator must be configured and running
14+
- An existing Oracle connector in SynchDB (created using `synchdb_add_conninfo()`)
15+
16+
Refer to this [external guide](https://highgo.atlassian.net/wiki/external/OTUzY2Q2OWFkNzUzNGVkM2EyZGIyMDE1YzVhMDdkNWE) for details on deploying Openlog Replicator via Docker.
17+
18+
19+
## **`synchdb_add_olr_conninfo()`**
20+
21+
Registers an Openlog Replicator endpoint for an existing Oracle connector.
22+
23+
**Signature:**
24+
25+
```sql
26+
synchdb_add_olr_conninfo(
27+
conn_name TEXT, -- Name of the connector
28+
olr_host TEXT, -- Hostname or IP of the OLR instance
29+
olr_port INT, -- Port number exposed by OLR (typically 7070)
30+
olr_source TEXT -- Oracle source name as configured in OLR
31+
)
32+
```
33+
34+
**Example:**
35+
36+
This instructs SynchDB to stream changes for the connector `oracleconn` from the Openlog Replicator instance running at 10.55.13.17:7070, using the Oracle source identifier ORACLE. Call `synchdb_start_engine_bgw` to start this connector.
37+
38+
```sql
39+
SELECT synchdb_add_olr_conninfo('oracleconn', '10.55.13.17', 7070, 'ORACLE');
40+
41+
```
42+
43+
## **synchdb_del_olr_conninfo**
44+
45+
Removes the OLR configuration for a specific connector, reverting it to use LogMiner.
46+
47+
**Signature:**
48+
49+
```sql
50+
synchdb_del_olr_conninfo(conn_name TEXT)
51+
52+
```
53+
54+
**Example:**
55+
56+
This command disables the use of OLR for oracleconn. Starting the connector with `synchdb_start_engine_bgw` will fall back to the default logmining strategy.
57+
58+
```sql
59+
SELECT synchdb_del_olr_conninfo('oracleconn');
60+
61+
```
62+
63+
## **Behavior Notes**
64+
65+
* When both LogMiner and OLR configurations exist, SynchDB defaults to using Openlog Replicator for change capture.
66+
* Restarting the connector is required after modifying its OLR configuration.
67+
* The Oracle instance and OLR must remain synchronized in SCN progression and resetlogs identity for consistency.

docs/zh/user-guide/configure_olr.md

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# 为 Oracle 配置 Openlog Replicator
2+
3+
## **概述**
4+
5+
除了基于 LogMiner 的复制功能外,**SynchDB** 还支持将 **Openlog Replicator (OLR)** 作为 Oracle 连接器的数据源。此集成功能支持通过独立的复制服务器从 Oracle 数据库捕获低延迟、基于重做日志的变更数据。
6+
7+
本指南详细介绍了使用 `synchdb_add_olr_conninfo()``synchdb_del_olr_conninfo()` 将 Oracle 连接器与 OLR 端点关联的配置步骤。
8+
9+
## **要求**
10+
11+
- **Openlog Replicator 版本**`1.3.0`(已验证与 Debezium 2.7.x 的兼容性)
12+
- 具有可供 OLR 访问的重做日志的 Oracle 实例
13+
- Openlog Replicator 必须已配置并正在运行
14+
- SynchDB 中现有的 Oracle 连接器(使用 `synchdb_add_conninfo()` 创建)
15+
16+
有关通过 Docker 部署 Openlog Replicator 的详细信息,请参阅此[外部指南](https://highgo.atlassian.net/wiki/external/OTUzY2Q2OWFkNzUzNGVkM2EyZGIyMDE1YzVhMDdkNWE)
17+
18+
## **`synchdb_add_olr_conninfo()`**
19+
20+
为现有的 Oracle 连接器注册 Openlog Replicator 端点。
21+
22+
**签名:**
23+
24+
```sql
25+
synchdb_add_olr_conninfo(
26+
conn_name TEXT, -- 连接器名称
27+
olr_host TEXT, -- OLR 实例的主机名或 IP
28+
olr_port INT, -- OLR 公开的端口号(通常为 7070)
29+
olr_source TEXT -- OLR 中配置的 Oracle 源名称
30+
)
31+
```
32+
33+
**示例:**
34+
35+
这将指示 SynchDB 使用 Oracle 源标识符 ORACLE,从运行于 10.55.13.17:7070 的 Openlog Replicator 实例流式传输连接器 `oracleconn` 的变更。调用 `synchdb_start_engine_bgw` 启动此连接器。
36+
37+
```sql
38+
SELECT synchdb_add_olr_conninfo('oracleconn', '10.55.13.17', 7070, 'ORACLE');
39+
40+
```
41+
42+
## **synchdb_del_olr_conninfo**
43+
44+
删除特定连接器的 OLR 配置,将其恢复为使用 LogMiner。
45+
46+
**签名:**
47+
48+
```sql
49+
synchdb_del_olr_conninfo(conn_name TEXT)
50+
51+
```
52+
53+
**示例:**
54+
55+
此命令禁用 oracleconn 使用 OLR。使用 `synchdb_start_engine_bgw` 启动连接器将恢复为默认的日志挖掘策略。
56+
57+
```sql
58+
SELECT synchdb_del_olr_conninfo('oracleconn');
59+
60+
```
61+
62+
## **行为说明**
63+
64+
* 当 LogMiner 和 OLR 配置同时存在时,SynchDB 默认使用 Openlog Replicator 进行更改捕获。
65+
* 修改连接器的 OLR 配置后,需要重新启动连接器。
66+
* Oracle 实例和 OLR 必须在 SCN 进程和 resetlogs 标识方面保持同步,以保持一致性。

mkdocs.yml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ plugins:
8484
JVM Memory Usage: Uso de memoria de JVM
8585
Attribute View: Vista de atributos
8686
JMX Exporter Settings: Configuración del exportador JMX
87+
Configure Openlog Replicator for Oracle Connector: Configurar Openlog Replicator para Oracle Connector
8788
- locale: zh
8889
name: 中文
8990
site_name: SynchDB 文档
@@ -126,7 +127,8 @@ plugins:
126127
JMX Monitor Settings: JMX 监视器设置
127128
JVM Memory Usage: JVM内存使用情况
128129
Attribute View: 属性视图
129-
JMX Exporter Settings: JMX exporter 设置:
130+
JMX Exporter Settings: JMX exporter 设置
131+
Configure Openlog Replicator for Oracle Connector: 为 Oracle Connector 配置 Openlog Replicator
130132
- mike:
131133
version_selector: true
132134
css_dir: css
@@ -179,6 +181,7 @@ nav:
179181
- Secured Connection: user-guide/secured_connection.md
180182
- Configure Error Strategies: user-guide/configure_error_strategies.md
181183
- Configure Replication Offset: user-guide/set_offset.md
184+
- Configure Openlog Replicator for Oracle Connector: user-guide/configure_olr.md
182185
# - Utility Functions: user-guide/utility_functions.md
183186
- Changelog: changelog.md
184187
# - Homepage: https://www.synchdb.com

0 commit comments

Comments
 (0)