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-23582][docs][table] Add documentation for session window tvf. #16963

Closed
wants to merge 4 commits into from

Conversation

beyond1920
Copy link
Contributor

What is the purpose of the change

This pr adds documentation for session window tvf.

Brief change log

  • Window-tvf.md
  • window-agg.md

Verifying this change

This change is a trivial rework / code cleanup without any test 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, 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? (docs)

@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 fd63386 (Tue Aug 24 10:52:32 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.


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 Aug 24, 2021

CI report:

Bot commands The @flinkbot bot supports the following commands:
  • @flinkbot run azure re-run the last Azure build

Copy link
Contributor

@godfreyhe godfreyhe left a comment

Choose a reason for hiding this comment

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

Thanks for the contribution, @beyond1920. I left some minor comments

docs/content.zh/docs/dev/table/sql/queries/window-tvf.md Outdated Show resolved Hide resolved
docs/content.zh/docs/dev/table/sql/queries/window-tvf.md Outdated Show resolved Hide resolved
@beyond1920
Copy link
Contributor Author

@godfreyhe Thanks for review, I've updated. Please have a look.

@godfreyhe
Copy link
Contributor

cc @wuchong

@wuchong
Copy link
Member

wuchong commented Aug 27, 2021

The documentation looks good to me. However, it seems that the session window TVF syntax missed to declare partition key. This introduces a wrong sematic when assiging session windows. We should fix it ASAP.

@beyond1920
Copy link
Contributor Author

@wuchong wu, Thanks a lot for pointing this, I've submit a pr to fix it.

-- apply aggregation on the session windowed table
> SELECT window_start, window_end, SUM(price)
FROM TABLE(
SESSION(TABLE Bid, DESCRIPTOR(bidtime), INTERVAL '3' MINUTES))
Copy link
Member

Choose a reason for hiding this comment

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

Could you update the example to show a partitioned session window? I think that is a more usable use case.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

@beyond1920
Copy link
Contributor Author

@wuchong Jark, I've updated the pr to add an example to show a partitioned session window and rebase, please have a look again.

@tillrohrmann
Copy link
Contributor

@wuchong can we merge this PR?

@wuchong
Copy link
Member

wuchong commented Nov 11, 2021

@tillrohrmann , we discussed to rework the syntax of session window TVF in FLINK-24024. There would be a new docs PR to illustrate the new syntax. So I think we can close this PR for now. What do you think @beyond1920 ?

@beyond1920
Copy link
Contributor Author

@wuchong @tillrohrmann I prefer to close this pull request. I would create a new pull request after we upgrade the syntax of session window.

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