Skip to content

Conversation

@fsk119
Copy link
Member

@fsk119 fsk119 commented Apr 13, 2021

What is the purpose of the change

Update the SQL Client doc.

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

flinkbot commented Apr 13, 2021

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 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

  • ❓ 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.

Details
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 13, 2021

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
Member

@wuchong wuchong left a 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".

Copy link
Member

@wuchong wuchong left a 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.

Copy link
Member

@wuchong wuchong left a comment

Choose a reason for hiding this comment

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

LGMT.

@wuchong
Copy link
Member

wuchong commented Apr 20, 2021

@flinkbot run azure

@wuchong wuchong closed this in 29ba187 Apr 21, 2021
wuchong pushed a commit that referenced this pull request Apr 21, 2021
xinggit pushed a commit to xinggit/flink that referenced this pull request Apr 22, 2021
@fsk119 fsk119 deleted the sql-client-doc branch September 26, 2022 02:05
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