|
| 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. |
0 commit comments