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-18598][python][docs] Add instructions for asynchronous execute in PyFlink doc. #13295

Closed

Conversation

shuiqiangchen
Copy link
Contributor

What is the purpose of the change

Add instructions for asynchronous execute in PyFlink doc

Brief change log

  • Added brief instructions for asynchronous execute in PyFlink FAQ page (faq.md).

Verifying this change

This pull request is a documentation enhancement without test case 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, Kubernetes/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 documented)

@flinkbot
Copy link
Collaborator

flinkbot commented Sep 1, 2020

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 9f2e570 (Tue Sep 01 08:27:05 UTC 2020)

Warnings:

  • 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 Sep 1, 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

Copy link
Contributor

@HuangXingBo HuangXingBo left a comment

Choose a reason for hiding this comment

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

@shuiqiangchen Thanks a lot for the PR. I only left a minor comment.

@@ -52,6 +52,19 @@ $ source venv/bin/activate
$ python xxx.py
{% endhighlight %}

**Note:** When performing asynchronous instructions in a LocalStreamEnvironment, remember to block the process, or it
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
**Note:** When performing asynchronous instructions in a LocalStreamEnvironment, remember to block the process, or it
**Note:** If you run jobs in mini-cluster asynchronously, you need to make use of `JobClient` to wait for jobs to finish.

@shuiqiangchen
Copy link
Contributor Author

@HuangXingBo Thank you for your comments, I have updated the PR according to your comments, please have a look.

@HuangXingBo
Copy link
Contributor

HuangXingBo commented Sep 3, 2020

@shuiqiangchen Thanks for the update. LGTM

@@ -52,6 +52,20 @@ $ source venv/bin/activate
$ python xxx.py
{% endhighlight %}

**Note:** When running jobs in mini-cluster asynchronously, remember to get a `JobClient` to wait for the execution to
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
**Note:** When running jobs in mini-cluster asynchronously, remember to get a `JobClient` to wait for the execution to
**Note:** When executing jobs in mini-cluster asynchronously (e.g. TableEnvironment.execute_sql, StatementSet.execute, etc in the Python Table API; StreamExecutionEnvironment.execute_async in the Python DataStream API), remember to wait for the execution to

@shuiqiangchen
Copy link
Contributor Author

@dianfu Highly appreciate for your suggestions, I have updated the PR, please have a look.

@dianfu dianfu closed this in 7da74dc Sep 5, 2020
dianfu pushed a commit that referenced this pull request Sep 5, 2020
…job execution to finish when using asynchronous APIs

This closes #13295.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
5 participants