Use the Java CDC console client Beta

The Java console client for CDC prints CDC changes to the console. This client is meant for testing purposes only.

Set up YugabyteDB

This can be done either locally using yugabyted or via YugabyteDB Managed. Refer to the Quick Start guide to learn more.

1. If you're testing locally, create a cluster using yugabyted.

   ./bin/yugabyted start
   

2. Next, connect to your cluster using the YSQL shell:

   ./bin/ysqlsh
   

3. Once connected, create a database.

   
   You can use any database, as long as you have the permission for it. In this example, you create testdatabase.

   CREATE DATABASE testdatabase;
   \c testdatabase
   CREATE TABLE test (id int primary key, name varchar(50), email text);
   

4. Create a CDC stream.

   
   Use the create_change_data_stream command to create a stream. For a full list of CDC commands, see the yb-admin page.

   ./bin/yb-admin create_change_data_stream ysql.yugabyte
   

   CDC Stream ID: 0bb74adc723248d584ce90b856974633
   

Run the console client

1. Create a configuration file.

   
   Create a file called config.properties, with the following contents. Replace the stream.id value with the CDC stream ID from the previous step.

   admin.operation.timeout.ms=30000
   operation.timeout.ms=30000
   num.io.threads=1
   socket.read.timeout.ms=30000
   table.name=test
   stream.id=0bb74adc723248d584ce90b856974633
   schema.name=testdatabase
   format=proto
   master.address=127.0.0.1:7100
   

2. Run the Java console client, and you can directly view the changes in your terminal.

   java -jar java/yb-cdc/target/yb-cdc-connector.jar --config_file config.properties
   

You can also specify the following optional flags: