├── .arcconfig ├── .gitignore ├── LICENSE ├── README.md ├── logos ├── dsql-kafka.png └── yb_stacked_full_detail_dark_RGB.png ├── pom.xml ├── resources └── examples │ ├── kafka.connect.properties │ └── yugabyte.sink.properties ├── src └── main │ └── java │ └── com │ └── yb │ └── connect │ └── sink │ ├── YBSinkConnector.java │ └── YBSinkTask.java └── yb-cdc ├── README.md └── yb-cdc-connector.jar /.arcconfig: -------------------------------------------------------------------------------- 1 | { 2 | "phabricator.uri" : "https://phabricator.dev.yugabyte.com", 3 | "repository.callsign": "YB-Kafka-Connector", 4 | "git:arc.feature.start.default" : "upstream/master", 5 | "arc.land.onto.default": "master", 6 | "arc.feature.start.default" : "master" 7 | } 8 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | build 2 | logs 3 | target 4 | .idea 5 | .idea_modules 6 | /.classpath 7 | /.project 8 | /.settings 9 | /RUNNING_PID 10 | 11 | # VIM/emacs stuff 12 | *.swp 13 | *~ 14 | core* 15 | 16 | perf.data 17 | perf.data.old 18 | oprofile_data 19 | .metadata/ 20 | *.iml 21 | 22 | app/.DS_STORE 23 | .DS_Store 24 | app/views/.DS_Store 25 | 26 | node_modules/ 27 | react/node_modules/ 28 | *bundle.js 29 | react/public/bundle.js 30 | react/.idea/ 31 | 32 | npm-debug.log 33 | react/npm-debug.log 34 | 35 | conf/* 36 | src/main/public/* 37 | *.pyc 38 | docker/yugaware/*.yml 39 | src/itest/static/*.log 40 | 41 | ui/.env 42 | ui/public/map/ 43 | 44 | src/itest/python_virtual_env 45 | src/itest/web_app/appllication.conf 46 | .session.vim* 47 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | There are two approaches of integrating [YugabyteDB](https://github.com/yugabyte/yugabyte-db) with Kafka. Kafka provides [Kafka Connect](https://docs.confluent.io/3.0.0/connect/intro.html), a connector SDK for building such integrations. 2 | 3 | Kafka Connect YugabyteDB Connector Architecture 4 | 5 | ## Kafka Connect YugabyteDB Source Connector 6 | 7 | In this approach, the source connector streams table updates in YugabyteDB to Kafka topics. It is based on YugabyteDB's Change Data Capture (CDC) feature. CDC allows the connector to simply subscribe to these table changes and then publish the changes to selected Kafka topics. 8 | 9 | More documentation to follow. 10 | 11 | ## Kafka Connect YugabyteDB Sink Connector 12 | 13 | In this approach, the sink connector delivers data from Kafka topics into YugabyteDB tables. The connector subscribes to specific topics in Kafka and then writes to specific tables in YugabyteDB as soon as new messages are received in the selected topics. 14 | 15 | ### Prerequisites 16 | 17 | For building and using this project, we requires following tools pre-installed on the system. 18 | 19 | - JDK - 1.8+ 20 | - Maven - 3.3+ 21 | - Clone this repo into `~/yb-kafka/yb-kafka-connector/` directory. 22 | 23 | 24 | ### Steps to setup and run connect sink 25 | 26 | 1. Setup and start Kafka 27 | 28 | - Download the Apache Kafka tarball 29 | 30 | ``` 31 | mkdir -p ~/yb-kafka 32 | cd ~/yb-kafka 33 | wget http://apache.cs.utah.edu/kafka/2.0.0/kafka_2.11-2.0.0.tgz 34 | tar -xzf kafka_2.11-2.0.0.tgz 35 | ``` 36 | Any latest version can be chosen, this is just as a sample. 37 | - Start Zookeeper and Kafka server 38 | 39 | ``` 40 | ~/yb-kafka/kafka_2.11-2.0.0/bin/zookeeper-server-start.sh config/zookeeper.properties & 41 | ~/yb-kafka/kafka_2.11-2.0.0/bin/kafka-server-start.sh config/server.properties & 42 | ``` 43 | - Create a Kafka topic 44 | 45 | ``` 46 | $ ~/yb-kafka/kafka_2.11-2.0.0/bin/kafka-topics.sh --create --zookeeper localhost:2181 --replication-factor 1 --partitions 1 --topic test 47 | ``` 48 | This needs to be done only once. 49 | 50 | - Run the following to produce data in that topic: 51 | 52 | ``` 53 | $ ~/yb-kafka/kafka_2.11-2.0.0/bin/kafka-console-producer.sh --broker-list localhost:9092 --topic test_topic 54 | ``` 55 | Just cut-and-paste the following lines at the prompt: 56 | 57 | ``` 58 | {"key" : "A", "value" : 1, "ts" : 1541559411000} 59 | {"key" : "B", "value" : 2, "ts" : 1541559412000} 60 | {"key" : "C", "value" : 3, "ts" : 1541559413000} 61 | ``` 62 | Feel free to `Ctrl-C` this process or switch to a different shell as more values can be added later as well to the same topic. 63 | 64 | 2. Install YugabyteDB and create the keyspace/table. 65 | 66 | - [Install YugabyteDB and start a local cluster](https://docs.yugabyte.com/quick-start/install/). 67 | - Create a keyspace and table by running the following command. You can find `cqlsh` in the `bin` subdirectory located inside the YugabyteDB installation folder. 68 | 69 | ```sh 70 | $> cqlsh 71 | cqlsh> CREATE KEYSPACE IF NOT EXISTS demo; 72 | cqlsh> CREATE TABLE demo.test_table (key text, value bigint, ts timestamp, PRIMARY KEY (key)); 73 | ``` 74 | 75 | 3. Set up and run the Kafka Connect Sink 76 | 77 | - Setup the required jars needed by connect 78 | 79 | ``` 80 | cd ~/yb-kafka/yb-kafka-connector/ 81 | mvn clean install -DskipTests 82 | cp ~/yb-kafka/yb-kafka-connector/target/yb-kafka-connnector-1.0.0.jar ~/yb-kafka/kafka_2.11-2.0.0/libs/ 83 | cd ~/yb-kafka/kafka_2.11-2.0.0/libs/ 84 | wget http://central.maven.org/maven2/io/netty/netty-all/4.1.25.Final/netty-all-4.1.25.Final.jar 85 | wget http://central.maven.org/maven2/com/yugabyte/cassandra-driver-core/3.2.0-yb-18/cassandra-driver-core-3.2.0-yb-18.jar 86 | wget http://central.maven.org/maven2/com/codahale/metrics/metrics-core/3.0.1/metrics-core-3.0.1.jar 87 | ``` 88 | 89 | - Finally, run the connect sink in standalone mode: 90 | 91 | ``` 92 | ~/yb-kafka/kafka_2.11-2.0.0/bin/connect-standalone.sh ~/yb-kafka/yb-kafka-connector/resources/examples/kafka.connect.properties ~/yb-kafka/yb-kafka-connector/resources/examples/yugabyte.sink.properties 93 | ``` 94 | 95 | *Note*: 96 | 97 | - Setting the `bootstrap.servers` to a remote host/ports in the `kafka.connect.properties` file can help connect to any accessible existing Kafka cluster. 98 | - The `keyspace` and `tablename` values in the `yugabyte.sink.properties` file should match the values in the cqlsh commands in step 5. 99 | - The `topics` value should match the topic name from producer in step 6. 100 | - Setting the `yugabyte.cql.contact.points` to a non-local list of host/ports will help connect to any remote accessible existing YugaByte DB cluster. 101 | 102 | - Check the console output (optional) 103 | 104 | You should see something like this (relevant lines from `YBSinkTask.java`) on the console: 105 | 106 | ``` 107 | [2018-10-28 16:24:16,037] INFO Start with keyspace=demo, table=test_table (com.yb.connect.sink.YBSinkTask:79) 108 | [2018-10-28 16:24:16,054] INFO Connecting to nodes: /127.0.0.1:9042,/127.0.0.2:9042,/127.0.0.3:9042 (com.yb.connect.sink.YBSinkTask:189) 109 | [2018-10-28 16:24:16,517] INFO Connected to cluster: cluster1 (com.yb.connect.sink.YBSinkTask:155) 110 | [2018-10-28 16:24:16,594] INFO Processing 3 records from Kafka. (com.yb.connect.sink.YBSinkTask:95) 111 | [2018-10-28 16:24:16,602] INFO Insert INSERT INTO demo.test_table(key,ts,value) VALUES (?,?,?) (com.yb.connect.sink.YBSinkTask:439) 112 | [2018-10-28 16:24:16,612] INFO Prepare SinkRecord ... 113 | [2018-10-28 16:24:16,618] INFO Bind 'ts' of type timestamp (com.yb.connect.sink.YBSinkTask:255) 114 | ... 115 | ``` 116 | 117 | 4. Confirm that the rows are in the target table in the YugabyteDB cluster, using `cqlsh`. 118 | 119 | ```sh 120 | cqlsh> select * from demo.test_table; 121 | key | value | ts 122 | ----+-------+--------------------------------- 123 | A | 1 | 2018-11-07 02:56:51.000000+0000 124 | C | 3 | 2018-11-07 02:56:53.000000+0000 125 | B | 2 | 2018-11-07 02:56:52.000000+0000 126 | ``` 127 | Note that the timestamp value gets printed as a human-readable date format automatically. 128 | 129 | ## Future Work 130 | 131 | - Add more data types. 132 | - Add more tests. 133 | - Add restartability. 134 | 135 | ## License 136 | 137 | This software is distributed under an Apache 2.0 license. See the [LICENSE.txt](https://github.com/YugaByte/yb-kafka-connector/LICENSE) file for details. 138 | -------------------------------------------------------------------------------- /logos/dsql-kafka.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yugabyte/yb-kafka-connector/cb577685d278d116f79b80986fb0e8f5fb86fc01/logos/dsql-kafka.png -------------------------------------------------------------------------------- /logos/yb_stacked_full_detail_dark_RGB.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yugabyte/yb-kafka-connector/cb577685d278d116f79b80986fb0e8f5fb86fc01/logos/yb_stacked_full_detail_dark_RGB.png -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 15 | 16 | 18 | 4.0.0 19 | com.yb 20 | yb-kafka-connector 21 | 1.0.0 22 | Kafka Connect YB 23 | 24 | 25 | Kafka Connect to YugaByte DB. 26 | 27 | 28 | 29 | 30 | 31 | 32 | org.apache.kafka 33 | kafka-streams 34 | 0.10.1.1 35 | 36 | 37 | org.apache.kafka 38 | connect-api 39 | 2.0.0 40 | 41 | 42 | 43 | 44 | com.yugabyte 45 | cassandra-driver-core 46 | 3.2.0-yb-18 47 | 48 | 49 | 50 | 51 | log4j 52 | log4j 53 | 1.2.17 54 | 55 | 56 | org.slf4j 57 | slf4j-log4j12 58 | 1.7.25 59 | 60 | 61 | junit 62 | junit 63 | 4.12 64 | 65 | 66 | 67 | 68 | 69 | 70 | io.confluent 71 | 0.11.2 72 | kafka-connect-maven-plugin 73 | 74 | 75 | 76 | kafka-connect 77 | 78 | 79 | Kafka Connect Yugabyte 80 | https://docs.yugabyte.com/latest/develop/ecosystem-integrations/apache-kafka/ 81 | 82 | The YugabyteDB connector allows moving data from Kafka to YugabyteDB 1.x, and 2.x. It writes data from a topic in Kafka to an index in Yugabyte and all data for a topic have the same type. 83 | 84 | YugabyteDB is a high-performance, distributed SQL database built on a scalable and fault-tolerant design inspired by Google Spanner. Yugabyte’s SQL API (YSQL) supports most of PostgreSQL’s functionality and is wire-protocol compatible with PostgreSQL drivers. 85 | 86 | logos/yb_stacked_full_detail_dark_RGB.png 87 | 88 | Yugabyte, Inc. 89 | Yugabyte supports the Yugabyte sink connector. 90 | https://github.com/YugaByte/yb-kafka-connector/issues 91 | logos/yb_stacked_full_detail_dark_RGB.png 92 | 93 | yugabyteinc 94 | organization 95 | Yugabyte, Inc. 96 | https://yugabyte.com/ 97 | logos/yb_stacked_full_detail_dark_RGB.png 98 | 99 | yugabytedb 100 | yugabyte 101 | ${project.version} 102 | 103 | 104 | sink 105 | 106 | 107 | 108 | Database 109 | yugabyte 110 | sql 111 | cql 112 | redis 113 | 114 | 115 | 116 | YugabyteDB 1.x, 2.x 117 | 118 | 119 | 120 | exactlyOnce 121 | 122 | 123 | true 124 | 125 | 126 | 127 | 128 | 129 | org.apache.maven.plugins 130 | maven-compiler-plugin 131 | 3.3 132 | 133 | 1.8 134 | 1.8 135 | 136 | 137 | 138 | 139 | 140 | 141 | -------------------------------------------------------------------------------- /resources/examples/kafka.connect.properties: -------------------------------------------------------------------------------- 1 | # Sample file with Kafka server properties. 2 | 3 | # Parameters for use by (local) Kafka server. 4 | bootstrap.servers=localhost:9092 5 | offset.storage.file.filename=/tmp/yb.connect.offsets 6 | offset.flush.interval.ms=10000 7 | 8 | # Format of data in Kafka and how to translate it into YB connect sink data. 9 | key.converter=org.apache.kafka.connect.storage.StringConverter 10 | value.converter=org.apache.kafka.connect.json.JsonConverter 11 | key.converter.schemas.enable=false 12 | value.converter.schemas.enable=false 13 | 14 | # Location of YB sink jar. 15 | plugin.path=share/java 16 | -------------------------------------------------------------------------------- /resources/examples/yugabyte.sink.properties: -------------------------------------------------------------------------------- 1 | # Sample yugabyte sink properties. 2 | 3 | name=yugabyte-sink 4 | connector.class=com.yb.connect.sink.YBSinkConnector 5 | 6 | topics=test_topic 7 | 8 | yugabyte.cql.keyspace=demo 9 | yugabyte.cql.tablename=test_table 10 | yugabyte.cql.contact.points=127.0.0.1:9042,127.0.0.2:9042,127.0.0.3:9042 11 | -------------------------------------------------------------------------------- /src/main/java/com/yb/connect/sink/YBSinkConnector.java: -------------------------------------------------------------------------------- 1 | // Copyright (c) YugaByte, Inc. 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except 4 | // in compliance with the License. You may obtain a copy of the License at 5 | // 6 | // http://www.apache.org/licenses/LICENSE-2.0 7 | // 8 | // Unless required by applicable law or agreed to in writing, software distributed under the License 9 | // is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express 10 | // or implied. See the License for the specific language governing permissions and limitations 11 | // under the License. 12 | // 13 | 14 | package com.yb.connect.sink; 15 | 16 | import java.util.ArrayList; 17 | import java.util.List; 18 | import java.util.Map; 19 | import java.util.stream.IntStream; 20 | 21 | import org.apache.kafka.common.config.ConfigDef; 22 | import org.apache.kafka.connect.connector.Task; 23 | import org.apache.kafka.connect.sink.SinkConnector; 24 | 25 | /** 26 | * YugaByte Sink connector. 27 | */ 28 | public class YBSinkConnector extends SinkConnector { 29 | private static final String VERSION = "1"; 30 | 31 | private Map properties; 32 | 33 | @Override 34 | public String version() { 35 | return VERSION; 36 | } 37 | 38 | @Override 39 | public void start(final Map properties) { 40 | this.properties = properties; 41 | } 42 | 43 | @Override 44 | public Class taskClass() { 45 | return YBSinkTask.class; 46 | } 47 | 48 | @Override 49 | public List> taskConfigs(final int maximumTasks) { 50 | final List> configs = new ArrayList>(); 51 | IntStream.rangeClosed(1, maximumTasks).forEach((i) -> configs.add(properties)); 52 | return configs; 53 | } 54 | 55 | @Override 56 | public void stop() { 57 | } 58 | 59 | @Override 60 | public ConfigDef config() { 61 | return new ConfigDef(); 62 | } 63 | } 64 | -------------------------------------------------------------------------------- /src/main/java/com/yb/connect/sink/YBSinkTask.java: -------------------------------------------------------------------------------- 1 | // Copyright (c) YugaByte, Inc. 2 | // 3 | // Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except 4 | // in compliance with the License. You may obtain a copy of the License at 5 | // 6 | // http://www.apache.org/licenses/LICENSE-2.0 7 | // 8 | // Unless required by applicable law or agreed to in writing, software distributed under the License 9 | // is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express 10 | // or implied. See the License for the specific language governing permissions and limitations 11 | // under the License. 12 | // 13 | 14 | package com.yb.connect.sink; 15 | 16 | import java.nio.ByteBuffer; 17 | import java.text.ParseException; 18 | import java.text.SimpleDateFormat; 19 | import java.util.ArrayList; 20 | import java.util.Calendar; 21 | import java.util.Collection; 22 | import java.util.Date; 23 | import java.util.GregorianCalendar; 24 | import java.util.HashMap; 25 | import java.util.HashSet; 26 | import java.util.List; 27 | import java.util.Map; 28 | import java.util.Set; 29 | import java.util.TreeSet; 30 | import java.util.TimeZone; 31 | import java.util.stream.Collectors; 32 | 33 | import org.apache.kafka.connect.data.Field; 34 | import org.apache.kafka.connect.data.Schema; 35 | import org.apache.kafka.connect.sink.SinkRecord; 36 | import org.apache.kafka.connect.sink.SinkTask; 37 | import org.apache.kafka.connect.data.Struct; 38 | 39 | import com.datastax.driver.core.BoundStatement; 40 | import com.datastax.driver.core.ColumnMetadata; 41 | import com.datastax.driver.core.ConsistencyLevel; 42 | import com.datastax.driver.core.Cluster; 43 | import com.datastax.driver.core.DataType; 44 | import com.datastax.driver.core.KeyspaceMetadata; 45 | import com.datastax.driver.core.QueryOptions; 46 | import com.datastax.driver.core.PreparedStatement; 47 | import com.datastax.driver.core.ResultSetFuture; 48 | import com.datastax.driver.core.Statement; 49 | import com.datastax.driver.core.Session; 50 | import com.datastax.driver.core.TableMetadata; 51 | import com.datastax.driver.core.LocalDate; 52 | 53 | import org.slf4j.Logger; 54 | import org.slf4j.LoggerFactory; 55 | 56 | /** 57 | * YugaByte DB Sink Task. 58 | */ 59 | public class YBSinkTask extends SinkTask { 60 | private static final Logger LOG = LoggerFactory.getLogger(YBSinkTask.class); 61 | private static final String VERSION = "1"; 62 | 63 | private String keyspace = null; 64 | private String tablename = null; 65 | private Cluster cassandraCluster = null; 66 | private Session cassandraSession = null; 67 | private Map columnNameToType = null; 68 | 69 | @Override 70 | public void start(final Map properties) { 71 | this.keyspace = properties.get("yugabyte.cql.keyspace"); 72 | if (this.keyspace == null || this.keyspace.isEmpty()) { 73 | throw new IllegalArgumentException("Need a valid value for 'yugabyte.cql.keyspace'."); 74 | } 75 | this.tablename = properties.get("yugabyte.cql.tablename"); 76 | if (this.tablename == null || this.tablename.isEmpty()) { 77 | throw new IllegalArgumentException("Need a valid value for 'yugabyte.cql.tablename'."); 78 | } 79 | LOG.info("Start with keyspace=" + this.keyspace + ", table=" + this.tablename); 80 | List contactPoints = 81 | getContactPoints(properties.get("yugabyte.cql.contact.points")); 82 | this.cassandraSession = getCassandraSession(contactPoints); 83 | if (this.cassandraSession == null) { 84 | throw new IllegalArgumentException("Could not connect to 'yugabyte.cql.contact.points'" 85 | + contactPoints); 86 | } 87 | columnNameToType = new HashMap(); 88 | } 89 | 90 | @Override 91 | public void put(final Collection records) { 92 | if (records.isEmpty()) { 93 | return; 94 | } 95 | LOG.info("Processing " + records.size() + " records from Kafka."); 96 | List statements = getStatements(records); 97 | if (statements.isEmpty()) { 98 | LOG.info("No valid statements were received."); 99 | return; 100 | } 101 | statements.forEach(statement -> cassandraSession.execute(statement)); 102 | } 103 | 104 | @Override 105 | public void stop() { 106 | if (cassandraSession != null) { 107 | cassandraSession.close(); 108 | } 109 | if (cassandraCluster != null) { 110 | cassandraCluster.close(); 111 | } 112 | } 113 | 114 | @Override 115 | public String version() { 116 | return VERSION; 117 | } 118 | 119 | // Helper class for host/port information to the YugaByte DB cluster. 120 | private class ContactPoint { 121 | private String host; 122 | private int port; 123 | 124 | public ContactPoint(String host, int port) { 125 | this.host = host; 126 | this.port = port; 127 | } 128 | 129 | public String getHost() { 130 | return host; 131 | } 132 | 133 | public int getPort() { 134 | return port; 135 | } 136 | 137 | public String ToString() { return host + ":" + port; } 138 | } 139 | 140 | private ContactPoint fromHostPort(String hostPort) { 141 | String[] parts = hostPort.split(":"); 142 | if (parts.length != 2) { 143 | throw new IllegalArgumentException("Invalid host:port format " + hostPort); 144 | } 145 | return new ContactPoint(parts[0], Integer.parseInt(parts[1])); 146 | } 147 | 148 | private List getContactPoints(String csvHostPorts) { 149 | if (csvHostPorts == null) { 150 | throw new IllegalArgumentException("Invalid null cql contact point list"); 151 | } 152 | List contactPoints = new ArrayList(); 153 | String[] hostPorts = csvHostPorts.split(","); 154 | for (String hostPort : hostPorts) { 155 | contactPoints.add(fromHostPort(hostPort)); 156 | } 157 | return contactPoints; 158 | } 159 | 160 | private Session getCassandraSession(List contactPoints) { 161 | if (cassandraSession == null) { 162 | createCassandraClient(contactPoints); 163 | } 164 | return cassandraSession; 165 | } 166 | 167 | /** 168 | * Create a Cassandra client and session to YugaByte DB's CQL contact points. 169 | */ 170 | private synchronized void createCassandraClient(List contactPoints) { 171 | if (cassandraCluster == null) { 172 | Cluster.Builder builder = Cluster.builder(); 173 | Integer port = null; 174 | for (ContactPoint cp : contactPoints) { 175 | if (port == null) { 176 | port = cp.getPort(); 177 | builder.withPort(port); 178 | } else if (port != cp.getPort()) { 179 | throw new IllegalArgumentException("Using multiple CQL ports is not supported."); 180 | } 181 | builder.addContactPoint(cp.getHost()); 182 | } 183 | LOG.info("Connecting to nodes: " + builder.getContactPoints().stream() 184 | .map(it -> it.toString()).collect(Collectors.joining(","))); 185 | cassandraCluster = builder.build(); 186 | } 187 | if (cassandraSession == null) { 188 | cassandraSession = cassandraCluster.connect(); 189 | LOG.info("Connected to cluster: " + cassandraCluster.getClusterName()); 190 | } 191 | } 192 | 193 | // Used to store schema information from the table. 194 | private class ColumnInfo { 195 | private String name; 196 | private DataType dataType; 197 | 198 | ColumnInfo(String colname, DataType datatype) { 199 | name = colname; 200 | dataType = datatype; 201 | } 202 | } 203 | 204 | private String generateInsert(List cols) { 205 | String insert = "INSERT INTO " + keyspace + "." + tablename + "(" + cols.get(0).name; 206 | String comma = ","; 207 | String quesMarks = "?"; 208 | for (int i = 1; i < cols.size(); i++) { 209 | insert = insert + comma + cols.get(i).name; 210 | quesMarks = quesMarks + comma + "?"; 211 | } 212 | insert = insert + ") VALUES (" + quesMarks + ")"; 213 | return insert; 214 | } 215 | 216 | private List getColsFromTable() { 217 | KeyspaceMetadata km = cassandraSession.getCluster().getMetadata().getKeyspace(keyspace); 218 | if (null == km) { 219 | throw new IllegalArgumentException("Keyspace " + keyspace + " not found."); 220 | } 221 | TableMetadata tm = km.getTable(tablename); 222 | if (null == tm) { 223 | throw new IllegalArgumentException("Table " + tablename + " not found."); 224 | } 225 | List cols = new ArrayList(); 226 | for (ColumnMetadata cm : tm.getColumns()) { 227 | cols.add(new ColumnInfo(cm.getName(), cm.getType())); 228 | columnNameToType.put(cm.getName(), cm.getType()); 229 | LOG.info("Add column " + cm.getName() + " of type " + cm.getType()); 230 | } 231 | return cols; 232 | } 233 | 234 | // Helper function to parse a string into a Date type 235 | private Date getTimeStamp(String val) { 236 | Calendar cal = new GregorianCalendar(); 237 | cal.setTimeZone(TimeZone.getTimeZone("GMT")); 238 | cal.setTimeInMillis(0); 239 | String errMsg = "Invalid timestamp format for " + val + 240 | ". Expect 'yyyy-mm-dd hh:mm:ss'."; 241 | Date date = null; 242 | // TODO: Allow more patterns. 243 | String pattern = "yyyy-MM-dd HH:mm:ss"; 244 | try { 245 | SimpleDateFormat simpleDateFormat = new SimpleDateFormat(pattern); 246 | date = simpleDateFormat.parse(val); 247 | } catch (ParseException pe) { 248 | throw new IllegalArgumentException(errMsg + "Error: " + pe); 249 | } 250 | return date; 251 | } 252 | 253 | private BoundStatement bindByColumnType(BoundStatement statement, String colName, 254 | DataType.Name typeName, Object value) { 255 | LOG.info("Bind '" + colName + "' of type " + typeName); 256 | switch (typeName) { 257 | case INT: 258 | if (!(value instanceof Integer)) { 259 | throw new IllegalArgumentException("Value should be of type Integer."); 260 | } 261 | statement = statement.setInt(colName, (Integer)value); 262 | break; 263 | case BIGINT: 264 | statement = statement.setLong(colName, (Long)value); 265 | break; 266 | case FLOAT: 267 | statement = statement.setFloat(colName, (Float)value); 268 | break; 269 | case DOUBLE: 270 | statement = statement.setDouble(colName, (Double)value); 271 | break; 272 | case VARCHAR: 273 | case TEXT: 274 | statement = statement.setString(colName, (String)value); 275 | break; 276 | case BOOLEAN: 277 | statement = statement.setBool(colName, (Boolean)value); 278 | break; 279 | case BLOB: 280 | ByteBuffer bb = null; 281 | if (value instanceof ByteBuffer) { 282 | bb = (ByteBuffer)value; 283 | } else { 284 | bb = ByteBuffer.wrap((byte[])value); 285 | } 286 | statement = statement.setBytes(colName, bb); 287 | break; 288 | case TIMESTAMP: 289 | if (value instanceof String) { 290 | statement = statement.setTimestamp(colName, getTimeStamp((String) value)); 291 | } else if (value instanceof Integer || value instanceof Long) { 292 | Calendar cal = new GregorianCalendar(); 293 | Long val = (Long) value; 294 | cal.setTimeInMillis(val); 295 | statement = statement.setTimestamp(colName, cal.getTime()); 296 | } else { 297 | String errMsg = "Timestamp can be set as string or integer or long only."; 298 | LOG.info(errMsg); 299 | throw new IllegalArgumentException(errMsg); 300 | } 301 | break; 302 | default: 303 | String errMsg = "Column type " + typeName + " for " + colName + 304 | " not supported yet."; 305 | LOG.error(errMsg); 306 | throw new IllegalArgumentException(errMsg); 307 | } 308 | return statement; 309 | } 310 | 311 | private BoundStatement bindByType(BoundStatement statement, Schema schema, Object value, 312 | DataType colType) { 313 | switch (schema.type()) { 314 | case INT8: 315 | statement = statement.setInt(schema.name(), (Byte)value); 316 | break; 317 | case INT16: 318 | statement = statement.setShort(schema.name(), (Short)value); 319 | break; 320 | case INT32: 321 | statement = statement.setInt(schema.name(), (Integer)value); 322 | break; 323 | case INT64: 324 | statement = statement.setLong(schema.name(), (Long)value); 325 | break; 326 | case FLOAT32: 327 | statement = statement.setFloat(schema.name(), (Float)value); 328 | break; 329 | case FLOAT64: 330 | statement = statement.setDouble(schema.name(), (Double)value); 331 | break; 332 | case BOOLEAN: 333 | statement = statement.setBool(schema.name(), (Boolean)value); 334 | break; 335 | case STRING: 336 | // TODO: Check the table type and convert types like timestamp. 337 | // if (colType == TIMESTAMP) { } else { 338 | statement = statement.setString(schema.name(), (String)value); 339 | break; 340 | case BYTES: 341 | ByteBuffer bb = null; 342 | if (value instanceof ByteBuffer) { 343 | bb = (ByteBuffer)value; 344 | } else { 345 | bb = ByteBuffer.wrap((byte[])value); 346 | } 347 | statement = statement.setBytes(schema.name(), bb); 348 | break; 349 | default: 350 | String errMsg = "Schema type " + schema.type() + " for " + schema.name() + 351 | " not supported yet."; 352 | LOG.error(errMsg); 353 | throw new IllegalArgumentException(errMsg); 354 | } 355 | return statement; 356 | } 357 | 358 | // Helper function to sanitize the record value json/map keys and also return a column name 359 | // mapping table (lower case) names to value keys. 360 | private Map sanitizeAndGetColumns(Map valueMap) { 361 | if (valueMap.keySet().size() > columnNameToType.keySet().size()) { 362 | String errMsg = "Sink record json cannot have more columns than the table."; 363 | LOG.error(errMsg + ". Record has " + valueMap.keySet() + ", table has " + 364 | columnNameToType.keySet()); 365 | throw new IllegalArgumentException(errMsg); 366 | } 367 | 368 | Map lowerToOrig = new HashMap(); 369 | // TODO: This will error out when two columns have the same name, just capitalization 370 | // difference. 371 | for (String key : valueMap.keySet()) { 372 | if (lowerToOrig.get(key.toLowerCase()) != null) { 373 | throw new IllegalArgumentException("Column name " + key + " with different " + 374 | " capitalization already present " + lowerToOrig.get(key.toLowerCase())); 375 | } 376 | lowerToOrig.put(key.toLowerCase(), key); 377 | } 378 | 379 | if (!columnNameToType.keySet().containsAll(lowerToOrig.keySet())) { 380 | String errMsg = "Sink record json cannot have more columns than the table."; 381 | LOG.error(errMsg + " Record columns are " + lowerToOrig.keySet() + 382 | ", table columns are " + columnNameToType.keySet()); 383 | throw new IllegalArgumentException(errMsg); 384 | } 385 | 386 | return lowerToOrig; 387 | } 388 | 389 | private BoundStatement bindFields(PreparedStatement statement, 390 | final SinkRecord record) { 391 | BoundStatement bound = statement.bind(); 392 | Map valueMap = ((HashMap) record.value()); 393 | Map lowerToOrig = sanitizeAndGetColumns(valueMap); 394 | 395 | for (final String colName : columnNameToType.keySet()) { 396 | Object value = valueMap.get(lowerToOrig.get(colName)); 397 | if (value == null) { 398 | LOG.info("Entry for table column '" + colName + "' not found in sink record."); 399 | bound = bound.setToNull(colName); 400 | } else { 401 | bound = bindByColumnType(bound, colName, columnNameToType.get(colName).getName(), 402 | value); 403 | } 404 | } 405 | 406 | return bound; 407 | } 408 | 409 | // Helper class to track per field in the value maps schema and value. 410 | class SchemaAndValue { 411 | private Schema schema; 412 | private Object value; 413 | 414 | public SchemaAndValue(Schema schema, Object value) { 415 | this.schema = schema; 416 | this.value = value; 417 | } 418 | } 419 | 420 | private BoundStatement bindFields(PreparedStatement statement, 421 | final Map allFields) { 422 | BoundStatement bound = statement.bind(); 423 | for (final String colName : columnNameToType.keySet()) { 424 | final SchemaAndValue sav = allFields.get(colName); 425 | if (sav == null) { 426 | LOG.info("Entry for table column " + colName + " not found in sink record."); 427 | bound = bound.setToNull(colName); 428 | } else { 429 | bound = bindByType(bound, sav.schema, sav.value, columnNameToType.get(colName)); 430 | } 431 | } 432 | return bound; 433 | } 434 | 435 | private List getStatements(final Collection records) { 436 | List boundStatements = new ArrayList(); 437 | String insert = generateInsert(getColsFromTable()); 438 | PreparedStatement preparedStatement = cassandraSession.prepare(insert); 439 | LOG.info("Insert " + insert); 440 | for (SinkRecord record : records) { 441 | LOG.info("Prepare " + record + " Key/Schema=" + record.key() + "/" + record.keySchema() 442 | + " Value/Schema=" + record.value() + "/" + record.valueSchema()); 443 | if (record.value() == null) { 444 | // Ignoring record if it has a null value (say, a newline from user). 445 | continue; 446 | } 447 | if (record.valueSchema() == null) { 448 | // Use the table schema if user has not provided one with the record. 449 | boundStatements.add(bindFields(preparedStatement, record)); 450 | continue; 451 | } 452 | if (record.valueSchema().type() != Schema.Type.MAP) { 453 | throw new IllegalArgumentException("Invalid schema for value " + 454 | record.valueSchema().type() + " expected a map."); 455 | } 456 | final Map allFields = new HashMap(); 457 | for (Field field : record.valueSchema().fields()) { 458 | allFields.put(field.name(), 459 | new SchemaAndValue(field.schema(), ((Struct) record.value()).get(field))); 460 | LOG.info("Added field " + field.name() + " of type "+ field.schema().type()); 461 | } 462 | boundStatements.add(bindFields(preparedStatement, allFields)); 463 | } 464 | return boundStatements; 465 | } 466 | } 467 | -------------------------------------------------------------------------------- /yb-cdc/README.md: -------------------------------------------------------------------------------- 1 | Using YugaByte’s Change Data Capture (CDC) API, follow these steps to use YugaByte as a data source to a Kafka or console sink: 2 | 3 | SETUP YUGABYTE 4 | 5 | 1. Install Yugabyte. 6 | 7 | https://docs.yugabyte.com/latest/quick-start/install/ 8 | 9 | 2. Create a local cluster. 10 | 11 | https://docs.yugabyte.com/latest/quick-start/create-local-cluster/ 12 | 13 | 3. Create a table on the cluster. 14 | 15 | SETUP KAFKA (Skip if Logging to Console): 16 | 17 | Avro Schemas: 18 | 19 | We support the use of avro schemas to serialize/deserialize tables. Create two avro schemas, one for the table and one for the primary key of the table. After this step, you should have two files: table_schema_path.avsc and primary_key_schema_path.avsc 20 | 21 | https://www.tutorialspoint.com/avro/avro_schemas.htm 22 | 23 | Starting the kafka services: 24 | 25 | 1. First, download confluent. 26 | 27 | ``` 28 | curl -O http://packages.confluent.io/archive/5.3/confluent-5.3.1-2.12.tar.gz 29 | tar -xvzf confluent-5.3.1-2.12.tar.gz 30 | cd confluent-5.3.1/ 31 | ``` 32 | 33 | 2. Download the bin directory and add it to the PATH var. 34 | 35 | ``` 36 | curl -L https://cnfl.io/cli | sh -s -- -b //bin 37 | export PATH=/bin:$PATH 38 | export CONFLUENT_HOME=~/code/confluent-5.3.1 39 | ``` 40 | 41 | 3. Start the zookeeper, kafka, and the avro schema registry services. 42 | 43 | ``` 44 | ./bin/confluent local start 45 | ``` 46 | 47 | 4. Create a kafka topic. 48 | 49 | ``` 50 | ./bin/kafka-topics --create --partitions 1 --topic --bootstrap-server localhost:9092 --replication-factor 1 51 | ``` 52 | 53 | 5. Start the kafka consumer 54 | 55 | ``` 56 | bin/kafka-avro-console-consumer --bootstrap-server localhost:9092 --topic --key-deserializer=io.confluent.kafka.serializers.KafkaAvroDeserializer --value-deserializer=io.confluent.kafka.serializers.KafkaAvroDeserializer 57 | ``` 58 | 59 | SETUP YB CONNECTOR: 60 | 61 | 1. In a new window, fork YugaByte’s kafka connector repository. 62 | 63 | ``` 64 | git clone https://github.com/yugabyte/yb-kafka-connector.git 65 | cd yb-kafka-connector/yb-cdc 66 | ``` 67 | 68 | 2. Start the kafka connector app. 69 | 70 | Logging to console: 71 | 72 | ``` 73 | java -jar yb_cdc_connector.jar 74 | --table_name . 75 | --master_addrs [default 127.0.0.1:7100] 76 | --[stream_id] 77 | --log_only // Flag to log to console. 78 | ``` 79 | 80 | Logging to Kafka: 81 | 82 | ``` 83 | java -jar yb_cdc_connector.jar 84 | --table_name .
85 | --master_addrs [default 127.0.0.1:7100] 86 | --[stream_id] 87 | --kafka_addrs [default 127.0.0.1:9092] 88 | --shema_registry_addrs [default 127.0.0.1:8081] 89 | --topic_name 90 | --table_schema_path 91 | --primary_key_schema_path 92 | ``` 93 | 94 | 3. In another window, write values to the table and observe the values on your chosen output stream. 95 | 96 | -------------------------------------------------------------------------------- /yb-cdc/yb-cdc-connector.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/yugabyte/yb-kafka-connector/cb577685d278d116f79b80986fb0e8f5fb86fc01/yb-cdc/yb-cdc-connector.jar --------------------------------------------------------------------------------