Skip to main content

Quick Start

This guide walks you through a minimal setup of the recommended RedoMiner connector.

Prerequisites​

  • Apache Kafka cluster with Kafka Connect
  • Oracle Database (9i through 26ai)
  • Network access from Kafka Connect to Oracle Database (JDBC) and redo log files (SSH/ASM/SMB/BFILE)

Step 1: Install oracdc​

Choose one of the installation methods. For Docker:

docker pull a2solutions/oracdc

Step 2: Enable Supplemental Logging​

Connect to Oracle as SYSDBA and enable minimal supplemental logging:

ALTER DATABASE ADD SUPPLEMENTAL LOG DATA;

For tables you want to replicate, add supplemental logging:

ALTER TABLE <OWNER>.<TABLE_NAME> ADD SUPPLEMENTAL LOG DATA (ALL) COLUMNS;

Step 3: Check Database Settings​

Use the built-in setup check utility:

java -cp oracdc-kafka-standalone.jar \
    solutions.a2.cdc.oracle.utils.OracleSetupCheck \
    --jdbc-url <ORA-JDBC-URL> \
    --user <ACCOUNT> \
    --password <PASSWORD>

Or in Docker:

docker run --rm -it a2solutions/oracdc oraCheck.sh \
    --jdbc-url <ORA-JDBC-URL> \
    --user <ACCOUNT> \
    --password <PASSWORD>

A successful check prints:

=====================
The oracdc's setup check was completed successfully,
everything is ready to start oracdc connector
=====================

Step 4: Configure the Connector​

Create a connector configuration. This example uses SSH to read redo logs from a remote server:

name=oracdc-redominer
connector.class=solutions.a2.cdc.oracle.OraCdcRedoMinerConnector

# Oracle JDBC connection
a2.jdbc.url=jdbc:oracle:thin:@//dbhost:1521/ORCL
a2.jdbc.username=ORACDC_USER
a2.jdbc.password=ORACDC_PASSWORD

# Redo log access via SSH
a2.storage.media=SSH
a2.ssh.hostname=dbhost
a2.ssh.user=oracle
a2.ssh.private.key=/path/to/private_key

# Tables to capture
a2.include=SCOTT.%

# Topic configuration
a2.topic.name.style=SCHEMA_TABLE
a2.topic.name.delimiter=.

Step 5: Deploy the Connector​

Submit the configuration to Kafka Connect:

curl -X POST http://localhost:8083/connectors \
  -H "Content-Type: application/json" \
  -d @connector-config.json

Next Steps​