Skip to content

Commit eecf2a9

Browse files
committed
linting fix
1 parent ab04fcf commit eecf2a9

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

docs/integrations/data-ingestion/apache-flink/flink-connector.md

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ _Note: the connector has not been tested against Flink versions earlier than 1.1
4747

4848
## Installation & Setup {#installation--setup}
4949
### Import as a Dependency {#import-as-a-dependency}
50-
#### For Flink 2.0+
50+
#### For Flink 2.0+ {#flink-2.0}
5151

5252
<Tabs>
5353
<TabItem value="Maven" label="Maven" default>
@@ -78,7 +78,7 @@ libraryDependencies += "com.clickhouse.flink" % "flink-connector-clickhouse-2.0.
7878
</TabItem>
7979
</Tabs>
8080

81-
#### For Flink 1.17+
81+
#### For Flink 1.17+ {#flink-1.17}
8282
<Tabs>
8383
<TabItem value="Maven" label="Maven" default>
8484

@@ -123,7 +123,7 @@ where:
123123
You can find all available released JAR files in the [Maven Central Repository](https://repo1.maven.org/maven2/com/clickhouse/flink/).
124124

125125
## Using the DataStream API {#using-the-datastream-api}
126-
### Snippet
126+
### Snippet {#snippet}
127127

128128
Configure ClickHouseClient
129129

@@ -143,15 +143,15 @@ ElementConverter<String, ClickHousePayload> convertorString = new ClickHouseConv
143143

144144
```java
145145
ClickHouseAsyncSink<String> csvSink = new ClickHouseAsyncSink<>(
146-
convertorString,
147-
MAX_BATCH_SIZE,
148-
MAX_IN_FLIGHT_REQUESTS,
149-
MAX_BUFFERED_REQUESTS,
150-
MAX_BATCH_SIZE_IN_BYTES,
151-
MAX_TIME_IN_BUFFER_MS,
152-
MAX_RECORD_SIZE_IN_BYTES,
153-
clickHouseClientConfig
154-
);
146+
convertorString,
147+
MAX_BATCH_SIZE,
148+
MAX_IN_FLIGHT_REQUESTS,
149+
MAX_BUFFERED_REQUESTS,
150+
MAX_BATCH_SIZE_IN_BYTES,
151+
MAX_TIME_IN_BUFFER_MS,
152+
MAX_RECORD_SIZE_IN_BYTES,
153+
clickHouseClientConfig
154+
);
155155

156156
csvSink.setClickHouseFormat(ClickHouseFormat.CSV);
157157
```
@@ -166,7 +166,7 @@ More examples and snippets can be found in our tests:
166166
- [flink-connector-clickhouse-1.17](https://github.com/ClickHouse/flink-connector-clickhouse/tree/main/flink-connector-clickhouse-1.17/src/test/java/org/apache/flink/connector/clickhouse/sink)
167167
- [flink-connector-clickhouse-2.0.0](https://github.com/ClickHouse/flink-connector-clickhouse/tree/main/flink-connector-clickhouse-2.0.0/src/test/java/org/apache/flink/connector/clickhouse/sink)
168168

169-
### Quick Start Example
169+
### Quick Start Example {#quick-start}
170170

171171
We have created maven-based example for an easy start with the ClickHouse Sink:
172172

@@ -176,7 +176,7 @@ We have created maven-based example for an easy start with the ClickHouse Sink:
176176
For more detailed instructions, see the [Example Guide](https://github.com/ClickHouse/flink-connector-clickhouse/blob/main/examples/README.md)
177177

178178
### DataStream API Connection Options {#datastream-api-connection-options}
179-
#### Clickhouse Client Options
179+
#### Clickhouse Client Options {#client-options}
180180

181181
| Parameters | Description | Default Value |
182182
|------------|--------------------------------|---------------|
@@ -186,7 +186,7 @@ For more detailed instructions, see the [Example Guide](https://github.com/Click
186186
| `database` | ClickHouse database name | N/A |
187187
| `table` | ClickHouse table name | N/A |
188188

189-
#### Sink Options
189+
#### Sink Options {#sink-options}
190190

191191
The following options come directly from Flink's `AsyncSinkBase`:
192192

@@ -203,11 +203,11 @@ The following options come directly from Flink's `AsyncSinkBase`:
203203

204204
Table API support is planned for a future release. This section will be updated once available.
205205

206-
### Snippet
206+
### Snippet {#snippet}
207207

208208
Planned for a future release — this section will provide a usage snippet for configuring the Table API.
209209

210-
### Quick Start Example
210+
### Quick Start Example {#quick-start}
211211

212212
Planned for a future release — a complete end-to-end example will be added once Table API support becomes available.
213213

@@ -271,7 +271,7 @@ Notes:
271271
* Precision and scale must be provided when performing decimal operations.
272272
* In order for ClickHouse to parse a Java String as JSON, you need to enable `enableJsonSupportAsString` in `ClickHouseClientConfig`.
273273

274-
## Metrics
274+
## Metrics {#metrics}
275275

276276
The connector exposes the following additional metrics on top of Flink's existing metrics:
277277

@@ -302,7 +302,7 @@ The connector exposes the following additional metrics on top of Flink's existin
302302
- All artifacts and versions of the connector are tested with all [active LTS versions](https://github.com/ClickHouse/ClickHouse/pulls?q=is%3Aopen+is%3Apr+label%3Arelease) of ClickHouse.
303303
- See the [ClickHouse security policy](https://github.com/ClickHouse/ClickHouse/blob/master/SECURITY.md#security-change-log-and-support) for known security vulnerabilities and how to report a vulnerability.
304304
- We recommend upgrading the connector continuously to not miss security fixes and new improvements.
305-
- If you have an issue with migration, please create a GitHub [issue](https://github.com/ClickHouse/flink-connector-clickhouse/issues) and we will respond!
305+
- If you have an issue with migration, please create a GitHub [issue](https://github.com/ClickHouse/flink-connector-clickhouse/issues) and we will respond!
306306

307307
## Contributing and Support {#contributing-and-support}
308308

0 commit comments

Comments
 (0)