@@ -23,9 +23,9 @@ Table of Contents
2323## About The Project
2424
2525This is a repo of ClickHouse official Apache Flink Connector supported by the ClickHouse team.
26- The Connector supports to main Apache Flink API's
26+ The connector supports two main Apache Flink APIs:
2727- DataStreamAPI
28- - Table API
28+ - Table API (This feature is not implemented yet and is planned for a future release)
2929
3030## Supported Flink Versions
3131
@@ -77,13 +77,13 @@ ClickHouseClientConfig clickHouseClientConfig = new ClickHouseClientConfig(url,
7777```
7878If you are planning to insert RAW CSV data as is
7979
80- Create ElementConverter
80+ Create an ElementConverter
8181
8282``` java
8383ElementConverter<String , ClickHousePayload > convertorString = new ClickHouseConvertor<> (String . class);
8484```
8585
86- Create Sink it is important to set format using ` setClickHouseFormat `
86+ Create the sink and set the format using ` setClickHouseFormat `
8787
8888``` java
8989ClickHouseAsyncSink<String > csvSink = new ClickHouseAsyncSink<> (
@@ -100,7 +100,7 @@ ClickHouseAsyncSink<String> csvSink = new ClickHouseAsyncSink<>(
100100csvSink. setClickHouseFormat(ClickHouseFormat . CSV );
101101```
102102
103- And after that just wire your DataStream with Sink
103+ Finally, connect your DataStream to the sink.
104104
105105``` java
106106data. sinkTo(csvSink);
@@ -110,8 +110,16 @@ More examples and snippets can be found in our tests [flink-connector-clickhouse
110110
111111### Example
112112
113+ We have created maven based example for easy start with ClickHouse Sink
114+ Different versions for Flink
115+
116+ - [ Flink 1.17+] ( examples/maven/flink-v1.7/covid )
117+ - [ Flink 2.0.0+] ( examples/maven/flink-v2/covid )
118+
113119## Table API
114120
121+ Table API is planned for a future release. This section will be updated once available.
122+
115123### Snippet
116124
117125### Example
@@ -143,7 +151,7 @@ More examples and snippets can be found in our tests [flink-connector-clickhouse
143151
144152### Sink configuration
145153
146- Our Sink is build on top Flink ` AsyncSinkBase `
154+ Our Sink is built on top of Flink’s ` AsyncSinkBase `
147155
148156| Parameters | Description | Default Value |
149157| ---------------| ---------------------------------------------------------------------------------------| ----------|
@@ -163,7 +171,7 @@ Our Sink is build on top Flink `AsyncSinkBase`
163171
164172- All projects in this repo are tested with all [ active LTS versions] ( https://github.com/ClickHouse/ClickHouse/pulls?q=is%3Aopen+is%3Apr+label%3Arelease ) of ClickHouse.
165173- [ Support policy] ( https://github.com/ClickHouse/ClickHouse/blob/master/SECURITY.md#security-change-log-and-support )
166- - We recommend to upgrade connector continuously to not miss security fixes and new improvements
174+ - We recommend upgrading the connector continuously to not miss security fixes and new improvements
167175 - If you have an issue with migration - create and issue and we will respond!
168176
169177## Contributing
0 commit comments