ScyllaDB CDC Source Connector Quickstart¶

ScyllaDB installation¶

For the purpose of this quickstart, we will configure a ScyllaDB instance using Docker. You can skip this section if you have already installed ScyllaDB. To learn more about installing and configuring ScyllaDB in production environments, please refer to the Getting Started guide.

1. Using Docker, follow the instructions to launch ScyllaDB.

2. Start the Docker container, replacing the --name and --host name parameters with your own information. For example:

   docker run --name scylla-cdc-quickstart --hostname scylla-cdc-quickstart -d scylladb/scylla
   docker run --name scylla-cdc-quickstart-2 --hostname scylla-cdc-quickstart-2 -d scylladb/scylla --seeds="$(docker inspect --format='{{ .NetworkSettings.IPAddress }}' scylla-cdc-quickstart)"
   docker run --name scylla-cdc-quickstart-3 --hostname scylla-cdc-quickstart-3 -d scylladb/scylla --seeds="$(docker inspect --format='{{ .NetworkSettings.IPAddress }}' scylla-cdc-quickstart)"
   

3. Run docker ps to show the exposed ports. The output should be similar to this example:

   docker ps
   CONTAINER ID   IMAGE                 COMMAND                  CREATED              STATUS              PORTS                                                            NAMES
   b72f341f53c0   scylladb/scylla       "/docker-entrypoint.…"   12 seconds ago       Up 11 seconds       22/tcp, 7000-7001/tcp, 9042/tcp, 9160/tcp, 9180/tcp, 10000/tcp   scylla-cdc-quickstart-3
   e1ac1ccb4d12   scylladb/scylla       "/docker-entrypoint.…"   16 seconds ago       Up 15 seconds       22/tcp, 7000-7001/tcp, 9042/tcp, 9160/tcp, 9180/tcp, 10000/tcp   scylla-cdc-quickstart-2
   f1668fba1e7b   scylladb/scylla       "/docker-entrypoint.…"   About a minute ago   Up About a minute   22/tcp, 7000-7001/tcp, 9042/tcp, 9160/tcp, 9180/tcp, 10000/tcp   scylla-cdc-quickstart
   

Creating a CDC-enabled table¶

Let’s connect to your ScyllaDB cluster and create a new CDC-enabled table. We will create an example table by issuing the following CQL query and insert some example data:

CREATE KEYSPACE quickstart_keyspace WITH REPLICATION = {'class': 'NetworkTopologyStrategy', 'replication_factor': 3};

CREATE TABLE quickstart_keyspace.orders(
   customer_id int,
   order_id int,
   product text,
   PRIMARY KEY(customer_id, order_id)) WITH cdc = {'enabled': true};

INSERT INTO quickstart_keyspace.orders(customer_id, order_id, product) VALUES (1, 1, 'pizza');
INSERT INTO quickstart_keyspace.orders(customer_id, order_id, product) VALUES (1, 2, 'cookies');
INSERT INTO quickstart_keyspace.orders(customer_id, order_id, product) VALUES (1, 3, 'tea');

If you already have a table you wish to use, but it does not have CDC enabled, you can turn it on by using the following CQL query:

ALTER TABLE keyspace.table_name with cdc = {'enabled': true};

To learn more about ScyllaDB CDC, visit Change Data Capture (CDC) page.

Installing Confluent Platform¶

If you are new to Confluent, download Confluent Platform.

1. In the Download Confluent Platform section fill in your email address

2. Open the Select Deployment Type drop-down and select ZIP

3. Accept the Terms & Conditions and click DOWNLOAD FREE

4. You will receive an email with instructions. Download / move the file to the desired location

5. Continue with the setup following this document

Installing ScyllaDB CDC Source Connector¶

1. Download or build ScyllaDB CDC Source Connector using the project build instructions

2. Deploy the connector:

   1. If you use Confluent Platform, move connector JAR files to the share/java folder

   2. If you use open-source Kafka, make sure that plugin.path of Kafka Connect configuration contains the folder with connector JAR files

Configuration using Confluent Control Center¶

If you use Confluent Platform, the easiest way to configure and start up the ScyllaDB CDC Source Connector is to use Confluent Control Center web interface.

1. Open the Confluent Control Center. By default, it is started at port 9021:

   

2. Click on the cluster you want to start the connector in and open the “Connect” tab:

   

3. Click on the Kafka Connect cluster:

   

4. Click “Add connector”:

   

5. Click “ScyllaConnector (Source Connector)”:

   

6. Configure the connector. You need to fill in these required configuration parameters:

   1. Name: the name of this configuration

   2. Key converter class, value converter class: converters that determine the format of produced messages. You can read more about them at Kafka Connect Deep Dive – Converters and Serialization Explained

   3. Hosts: contact points of ScyllaDB

   4. Namespace: a unique name that identifies the ScyllaDB cluster and that is used as a prefix for all schemas, topics.

   5. Table names: the names of CDC-enabled tables you want to replicate

   For the quickstart example here are the values we will use:

   1. Name: QuickstartConnector

   2. Key converter class, value converter class: org.apache.kafka.connect.json.JsonConverter

   3. Hosts: 172.17.0.2:9042 (ScyllaDB started in Docker)

   4. Namespace: QuickstartConnectorNamespace

   5. Table names: quickstart_keyspace.orders

   

7. Click “Continue” and “Launch”

8. After a short while, a new QuickstartConnectorNamespace.quickstart_keyspace.orders topic will be automatically created and inserted rows will be replicated. You can browse them by going to the “Topics” tab, selecting QuickstartConnectorNamespace.quickstart_keyspace.orders topic, going to “Message” tab and inputting 0 to “Jump to offset” field:

   

Configuration using open-source Kafka¶

1. Start Kafka Connect standalone using this guide. You will have to create a connector.properties file with the following contents:

   name = QuickstartConnector
   connector.class = com.scylladb.cdc.debezium.connector.ScyllaConnector
   key.converter = org.apache.kafka.connect.json.JsonConverter
   value.converter = org.apache.kafka.connect.json.JsonConverter
   scylla.cluster.ip.addresses = 172.17.0.2:9042
   scylla.name = QuickstartConnectorNamespace
   scylla.table.names = quickstart_keyspace.orders
   

2. After starting the connector, you can see the generated messages by using kafka-console-consumer tool:

   bin/kafka-console-consumer --bootstrap-server localhost:9092 --topic QuickstartConnectorNamespace.quickstart_keyspace.orders --from-beginning