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

[hotfix] [docs]Fix miss semicolon on SELECT & WHERE clause example sql #25673

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

camilesing
Copy link
Contributor

What is the purpose of the change

(For example: This pull request makes task deployment go through the blob server, rather than through RPC. That way we avoid re-transferring them on each deployment (during recovery).)
Fix miss semicolon on SELECT & WHERE clause example sql.

Brief change log

Add semicolon for miss semicolon example sql.

Verifying this change

Since the changes affect the doc examples and there are no tests. I copied the snippets and verified (compiled) them locally.

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? (not applicable / docs / JavaDocs / not documented)

@flinkbot
Copy link
Collaborator

flinkbot commented Nov 22, 2024

CI report:

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

Copy link
Contributor

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

IIRC semicolon is just a statement terminator and it always should be used to inform parser that the statement is finished, so it is ok to not specify it in such doc having this in mind.
Even more there is no concrete example with concrete environment.
For instance if we try to use these examples with Flink SQL Client then yes we need to use semicolon, however if we try to use this with Table SQL then there is no need for that

@camilesing
Copy link
Contributor Author

Thanks for the contribution

IIRC semicolon is just a statement terminator and it always should be used to inform parser that the statement is finished, so it is ok to not specify it in such doc having this in mind. Even more there is no concrete example with concrete environment. For instance if we try to use these examples with Flink SQL Client then yes we need to use semicolon, however if we try to use this with Table SQL then there is no need for that

I know what you mean. But I suggest it's better to unify it in the docs, rather than having some IIRC and others not @snuyanzin

@snuyanzin
Copy link
Contributor

then I don't think the unification is limited only to select.md

you can have a look at
https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/dev/table/sql/queries/limit/
https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/dev/table/sql/queries/orderby/
https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/dev/table/sql/queries/joins/
https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/dev/table/sql/queries/group-agg/
and many more including chinese version
and you'll see that lots of queries are without semicolon
and also I think it would make sense to ask for instance in ML whether the community is ok with such unification (not sure about this yet..)

@camilesing
Copy link
Contributor Author

then I don't think the unification is limited only to select.md

you can have a look at https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/dev/table/sql/queries/limit/ https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/dev/table/sql/queries/orderby/ https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/dev/table/sql/queries/joins/ https://nightlies.apache.org/flink/flink-docs-release-1.20/docs/dev/table/sql/queries/group-agg/ and many more including chinese version and you'll see that lots of queries are without semicolon and also I think it would make sense to ask for instance in ML whether the community is ok with such unification (not sure about this yet..)

You might be right in a way. So, who will ask for the mailing list? @snuyanzin

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

Successfully merging this pull request may close these issues.

4 participants