This is an automated email from the ASF dual-hosted git repository.
liuyu pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 73bf69e Documentation for Oracle Debezium connector (#12213)
73bf69e is described below
commit 73bf69ee60804424d65a006eaa51cf9e56a85f82
Author: Andrey Yegorov <[email protected]>
AuthorDate: Tue Sep 28 17:42:23 2021 -0700
Documentation for Oracle Debezium connector (#12213)
* Documentation for Oracle Debezium connector
* Update site2/docs/io-debezium-source.md
Co-authored-by: Michael Marshall <[email protected]>
* Apply suggestions from code review
CR feedback
Co-authored-by: Anonymitaet <[email protected]>
* CR feedback
Co-authored-by: Michael Marshall <[email protected]>
Co-authored-by: Anonymitaet <[email protected]>
---
site2/docs/io-connectors.md | 8 +++++
site2/docs/io-debezium-source.md | 78 ++++++++++++++++++++++++++++++++++++++++
2 files changed, 86 insertions(+)
diff --git a/site2/docs/io-connectors.md b/site2/docs/io-connectors.md
index 238b20c..3a6b557 100644
--- a/site2/docs/io-connectors.md
+++ b/site2/docs/io-connectors.md
@@ -45,6 +45,14 @@ Pulsar has various source connectors, which are sorted
alphabetically as below.
* [Java
class](https://github.com/apache/pulsar/blob/master/pulsar-io/debezium/mongodb/src/main/java/org/apache/pulsar/io/debezium/mongodb/DebeziumMongoDbSource.java)
+### Debezium Oracle
+
+* [Configuration](io-debezium-source.md#configuration)
+
+* [Example](io-debezium-source.md#example-of-oracle)
+
+* [Java
class](https://github.com/apache/pulsar/blob/master/pulsar-io/debezium/oracle/src/main/java/org/apache/pulsar/io/debezium/oracle/DebeziumOracleSource.java)
+
### DynamoDB
* [Configuration](io-dynamodb-source.md#configuration)
diff --git a/site2/docs/io-debezium-source.md b/site2/docs/io-debezium-source.md
index 632a59e..4683f6e 100644
--- a/site2/docs/io-debezium-source.md
+++ b/site2/docs/io-debezium-source.md
@@ -458,6 +458,84 @@ This example shows how to change the data of a MongoDB
table using the Pulsar De
{"schema":{"type":"struct","fields":[{"type":"string","optional":false,"field":"id"}],"optional":false,"name":"dbserver1.inventory.products.Key"},"payload":{"id":"104"}},
value =
{"schema":{"type":"struct","fields":[{"type":"string","optional":true,"name":"io.debezium.data.Json","version":1,"field":"after"},{"type":"string","optional":true,"name":"io.debezium.data.Json","version":1,"field":"patch"},{"type":"struct","fields":[{"type":"string","optional":false,"field":"version"},{"type
[...]
```
+## Example of Oracle
+
+### Packaging
+
+Oracle connector does not include Oracle JDBC driver and you need to package
it with the connector.
+Major reasons for not including the drivers are the variety of versions and
Oracle licensing. It is recommended to use the driver provided with your Oracle
DB installation, or you can
[download](https://www.oracle.com/database/technologies/appdev/jdbc.html) one.
+Integration test have an
[example](https://github.com/apache/pulsar/blob/e2bc52d40450fa00af258c4432a5b71d50a5c6e0/tests/docker-images/latest-version-image/Dockerfile#L110-L122)
of packaging the driver into the connector nar file.
+
+### Configuration
+
+Debezium
[requires](https://debezium.io/documentation/reference/1.5/connectors/oracle.html#oracle-overview)
Oracle DB with LogMiner or XStream API enabled.
+Supported options and steps for enabling them vary from version to version of
Oracle DB.
+Steps outlined in the
[documentation](https://debezium.io/documentation/reference/1.5/connectors/oracle.html#oracle-overview)
and used in the [integration
test](https://github.com/apache/pulsar/blob/master/tests/integration/src/test/java/org/apache/pulsar/tests/integration/io/sources/debezium/DebeziumOracleDbSourceTester.java)
may or may not work for the version and edition of Oracle DB you are using.
+Please refer to the [documentation for Oracle
DB](https://docs.oracle.com/en/database/oracle/oracle-database/) as needed.
+
+Similarly to other connectors, you can use JSON or YAMl to configure the
connector.
+Using yaml as an example, you can create a debezium-oracle-source-config.yaml
file like:
+
+* JSON
+
+```json
+{
+ "database.hostname": "localhost",
+ "database.port": "1521",
+ "database.user": "dbzuser",
+ "database.password": "dbz",
+ "database.dbname": "XE",
+ "database.server.name": "XE",
+ "schema.exclude.list": "system,dbzuser",
+ "snapshot.mode": "initial",
+ "topic.namespace": "public/default",
+ "task.class": "io.debezium.connector.oracle.OracleConnectorTask",
+ "value.converter": "org.apache.kafka.connect.json.JsonConverter",
+ "key.converter": "org.apache.kafka.connect.json.JsonConverter",
+ "typeClassName": "org.apache.pulsar.common.schema.KeyValue",
+ "database.history": "org.apache.pulsar.io.debezium.PulsarDatabaseHistory",
+ "database.tcpKeepAlive": "true",
+ "decimal.handling.mode": "double",
+ "database.history.pulsar.topic": "debezium-oracle-source-history-topic",
+ "database.history.pulsar.service.url": "pulsar://127.0.0.1:6650"
+}
+```
+* YAML
+
+```yaml
+tenant: "public"
+namespace: "default"
+name: "debezium-oracle-source"
+topicName: "debezium-oracle-topic"
+parallelism: 1
+
+className: "org.apache.pulsar.io.debezium.oracle.DebeziumOracleSource"
+database.dbname: "XE"
+
+configs:
+ database.hostname: "localhost"
+ database.port: "1521"
+ database.user: "dbzuser"
+ database.password: "dbz"
+ database.dbname: "XE"
+ database.server.name: "XE"
+ schema.exclude.list: "system,dbzuser"
+ snapshot.mode: "initial"
+ topic.namespace: "public/default"
+ task.class: "io.debezium.connector.oracle.OracleConnectorTask"
+ value.converter: "org.apache.kafka.connect.json.JsonConverter"
+ key.converter: "org.apache.kafka.connect.json.JsonConverter"
+ typeClassName: "org.apache.pulsar.common.schema.KeyValue"
+ database.history: "org.apache.pulsar.io.debezium.PulsarDatabaseHistory"
+ database.tcpKeepAlive: "true"
+ decimal.handling.mode: "double"
+ database.history.pulsar.topic: "debezium-oracle-source-history-topic"
+ database.history.pulsar.service.url: "pulsar://127.0.0.1:6650"
+```
+
+For the full list of configuration properties supported by Debezium, see
[Debezium Connector for
Oracle](https://debezium.io/documentation/reference/1.5/connectors/oracle.html#oracle-connector-properties).
+
+
## FAQ
### Debezium postgres connector will hang when create snap
