A stateless tool to manage the streams and cdc_state table in YugabyteDB.
You only require a JDK 11 to use build and use this tool.
Use the following command to build the jar file for the tool:
mvn clean verify -DquickThe above command will generate a jar file inside the target/ directory.
This tool can be used to manipulate and retrieve information from the cdc_state table in YugabyteDB. The user just needs to provide the required options in order to get the tool in action.
These parameters are the required parameters and should be considered as a prerequisite:
| Option | Description |
|---|---|
-master_addresses |
List of comma separated values of master IPs in the format host1:port1,host2:port2 |
-stream_id |
The DB stream ID to operate on |
-ssl_root_cert |
Path to SSL certificate file is SSL is enabled |
-client_cert_file |
Path to client certificate file if required |
-client_key_file |
Path to client key file if required |
Note: Because of the dependency of the underlying APIs, you will need to provide a table_id along with tablet_id in the -set_checkpoint and -clean_tablet operations.
Print the information related to the provided stream ID
java -jar target/yb-cdc-state-manager.jar
-master_addresses <master-addresses>
-stream_id <stream-id>
[-ssl_root_cert <path-to-root-cert>]
[-client_cert_file <path-to-client-cert-file>]
[-client_key_file <path-to-client-key-file>]
-get_db_stream_infoGet the checkpoints of all the tablets associated with the provided stream ID
java -jar target/yb-cdc-state-manager.jar
-master_addresses <master-addresses>
-stream_id <stream-id>
[-ssl_root_cert <path-to-root-cert>]
[-client_cert_file <path-to-client-cert-file>]
[-client_key_file <path-to-client-key-file>]
-get_checkpointsGet the checkpoint of the specified tablet (if it's a part of the provided stream ID
java -jar target/yb-cdc-state-manager.jar
-master_addresses <master-addresses>
-stream_id <stream-id>
[-ssl_root_cert <path-to-root-cert>]
[-client_cert_file <path-to-client-cert-file>]
[-client_key_file <path-to-client-key-file>]
-get_checkpoint -tablet_id <tablet-uuid>Set the checkpoint for the given tablet. Specify the -bootstrap flag along with it if you want to bootstrap the tablet as well.
java -jar target/yb-cdc-state-manager.jar
-master_addresses <master-addresses>
-stream_id <stream-id>
[-ssl_root_cert <path-to-root-cert>]
[-client_cert_file <path-to-client-cert-file>]
[-client_key_file <path-to-client-key-file>]
-table_id <table-uuid>
-tablet_id <tablet-uuid>
-set_checkpoint <term>.<index>
[-bootstrap]Set the checkpoint of the provided tablet to a max value.
java -jar target/yb-cdc-state-manager.jar
-master_addresses <master-addresses>
-stream_id <stream-id>
[-ssl_root_cert <path-to-root-cert>]
[-client_cert_file <path-to-client-cert-file>]
[-client_key_file <path-to-client-key-file>]
-table_id <table-uuid>
-clean_tablet -tablet_id <tablet-uuid>Set the checkpoint of all the tablets associated with a given stream ID to a max value
java -jar target/yb-cdc-state-manager.jar
-master_addresses <master-addresses>
-stream_id <stream-id>
[-ssl_root_cert <path-to-root-cert>]
[-client_cert_file <path-to-client-cert-file>]
[-client_key_file <path-to-client-key-file>]
-clean_all_tabletsNote: If there is a case where let’s say there are 10 tablets under a stream ID and upon deleting the stream 5 got removed from the cdc_state table and the rest 5 are still there, then in that case, it is advised that the user should use the -clean_tablet command to clean up one tablet at a time.