[FLINK-18449][table sql/api]Kafka topic discovery & partition discove… #12908

fsk119 · 2020-07-15T13:03:00Z

…ry dynamically in table api

What is the purpose of the change

Enable Kafka Connector topic discovery & partition discovery in table api.

Brief change log

Expose option 'topic-pattern' and 'scan.topic-partition-discovery.interval'
Add validation for source when setting 'topic-pattern' and 'topic' together and setting 'topic-pattern' for sink.
Read value from Table option and use the value to build kafka consumer.

Verifying this change

This change added tests and can be verified as follows:

Added integration tests for new features
Added test that validates that setting topic and topic pattern together will fail and setting 'topic-pattern' for sink will fail.

Does this pull request potentially affect one of the following parts:

Dependencies (does it add or upgrade a dependency): (yes / no)
The public API, i.e., is any changed class annotated with @Public(Evolving): (yes / no)
The serializers: (yes / no / don't know)
The runtime per-record code paths (performance sensitive): (yes / no / don't know)
Anything that affects deployment or recovery: JobManager (and its components), Checkpointing, Kubernetes/Yarn/Mesos, ZooKeeper: (yes / no / don't know)
The S3 file system connector: (yes / no / don't know)

Documentation

Does this pull request introduce a new feature? (yes / no)
If yes, how is the feature documented? (not applicable / docs / JavaDocs / not documented)

flinkbot · 2020-07-15T13:11:59Z

Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
to review your pull request. We will use this comment to track the progress of the review.

Automated Checks

Last check on commit 1a4e5ee (Wed Jul 15 13:11:58 UTC 2020)

✅no warnings

_{Mention the bot in a comment to re-run the automated checks.}

Review Progress

❓ 1. The [description] looks good.
❓ 2. There is [consensus] that the contribution should go into to Flink.
❓ 3. Needs [attention] from.
❓ 4. The change fits into the overall [architecture].
❓ 5. Overall code [quality] is good.

Please see the Pull Request Review Guide for a full explanation of the review process.

The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot approve description to approve one or more aspects (aspects: description, consensus, architecture and quality)
@flinkbot approve all to approve all aspects
@flinkbot approve-until architecture to approve everything until architecture
@flinkbot attention @username1 [@username2 ..] to require somebody's attention
@flinkbot disapprove architecture to remove an approval you gave earlier

flinkbot · 2020-07-15T13:35:58Z

CI report:

2769a8e Azure: SUCCESS

Bot commands

The @flinkbot bot supports the following commands:

@flinkbot run travis re-run the last Travis build
@flinkbot run azure re-run the last Azure build

fsk119 · 2020-07-16T04:25:45Z

@wuchong CC

wuchong

Thanks for the contribution @fsk119 , I left some comments.

wuchong · 2020-07-27T08:21:27Z

...0/src/main/java/org/apache/flink/streaming/connectors/kafka/table/Kafka010DynamicSource.java

+		Pattern pattern,
+		Properties properties,
+		DeserializationSchema<RowData> deserializationSchema) {


wuchong · 2020-07-27T08:25:07Z

...0/src/main/java/org/apache/flink/streaming/connectors/kafka/table/Kafka010DynamicSource.java

+
+	@Override
+	protected FlinkKafkaConsumerBase<RowData> createKafkaConsumer(
+		Pattern pattern,


topicPattern

wuchong · 2020-07-27T08:25:19Z

...1/src/main/java/org/apache/flink/streaming/connectors/kafka/table/Kafka011DynamicSource.java

+		Pattern topicPattern,
+		Properties properties,
+		DeserializationSchema<RowData> deserializationSchema) {


wuchong · 2020-07-27T08:25:28Z

.../src/main/java/org/apache/flink/streaming/connectors/kafka/table/KafkaDynamicSourceBase.java

+		DataType outputDataType,
+		@Nullable List<String> topics,
+		@Nullable Pattern topicPattern,
+		Properties properties,
+		DecodingFormat<DeserializationSchema<RowData>> decodingFormat,
+		StartupMode startupMode,
+		Map<KafkaTopicPartition, Long> specificStartupOffsets,
+		long startupTimestampMillis) {


wuchong · 2020-07-27T08:25:36Z

.../src/main/java/org/apache/flink/streaming/connectors/kafka/table/KafkaDynamicSourceBase.java

+		Pattern topicPattern,
+		Properties properties,
+		DeserializationSchema<RowData> deserializationSchema);


docs/dev/table/connectors/kafka.md

wuchong · 2020-07-27T09:20:51Z

docs/dev/table/connectors/kafka.md

+      <td>optional for source(use 'topic' instead if not set)</td>
+      <td style="word-wrap: break-word;">(none)</td>
+      <td>String</td>
+      <td>Topic pattern from which the table is read. It will use input value to build regex expression to discover matched topics.</td>


The regular expression for a pattern of topic names to read from. All topics with names that match the specified regular expression will be subscribed by the consumer when the job starts running. Note, only one of "topic-pattern" and "topic" can be specified for sources.

docs/dev/table/connectors/kafka.md

wuchong · 2020-08-04T05:34:00Z

...ain/java/org/apache/flink/streaming/connectors/kafka/table/KafkaDynamicTableFactoryBase.java

 		options.add(SCAN_STARTUP_TIMESTAMP_MILLIS);
+		options.add(SCAN_TOPIC_PARTITION_DISCOVERY);


wuchong · 2020-08-04T05:35:53Z

...ain/java/org/apache/flink/streaming/connectors/kafka/table/KafkaDynamicTableFactoryBase.java

+		properties.setProperty(FlinkKafkaConsumerBase.KEY_PARTITION_DISCOVERY_INTERVAL_MILLIS,
+			String.valueOf(tableOptions
+				.getOptional(SCAN_TOPIC_PARTITION_DISCOVERY)
+				.map(val -> val.toMillis())


Suggested change

.map(val -> val.toMillis())

.map(Duration::toMillis)

wuchong · 2020-08-04T05:37:27Z

...kafka-base/src/main/java/org/apache/flink/streaming/connectors/kafka/table/KafkaOptions.java

+				));
+			} else {
+				throw new ValidationException(String.format(
+					errorMessageTemp, "topic-list", tableOptions.get(TOPIC)


"topic-list" -> "topic"? We don't have "topic-list" option.

wuchong · 2020-08-04T06:31:07Z

...java/org/apache/flink/streaming/connectors/kafka/table/KafkaDynamicTableFactoryTestBase.java

@@ -139,10 +152,12 @@ public void testTableSource() {
 				Thread.currentThread().getContextClassLoader());

 		// Test scan source equals
+		KAFKA_SOURCE_PROPERTIES.setProperty("flink.partition-discovery.interval-millis", "1000");


Is it still needed? Because we have set it in static block.

wuchong · 2020-08-04T06:41:19Z

...kafka-base/src/main/java/org/apache/flink/streaming/connectors/kafka/table/KafkaOptions.java

+
+	private static boolean isSingleTopic(ReadableConfig tableOptions) {
+		// Option 'topic-pattern' is regarded as multi-topics.
+		return tableOptions.getOptional(TOPIC).isPresent() && tableOptions.get(TOPIC).split(",").length == 1;


The community recommend to use List ConfigOption for list values, framework will handle the parsing. This will also change to use ; as the separator, but this is more align with other list options. You can declare a List ConfigOption by :

public static final ConfigOption<List<String>> TOPIC = ConfigOptions .key("topic") .stringType() .asList() .noDefaultValue() .withDescription("...");

Then you can call return tableOptions.getOptional(TOPIC).map(t -> t.size() == 1).orElse(false); here.

Sorry for the late reminder.

wuchong · 2020-08-04T10:01:46Z

Btw, could you add an integration test for this?

…partition discovery for Kafka source in Table API This closes apache#12908

wuchong

LGTM.

Will merge once build is passed.

wuchong · 2020-08-19T04:33:43Z

...0/src/main/java/org/apache/flink/streaming/connectors/kafka/table/Kafka010DynamicSource.java

+			@Nullable List<String> topics,
+			@Nullable Pattern topicPattern,


Currently, it is very verbose to pass through these to parameters together here and there. An improvement is that we can use KafkaTopicsDescriptor, but this can be another issue in the future.

…partition discovery for Kafka source in Table API This closes apache#12908

rmetzger added the review=description? label Jul 15, 2020

rmetzger added component=Connectors/Kafka component=TableSQL/API labels Jul 15, 2020

wuchong reviewed Jul 27, 2020

View reviewed changes

fsk119 requested a review from wuchong July 30, 2020 04:33

wuchong reviewed Aug 4, 2020

View reviewed changes

[FLINK-18449][kafka][table] Support topic list and topic pattern and …

2769a8e

…partition discovery for Kafka source in Table API This closes apache#12908

wuchong force-pushed the FLINK-18449 branch from 4b06551 to 2769a8e Compare August 19, 2020 04:37

wuchong approved these changes Aug 19, 2020

View reviewed changes

wuchong merged commit b8ee51b into apache:master Aug 20, 2020

fsk119 deleted the FLINK-18449 branch March 17, 2021 12:03

jnh5y pushed a commit to jnh5y/flink that referenced this pull request Dec 18, 2023

[FLINK-18449][kafka][table] Support topic list and topic pattern and …

30ace4d

…partition discovery for Kafka source in Table API This closes apache#12908

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FLINK-18449][table sql/api]Kafka topic discovery & partition discove… #12908

[FLINK-18449][table sql/api]Kafka topic discovery & partition discove… #12908

fsk119 commented Jul 15, 2020

flinkbot commented Jul 15, 2020

flinkbot commented Jul 15, 2020 •

edited

fsk119 commented Jul 16, 2020

wuchong left a comment

wuchong Jul 27, 2020

wuchong Jul 27, 2020

wuchong Jul 27, 2020

wuchong Jul 27, 2020

wuchong Jul 27, 2020

wuchong Jul 27, 2020

wuchong Aug 4, 2020

wuchong Aug 4, 2020

wuchong Aug 4, 2020

wuchong Aug 4, 2020

wuchong Aug 4, 2020

wuchong commented Aug 4, 2020

wuchong left a comment

wuchong Aug 19, 2020

		options.add(SCAN_STARTUP_TIMESTAMP_MILLIS);
		options.add(SCAN_TOPIC_PARTITION_DISCOVERY);

		@Nullable List<String> topics,
		@Nullable Pattern topicPattern,

[FLINK-18449][table sql/api]Kafka topic discovery & partition discove… #12908

[FLINK-18449][table sql/api]Kafka topic discovery & partition discove… #12908

Conversation

fsk119 commented Jul 15, 2020

What is the purpose of the change

Brief change log

Verifying this change

Does this pull request potentially affect one of the following parts:

Documentation

flinkbot commented Jul 15, 2020

Automated Checks

Review Progress

flinkbot commented Jul 15, 2020 • edited

CI report:

fsk119 commented Jul 16, 2020

wuchong left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

wuchong commented Aug 4, 2020

wuchong left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

flinkbot commented Jul 15, 2020 •

edited