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

Jump to bottom

[FLINK-15567][table][docs] Add documentation for INSERT statements for Flink SQL #10839

Merged
merged 3 commits into from Jan 14, 2020
Merged

[FLINK-15567][table][docs] Add documentation for INSERT statements for Flink SQL #10839

merged 3 commits into from Jan 14, 2020

Conversation

wuchong
Copy link
Member

@wuchong wuchong commented Jan 13, 2020

What is the purpose of the change

We missed to add documentation for INSERT statements which should be added under "SQL" page.

Brief change log

Add insert.md and insert.zh.md under sql directory.

Verifying this change

No tests required.

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

@wuchong
Copy link
Member Author

wuchong commented Jan 13, 2020

cc @JingsongLi

@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 c5595ea (Mon Jan 13 08:33:21 UTC 2020)

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


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 Jan 13, 2020 •
edited

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

JingsongLi
JingsongLi reviewed Jan 14, 2020
View reviewed changes
Copy link
Contributor

@JingsongLi JingsongLi left a comment

Choose a reason for hiding this comment

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

Thanks @wuchong

docs/dev/table/sql/insert.md

## Run an INSERT statement

INSERT statements are specified with the `sqlUpdate()` method of the `TableEnvironment` or executed in [SQL CLI]({{ site.baseurl }}/dev/table/sqlClient.html). The method `sqlUpdate()` for INSERT statements is a lazy execution, they will be executed only when `TableEnvironment.execute(jobName)` is invoked.
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we can point to https://ci.apache.org/projects/flink/flink-docs-master/dev/table/sqlClient.html#detached-sql-queries to emphasize detach.

Copy link
Member Author

Choose a reason for hiding this comment

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

Why should we emphasize detach mode here? It is not related to the sqlUpdate() problem.

Copy link
Contributor

Choose a reason for hiding this comment

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

ok

docs/dev/table/sql/insert.md Outdated
SELECT user, cnt FROM page_view_source;

-- Overwrites the partition (date='2019-8-30', country='China') using rows in page_view_source
INSERT INTO country_page_view PARTITION (date='2019-8-30', country='China')
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you add append/overwrite dynamic partition inserting?

Copy link
Member Author

Choose a reason for hiding this comment

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

Sure.

JingsongLi
JingsongLi reviewed Jan 14, 2020
View reviewed changes
docs/dev/table/sql/insert.md Outdated
INSERT INTO country_page_view PARTITION (date='2019-8-30', country='China')
SELECT user, cnt FROM page_view_source;

-- Overwrites the partition (date='2019-8-30', country='China') using rows in page_view_source
-- Appends rows into partition (date, country), where date is static partition with value '2019-8-30',
-- country is dynamic partition whose value is dynamic determined by each row.
INSERT INTO country_page_view PARTITION (date='2019-8-30', country='China')
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove , country='China'

@JingsongLi
Copy link
Contributor

LGTM

@wuchong
Copy link
Member Author

wuchong commented Jan 14, 2020

Thanks @JingsongLi , Merging...

@wuchong wuchong merged commit b2e3967 into apache:master Jan 14, 2020
wuchong added a commit that referenced this pull request Jan 14, 2020
@wuchong
[FLINK-15567][table][docs] Add documentation for INSERT statements fo…
dc0fff9 
…r Flink SQL (#10839)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JingsongLi JingsongLi JingsongLi left review comments

Assignees
No one assigned
Labels
component=Documentation review=description?
Projects
None yet
Milestone
No milestone
4 participants
@wuchong @flinkbot @JingsongLi @rmetzger