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-35585] Add documentation for distribution #24929

Merged
merged 1 commit into from
Jun 24, 2024

Conversation

jnh5y
Copy link
Contributor

@jnh5y jnh5y commented Jun 12, 2024

What is the purpose of the change

Add documentation to cover FLIP-376.

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 Jun 12, 2024

CI report:

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

docs/content/docs/dev/table/sql/create.md Outdated Show resolved Hide resolved
@@ -406,6 +413,14 @@ Flink will assume correctness of the primary key by assuming that the columns nu

Partition the created table by the specified columns. A directory is created for each partition if this table is used as a filesystem sink.

### `DISTRIBUTED BY / DISTRIBUTED INTO`
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy the text from SupportsBucketing including examples.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Ok, I copied in the text here: https://github.com/apache/flink/pull/24929/files#diff-d0ac52822e134b21138761d84268f080defc8323a120650f956afb697a1bf5f6R422-R456

How should the links to JavaDocs/specifics be handled? (I updated some of the text; I am not sure how to line up other details.

Copy link
Contributor

Choose a reason for hiding this comment

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

You can simplify the text a bit. So that it better fits to a first-level API rather then a second-level API. First-level API is used by less experienced users.

docs/content/docs/dev/table/sql/create.md Show resolved Hide resolved
@rmetzger
Copy link
Contributor

Reads well.
+1 to merge

Copy link
Contributor

@twalthr twalthr 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 update @jnh5y.

@twalthr
Copy link
Contributor

twalthr commented Jun 24, 2024

@flinkbot run azure

@twalthr twalthr merged commit f6f8813 into apache:master Jun 24, 2024
@jnh5y jnh5y deleted the flink-35585 branch June 24, 2024 14:03
@jnh5y jnh5y restored the flink-35585 branch June 24, 2024 14:03
superdiaodiao pushed a commit to superdiaodiao/flink that referenced this pull request Jul 4, 2024
snuyanzin pushed a commit to snuyanzin/flink that referenced this pull request Jul 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants