sv3ndk commented on pull request #16060: URL: https://github.com/apache/flink/pull/16060#issuecomment-868958957
> I think we have two ways to improve this: > > 1. not display full syntax, but the most common used syntax or example, e.g. `CREATE FUNCTION <function_name> AS '<class_name>'`. > > 2. just displaying CLI related commands (e.g. EXIST, CLEAR, HELP, etc...) My humble opinion: I believe option [2] is preferable, which probably means to just documenting the operations listed in [CliClient.java](https://github.com/apache/flink/blob/master/flink-table/flink-sql-client/src/main/java/org/apache/flink/table/client/cli/CliClient.java#L399). I believe if we try to document SQL syntax itself, it will likely always be incomplete and out of date, which might actually contribute to end-user confusion instead of being helpful. The documentation of Flink's flavor of SQL is maintained in the [SQL](https://ci.apache.org/projects/flink/flink-docs-release-1.13/docs/dev/table/sql/overview/) section of the website. It's pretty huge and changes constantly (e.g. the awesome TVF syntax just got added recently) => maybe we should just print a link to point the user to that web page instead? -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
