[FLINK-15479]Override explainSource method for JDBCTableSource #10769

wangxlong · 2020-01-05T14:43:16Z

What is the purpose of the change

Override explainSource method for JDBCTableSource.

Brief change log

Add explainSource for JDBCTableSource.

Verifying this change

(Please pick either of the following options)
This change is a trivial work without any test coverage.

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

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

Documentation

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

flinkbot · 2020-01-05T14:45:14Z

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 7fe9e7e (Sun Jan 05 14:45:13 UTC 2020)

Warnings:

No documentation files were touched! Remember to keep the Flink docs up to date!
This pull request references an unassigned Jira ticket. According to the code contribution guide, tickets need to be assigned before starting with the implementation work.

_{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-01-05T15:10:19Z

CI report:

7fe9e7e Travis: SUCCESS Azure: FAILURE
78085a6 Travis: FAILURE Azure: FAILURE
9f9c590 Travis: SUCCESS Azure: SUCCESS
ea00615 Travis: SUCCESS Azure: SUCCESS
86a1280 Travis: FAILURE Azure: FAILURE
4e1d0a8 Travis: SUCCESS Azure: SUCCESS
7d5e177 Travis: SUCCESS 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

wuchong · 2020-01-06T02:07:53Z

@wangxlong could you add a test for jdbc project push down?

godfreyhe · 2020-01-06T02:22:41Z

I think we should fix the default implementation of explainSource in TableSource which returns the field names from getProducedDataType instead of getTableSchema. Table schema is a logical description of a table and should not be part of the physical TableSource, while the value of explainSource should be changed with optimization (e.g. projection push down)

JingsongLi

Thanks @wangxlong , As @wuchong suggestion, can you add tests to verify?

I think we should fix the default implementation of explainSource in TableSource

+1, but we can fix it in 1.11? It is non-minor change, better to do it in 1.11, we can create a JIRA to discuss it more.

wangxlong · 2020-01-06T06:46:16Z

Thank you for your advice@wuchong @godfreyhe @JingsongLi . It is my duty to add a jdbc project push down test to verify. I am ok to fix it in 1.11.
From my side, there are two aspects need to be discussed:
1、How to fix it. I agree with @godfreyhe, we should fix the default implementation of explainSource in TableSource, just like follow:
List<String> fieldNames = ((RowType) getProducedDataType().getLogicalType()).getFieldNames(); return TableConnectorUtils.generateRuntimeName( getClass(), fieldNames.stream().toArray(String[]::new));
2、How to add a test to verify it.
I found there is a test to verify jdbc push down in JDBCTableSourceSinkFactoryTest#testJDBCWithFilter. I think the name of method maybe not good. We can change it to testJDBCFieldsProjection. On the basis of this test, we can add some code to verify source description just like follow:
List<String> fieldNames = ((RowType) actual.getProducedDataType().getLogicalType()).getFieldNames(); String expectedSourceDescription = actual.getClass().getSimpleName() + "(" + String.join(", ", fieldNames.stream().toArray(String[]::new)) + ")"; assertEquals(expectedSourceDescription ,actual.explainSource());
Thank you all, I also comment in the relative jira. Looking forward to your reply.

JingsongLi · 2020-01-06T06:52:42Z

Hi @wangxlong , What I mean:

If we fix it in JDBCTableSource, it should be in 1.10 and 1.9.
If we fix it in TableSource, it should be in 1.11.

Option 1 and Option 2 can be two things to finish. (We can do option 1 in 1.10 and 1.9, do option 2 in master)

wangxlong · 2020-01-06T07:47:27Z

Hi @wangxlong , What I mean:

If we fix it in JDBCTableSource, it should be in 1.10 and 1.9.

If we fix it in TableSource, it should be in 1.11.

Option 1 and Option 2 can be two things to finish. (We can do option 1 in 1.10 and 1.9, do option 2 in master)

@JingsongLi I am sorry. It is my misunderstanding. I have added a test.

Should I close this, and then open two pull request against release-1.9 and release-1.10? Or we can also do option1 on master, This maybe not conflict with option2?

BTW, Should I open a JIRA to discuss option2?

JingsongLi · 2020-01-08T09:51:26Z

@wangxlong Yes, you can.
LGTM +1
CC: @wuchong

wuchong · 2020-01-08T11:28:07Z

...ink-jdbc/src/test/java/org/apache/flink/api/java/io/jdbc/JDBCTableSourceSinkFactoryTest.java

+		// test jdbc table source description
+		List<String> fieldNames = ((RowType) actual.getProducedDataType().getLogicalType()).getFieldNames();
+		String expectedSourceDescription = actual.getClass().getSimpleName()
+			+ "(" + String.join(", ", fieldNames.stream().toArray(String[]::new)) + ")";


I think we should add an integreation test to verify the JDBC source can work when project is pushed down.

@wuchong Good idea. I have updated.

JingsongLi · 2020-01-14T03:08:56Z

ping @wuchong

wuchong

Thanks for the great effort @wangxlong .
Regarding to the integration tests, I have some suggestions:

Could you use Blink planner instead of Old planner? Because Old planner is deprecated, and all the new features are added to Blink planner.
Could you use DDL to create JDBC tables to have a better coverage? registerTableSource is derpected.
Could you move the instantiation of tEnv to static member field? This can avoid repetitive SPI discovery.

wuchong · 2020-01-14T03:22:52Z

...ectors/flink-jdbc/src/test/java/org/apache/flink/api/java/io/jdbc/JDBCTableSourceITCase.java

+/**
+ * IT case for {@link JDBCTableSource}.
+ */
+


remove empty line.

…urceITCase

wangxlong · 2020-01-14T09:46:51Z

Thanks @wuchong, I have updated.

wuchong · 2020-01-14T13:12:53Z

...ectors/flink-jdbc/src/test/java/org/apache/flink/api/java/io/jdbc/JDBCTableSourceITCase.java

+		" 'connector.driver' = 'org.apache.derby.jdbc.EmbeddedDriver' " +
+		")";
+
+	static {


Please use @BeforeClass instead of static code block.

Thanks, Done.

wuchong · 2020-01-14T13:14:11Z

flink-connectors/flink-jdbc/pom.xml

+			<groupId>org.apache.flink</groupId>
+			<artifactId>flink-table-planner-blink_${scala.binary.version}</artifactId>
+			<version>${project.version}</version>
+			<scope>provided</scope>


Can we set the scope only for test?

Yes, It is ok to set scope as test. But I don't know why set provide in old planner before.

wangxlong · 2020-01-16T14:33:08Z

ping @wuchong

wuchong

Thanks @wangxlong for the effort, LGTM.

… to fix project pushdown (#10769)

[FLINK-15479]override explainSource method for JDBCTableSource

7fe9e7e

rmetzger added the review=description? label Jan 5, 2020

rmetzger added the component=Connectors/JDBC label Jan 5, 2020

JingsongLi requested changes Jan 6, 2020

View reviewed changes

[FLINK-15479]add jdbc project push down test

78085a6

[FLINK-15479]fix code style fail

9f9c590

wuchong reviewed Jan 8, 2020

View reviewed changes

[FLINK-15479]Add integration test for JDBCTableSource

ea00615

wuchong requested changes Jan 14, 2020

View reviewed changes

wangxlong added 2 commits January 14, 2020 17:42

[FLINK-15479][CONNECTOR-JDBC]use blink planner and ddl in JDBCTableSo…

14cb254

…urceITCase

[FLINK-15479][CONNECTOR-JDBC]delete useless import

86a1280

[FLINK-15479][CONNECTOR-JDBC]fix checkstyle failed

4e1d0a8

wuchong reviewed Jan 14, 2020

View reviewed changes

[FLINK-15479][CONNECTOR-JDBC] change static block to beforeclass

7d5e177

wuchong approved these changes Jan 19, 2020

View reviewed changes

wuchong merged commit 7ccc5b3 into apache:master Jan 19, 2020

wuchong pushed a commit that referenced this pull request Jan 19, 2020

[FLINK-15479][jdbc] Override explainSource method for JDBCTableSource…

770206b

… to fix project pushdown (#10769)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[FLINK-15479]Override explainSource method for JDBCTableSource #10769

[FLINK-15479]Override explainSource method for JDBCTableSource #10769

wangxlong commented Jan 5, 2020

flinkbot commented Jan 5, 2020

flinkbot commented Jan 5, 2020 •

edited

wuchong commented Jan 6, 2020

godfreyhe commented Jan 6, 2020

JingsongLi left a comment •

edited

wangxlong commented Jan 6, 2020

JingsongLi commented Jan 6, 2020

wangxlong commented Jan 6, 2020 •

edited

JingsongLi commented Jan 8, 2020

wuchong Jan 8, 2020

wangxlong Jan 9, 2020

JingsongLi commented Jan 14, 2020

wuchong left a comment

wuchong Jan 14, 2020

wangxlong commented Jan 14, 2020

wuchong Jan 14, 2020

wangxlong Jan 14, 2020

wuchong Jan 14, 2020

wangxlong Jan 14, 2020 •

edited

wangxlong commented Jan 16, 2020

wuchong left a comment

[FLINK-15479]Override explainSource method for JDBCTableSource #10769

[FLINK-15479]Override explainSource method for JDBCTableSource #10769

Conversation

wangxlong commented Jan 5, 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 Jan 5, 2020

Automated Checks

Review Progress

flinkbot commented Jan 5, 2020 • edited

CI report:

wuchong commented Jan 6, 2020

godfreyhe commented Jan 6, 2020

JingsongLi left a comment • edited

Choose a reason for hiding this comment

wangxlong commented Jan 6, 2020

JingsongLi commented Jan 6, 2020

wangxlong commented Jan 6, 2020 • edited

JingsongLi commented Jan 8, 2020

wuchong Jan 8, 2020

Choose a reason for hiding this comment

wangxlong Jan 9, 2020

Choose a reason for hiding this comment

JingsongLi commented Jan 14, 2020

wuchong left a comment

Choose a reason for hiding this comment

wuchong Jan 14, 2020

Choose a reason for hiding this comment

wangxlong commented Jan 14, 2020

wuchong Jan 14, 2020

Choose a reason for hiding this comment

wangxlong Jan 14, 2020

Choose a reason for hiding this comment

wuchong Jan 14, 2020

Choose a reason for hiding this comment

wangxlong Jan 14, 2020 • edited

Choose a reason for hiding this comment

wangxlong commented Jan 16, 2020

wuchong left a comment

Choose a reason for hiding this comment

flinkbot commented Jan 5, 2020 •

edited

JingsongLi left a comment •

edited

wangxlong commented Jan 6, 2020 •

edited

wangxlong Jan 14, 2020 •

edited