-
Notifications
You must be signed in to change notification settings - Fork 13.8k
[FLINK-22171][sql-client][docs] Update the SQL Client doc #15595
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
Conversation
|
Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community Automated ChecksLast check on commit b2763a8 (Sat Aug 28 11:16:31 UTC 2021) ✅no warnings Mention the bot in a comment to re-run the automated checks. Review Progress
Please see the Pull Request Review Guide for a full explanation of the review process. DetailsThe 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 commandsThe @flinkbot bot supports the following commands:
|
wuchong
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please update the top sql client picture link to following, the picture is not found in current website.
{{< img src="/fig/sql_client_demo.gif" alt="Animated demo of the Flink SQL Client CLI running table programs on a cluster" width="80%" height="80%" >}}
Besides, I think we can improve the TOC a bit more, what do you think about the following TOC:
Getting Started
- Starting the SQL Client CLI
- Running SQL Queries
Configuration
- SQL Client startup options
- SQL Client Configuraiton
- Initialize session using SQL file
- Dependencies
Submitting SQL Jobs
- Interactive Command Line
- Execute SQL Files
- Execute a set of SQL statements
- Execute DML statements sync/async
- Start a SQL Job from a savepoint
- Define a Custom Job Name
Compatibility
Limitations & Future
In Start a SQL Job from a savepoint section, would be better to also mention "You can use Flink command line to create and manage savepoints, see more Creating a Savepoint".
wuchong
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I left some final comments.
wuchong
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGMT.
…or FLIP-163 This closes apache#15595
|
@flinkbot run azure |
…or FLIP-163 This closes #15595
…or FLIP-163 This closes apache#15595
What is the purpose of the change
Update the SQL Client doc.
Documentation