Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FLINK-17267] [table] legacy planner supports explain insert operation and introduce TableEnvironment#explainSql/Introduce TableEnvironment#explainSql api api #11905

Closed
wants to merge 7 commits into from

Conversation

godfreyhe
Copy link
Contributor

@godfreyhe godfreyhe commented Apr 24, 2020

What is the purpose of the change

For TableEnvironment#explain() method, legacy batch planner throws exception directly and legacy stream planner does not handle sink node. This pr fixes them problems first. And then, this pr aim to supports the following features: TableEnvironment#explainSql supports EXPLAIN statement; Introduce TableEnvironment#explainSql api, Introduce Table#explain api

Brief change log

  • legacy stream planner supports explain insert operation
  • legacy batch planner supports explain insert operation
  • TableEnvironment#explainSql supports EXPLAIN statement
  • Introduce TableEnvironment#explainSql api
  • Introduce Table#explain api

Verifying this change

This change added tests and can be verified as follows:

  • Extended TableEnvironmentTest/BatchTableEnvironmentTest/StreamTableEnvironmentTest to verify the features

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
Copy link
Collaborator

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 af67911 (Fri Apr 24 15:16:35 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
Copy link
Collaborator

flinkbot commented Apr 24, 2020

CI report:

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

@godfreyhe
Copy link
Contributor Author

cc @danny0405

Comment on lines 699 to 700
Returns the AST of this table and the execution plan to compute
the result of this table.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delete to compute the result of this table.?

@@ -466,6 +466,23 @@ def explain(self, table=None, extended=False):
else:
return self._j_tenv.explain(table._j_table, extended)

def explain_sql(self, stmt, *extra_details):
"""
Returns the AST of the specified statement and the execution plan to compute
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

* The changelog traits produced by a physical rel node.
* e.g. GroupAggregate(..., changelogMode=[I,UA,D])
*/
CHANGELOG_TRAITS
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how about CHANGELOG_MODE? Traits is hard to understand for users.

* @param operations The operations to be executed.
* @return the affected row counts (-1 means unknown).
*/
String explain(List<Operation> operations, ExplainDetail... extraDetails);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Rename this to explainInternal? When browsing TableEnvironmentImpl's code, it's hard to find out whether the public method is for public api or implementing some internal methods.

Copy link
Contributor

@KurtYoung KurtYoung left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants