Skip to content
This repository was archived by the owner on Feb 3, 2026. It is now read-only.

Commit 3ea4c5d

Browse files
docs: update debezium mysql server example data (#59)
* update-debezium-mysql-server-example-data * wrong-debezium * add-config-steps * bump-pulsar-version * cleanup * revert-mysql-config * space * passthru * remove-passthru * config-block * Apply suggestions from code review Co-authored-by: brian-f <brian.fisher@datastax.com> --------- Co-authored-by: brian-f <brian.fisher@datastax.com>
1 parent b1c4685 commit 3ea4c5d

3 files changed

Lines changed: 60 additions & 15 deletions

File tree

antora.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ asciidoc:
1818
pulsar: 'Apache Pulsar'
1919
pulsar-short: 'Pulsar'
2020
pulsar-reg: 'Apache Pulsar(TM)'
21-
pulsar-version: '2.10' #DO NOT INCLUDE PATCH VERSION <MAJOR>.<MINOR>.<PATCH>
21+
pulsar-version: '3.1' #DO NOT INCLUDE PATCH VERSION <MAJOR>.<MINOR>.<PATCH>
2222
debezium-version: '1.7'
2323
astra-streaming-examples-repo: 'https://raw.githubusercontent.com/datastax/astra-streaming-examples/master'
2424
kafka-for-astra: 'Starlight for Kafka'
Lines changed: 33 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,38 @@
11
[source,json]
22
----
3-
{
4-
"database.hostname": "localhost",
5-
"database.port": "1433",
6-
"database.user": "sa",
7-
"database.password": "MyP@ssw0rd!",
8-
"database.dbname": "MyTestDB",
9-
"database.server.name": "mssql",
10-
"snapshot.mode": "schema_only",
11-
"topic.namespace": "'$TENANT'/'$NAMESPACE'",
12-
"task.class": "io.debezium.connector.sqlserver.SqlServerConnectorTask",
13-
"value.converter": "org.apache.kafka.connect.json.JsonConverter",
3+
"configs": {
4+
"connector.class": "io.debezium.connector.sqlserver.SqlServerConnector",
5+
"database.dbname": "cdc_test",
6+
"database.history": "org.apache.pulsar.io.debezium.PulsarDatabaseHistory",
7+
"database.history.name": "cdc_test_history",
8+
"database.history.pulsar.service.url": "pulsar+ssl://pulsar-azure-westus2.streaming.datastax.com:6651",
9+
"database.history.pulsar.token": "sensitive_data_removed",
10+
"database.history.pulsar.topic": "dbz-stream672-history-topic",
11+
"database.hostname": "kalash-server-stream672.database.windows.net",
12+
"database.include.list": "cdc_test",
13+
"database.names": "cdc_test",
14+
"database.password": "sensitive_data_removed",
15+
"database.port": 1433,
16+
"database.server.name": "kalash-server-stream672",
17+
"database.ssl": true,
18+
"database.ssl.mode": "required",
19+
"database.tcpKeepAlive": true,
20+
"database.user": "debezium_user",
21+
"decimal.handling.mode": "double",
22+
"driver.encrypt": true,
23+
"driver.trustServerCertificate": true,
24+
"include.schema.changes": true,
1425
"key.converter": "org.apache.kafka.connect.json.JsonConverter",
26+
"name": "dbz-stream672",
27+
"pulsar.auth.token": "sensitive_data_removed",
28+
"pulsar.service.url": "pulsar+ssl://pulsar-azure-westus2.streaming.datastax.com:6651",
29+
"snapshot.mode": "always",
30+
"table.include.list": "dbo.accounts",
31+
"task.class": "io.debezium.connector.sqlserver.SqlServerConnectorTask",
32+
"task.id": "0",
33+
"topic.namespace": "kalash-stream672/default",
34+
"topic.prefix": "kalash-server-stream672",
1535
"typeClassName": "org.apache.pulsar.common.schema.KeyValue",
16-
"database.tcpKeepAlive": "true",
17-
"decimal.handling.mode": "double"
18-
}
36+
"value.converter": "org.apache.kafka.connect.json.JsonConverter"
37+
},
1938
----

modules/pulsar-io/pages/connectors/sources/debezium-sqlserver.adoc

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,32 @@ https://debezium.io/releases/{debezium-version}/[Debezium documentation].
1212

1313
== Get Started
1414

15+
To create a Debezium SQL Server source connector, do the following.
16+
Your deployment's values may differ.
17+
18+
. Create an Azure SQL Server or compatible SQL Server instance with a database and table you want to capture changes from.
19+
. Choose a connector name.
20+
. For Debezium SQL Server source connectors, you must manually create the required topics in your Pulsar namespace, following Debezium's topic naming conventions:
21+
22+
* `**CONNECTOR_NAME**-debezium-history-topic`
23+
* `**CONNECTOR_NAME**-debezium-offset-topic`
24+
* `**SERVER_NAME**`
25+
* `**SERVER_NAME**.**DB_NAME**.**TABLE_NAME**`
26+
27+
28+
You must create these topics manually.
29+
Autocreation is not available.
30+
31+
. In the source connector configuration, set the `topic.prefix` configuration value to match `database.server.name`.
32+
In the example configuration, both are set to `kalash-server-stream672`.
33+
. In the source connector configuration, ensure `task.id` is passed as a string (`"0"`), not an integer (`0`); otherwise, the connector will throw a `NullPointerException`.
34+
35+
. Set your consumers to subscribe to the `events` topic in your Pulsar namespace to receive change data capture (CDC) events.
36+
This topic contains the change data capture (CDC) events emitted by Debezium for the configured tables.
37+
38+
For more on Debezium topic naming conventions, see the https://debezium.io/documentation/reference/stable/connectors/sqlserver.html#sqlserver-topic-names[Debezium documentation].
39+
40+
1541
include::partial$connectors/sources/get-started.adoc[]
1642

1743
== Managing the Connector

0 commit comments

Comments
 (0)