Skip to content

Commit 97b42b0

Browse files
committed
[FLINK-35354] Add doc for host mapping feature
1 parent cbc8489 commit 97b42b0

File tree

4 files changed

+20
-5
lines changed

4 files changed

+20
-5
lines changed

docs/content.zh/docs/connectors/flink-sources/tidb-cdc.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,13 @@ Connector Options
124124
<td style="word-wrap: break-word;">(none)</td>
125125
<td>String</td>
126126
<td>TiKV cluster's PD address.</td>
127+
</tr>
128+
<tr>
129+
<td>host-mapping</td>
130+
<td>optional</td>
131+
<td style="word-wrap: break-word;">(none)</td>
132+
<td>String</td>
133+
<td>TiKV cluster's host-mapping used to configure public IP and intranet IP mapping. When the TiKV cluster is running on the intranet, you can map a set of intranet IPs to public IPs for an outside Flink cluster to access. The format is {Intranet IP1}:{Public IP1};{Intranet IP2}:{Public IP2}, e.g. 192.168.0.2:8.8.8.8;192.168.0.3:9.9.9.9.</td>
127134
</tr>
128135
<tr>
129136
<td>tikv.grpc.timeout_in_ms</td>

docs/content/docs/connectors/flink-sources/tidb-cdc.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -125,6 +125,13 @@ Connector Options
125125
<td>String</td>
126126
<td>TiKV cluster's PD address.</td>
127127
</tr>
128+
<tr>
129+
<td>host-mapping</td>
130+
<td>optional</td>
131+
<td style="word-wrap: break-word;">(none)</td>
132+
<td>String</td>
133+
<td>TiKV cluster's host-mapping used to configure public IP and intranet IP mapping. When the TiKV cluster is running on the intranet, you can map a set of intranet IPs to public IPs for an outside Flink cluster to access. The format is {Intranet IP1}:{Public IP1};{Intranet IP2}:{Public IP2}, e.g. 192.168.0.2:8.8.8.8;192.168.0.3:9.9.9.9.</td>
134+
</tr>
128135
<tr>
129136
<td>tikv.grpc.timeout_in_ms</td>
130137
<td>optional</td>

flink-cdc-connect/flink-cdc-source-connectors/flink-connector-tidb-cdc/src/main/java/org/apache/flink/cdc/connectors/tidb/TDBSourceOptions.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
package org.apache.flink.cdc.connectors.tidb;
1919

20+
import org.apache.flink.cdc.common.utils.Preconditions;
2021
import org.apache.flink.cdc.connectors.tidb.table.utils.UriHostMapping;
2122
import org.apache.flink.configuration.ConfigOption;
2223
import org.apache.flink.configuration.ConfigOptions;
@@ -27,6 +28,7 @@
2728
import org.tikv.common.TiConfiguration;
2829

2930
import java.util.Map;
31+
import java.util.Optional;
3032

3133
/** Configurations for {@link TiDBSource}. */
3234
public class TDBSourceOptions {
@@ -64,7 +66,7 @@ private TDBSourceOptions() {}
6466
.stringType()
6567
.noDefaultValue()
6668
.withDescription(
67-
"This is route map used to configure public IP and intranet IP mapping. When the TiDB cluster is running on the intranet, you can map a set of intranet IPs to public IPs for an outside Flink cluster to access. The format is {Intranet IP1}:{Public IP1};{Intranet IP2}:{Public IP2}, e.g. 192.168.0.2:8.8.8.8;192.168.0.3:9.9.9.9.");
69+
"TiKV cluster's host-mapping used to configure public IP and intranet IP mapping. When the TiKV cluster is running on the intranet, you can map a set of intranet IPs to public IPs for an outside Flink cluster to access. The format is {Intranet IP1}:{Public IP1};{Intranet IP2}:{Public IP2}, e.g. 192.168.0.2:8.8.8.8;192.168.0.3:9.9.9.9.");
6870
public static final ConfigOption<Long> TIKV_GRPC_TIMEOUT =
6971
ConfigOptions.key(ConfigUtils.TIKV_GRPC_TIMEOUT)
7072
.longType()
@@ -94,9 +96,7 @@ public static TiConfiguration getTiConfiguration(
9496
final Configuration configuration = Configuration.fromMap(options);
9597

9698
final TiConfiguration tiConf = TiConfiguration.createDefault(pdAddrsStr);
97-
if (StringUtils.isNotBlank(hostMapping)) {
98-
tiConf.setHostMapping(new UriHostMapping(hostMapping));
99-
}
99+
Optional.of(new UriHostMapping(hostMapping)).ifPresent(tiConf::setHostMapping);
100100
configuration.getOptional(TIKV_GRPC_TIMEOUT).ifPresent(tiConf::setTimeout);
101101
configuration.getOptional(TIKV_GRPC_SCAN_TIMEOUT).ifPresent(tiConf::setScanTimeout);
102102
configuration

flink-cdc-connect/flink-cdc-source-connectors/flink-connector-tidb-cdc/src/main/java/org/apache/flink/cdc/connectors/tidb/table/TiDBTableSource.java

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@
1717

1818
package org.apache.flink.cdc.connectors.tidb.table;
1919

20+
import com.sun.istack.internal.Nullable;
2021
import org.apache.flink.api.common.typeinfo.TypeInformation;
2122
import org.apache.flink.cdc.connectors.tidb.TDBSourceOptions;
2223
import org.apache.flink.cdc.connectors.tidb.TiDBSource;
@@ -52,7 +53,7 @@ public class TiDBTableSource implements ScanTableSource, SupportsReadingMetadata
5253
private final String database;
5354
private final String tableName;
5455
private final String pdAddresses;
55-
56+
@Nullable
5657
private final String hostMapping;
5758
private final StartupOptions startupOptions;
5859
private final Map<String, String> options;

0 commit comments

Comments
 (0)