> ## Documentation Index
> Fetch the complete documentation index at: https://docs.streamnative.io/llms.txt
> Use this file to discover all available pages before exploring further.

> The official YugabyteDB CDC Kafka Source Connector for capturing change data from YugabyteDB.

# Kafka connect yugabyte cdc source

The YugabyteDB CDC Kafka Source connector is a Kafka Connect connector that reads change data from YugabyteDB and writes it to Kafka topics.

<Note title="✅ Available on StreamNative Cloud">
  This connector is available as a built-in connector on StreamNative Cloud.
</Note>

### Prerequisites

* Collect the following information about your YugabyteDB cluster:
  * Master addresses
  * DB Stream ID
  * DB User and password

### Quick Start

1. Setup the kcctl client: [doc](https://docs.streamnative.io/docs/kafka-connect-setup)
2. Setup a YugabyteDB cluster, you can create one in k8s cluster with below yaml file:
   ```shell theme={null}
   helm repo add yugabytedb https://charts.yugabyte.com
   helm repo update

   helm upgrade --install yb-demo yugabytedb/yugabyte --version 2024.1.0
   kubectl wait -l app=yb-master --for=condition=Ready pod --timeout=10m
   kubectl wait -l app=yb-tserver --for=condition=Ready pod --timeout=10m

   # wait for the pod to be ready
   sleep 30

   kubectl exec yb-tserver-0 -- /home/yugabyte/bin/ysqlsh -c "CREATE TABLE IF NOT EXISTS test_kafka_connect(id int primary key, message text);"

   # create change stream
   stream_id=$(kubectl exec yb-master-0 -- yb-admin --master_addresses yb-masters.default.svc.cluster.local:7100 create_change_data_stream ysql.yugabyte)
   stream_id=$(echo $stream_id | awk '{print $4}')
   ```
3. Create a JSON file like the following:
   ```json theme={null}
   {
       "name": "yugabyte-cdc-source",
       "config": {
           "connector.class": "io.debezium.connector.yugabytedb.YugabyteDBConnector",
           "kafka.topic": "kafka-yugabyte-output",
           "tasks.max": "1",
           "database.hostname": "yb-tservers.default.svc.cluster.local",
           "database.port": "5433",
           "database.master.addresses": "yb-masters.default.svc.cluster.local:7100",
           "database.dbname": "yugabyte",
           "table.include.list": "public.test_kafka_connect",
           "database.streamid": "${STREAM_ID}",
           "snapshot.mode": "never",
           "database.user": "yugabyte",
           "database.password": "yugabyte",
           "database.server.name": "dbserver1",
           "key.converter": "org.apache.kafka.connect.storage.StringConverter",
           "key.converter.schemas.enable": "false",
           "value.converter": "org.apache.kafka.connect.json.JsonConverter",
           "value.converter.schemas.enable": "false"
       }
   }
   ```
4. Run the following command to create the connector:
   ```shell theme={null}
   kcctl apply -f <filename>.json
   ```

### Configuration

The YugabyteDB CDC Kafka Source connector is configured using the following *Required* properties:

| Property                    | Description                                   |
| --------------------------- | --------------------------------------------- |
| `database.master.addresses` | The addresses of the YugabyteDB master nodes. |
| `database.server.name`      | The name of the YugabyteDB server.            |
| `database.dbname`           | The name of the YugabyteDB database.          |
| `database.user`             | The user name for the YugabyteDB database.    |
| `database.password`         | The password for the YugabyteDB database.     |
| `database.streamid`         | The stream ID for the YugabyteDB database.    |
| `database.hostname`         | The hostname for the YugabyteDB database.     |
| `database.port`             | The port for the YugabyteDB database.         |

For more information about the properties, see the [offical YugabyteDB CDC Kafka Source Connector documentation](https://github.com/yugabyte/debezium-connector-yugabytedb/blob/v1.9.5.y.220.3/README.md).