[FLINK-11342] Add example for every built-In TableAPI&SQL Function

• Type: Improvement
• Status: Open
• Priority: Not a Priority
• Resolution: Unresolved
• Affects Version/s: 1.7.0, 1.7.1
• Component/s: Documentation, Table SQL / API
• Labels: auto-deprioritized-major auto-deprioritized-minor
• Assignee: Unassigned
• Reporter: Hequn Cheng
• Created: 16/Jan/19 05:45
• Updated: 28/Feb/22 10:38

Description

There are a lot of built-in tableApi&SQL functions: https://ci.apache.org/projects/flink/flink-docs-master/dev/table/functions.html

Take TEMPORAL.extract(TIMEINTERVALUNIT) as an example, we have an example for it.

E.g., '2006-06-05'.toDate.extract(DAY) returns 5; '2006-06-05'.toDate.extract(QUARTER) returns 2.

The example is very helpful for users who are not familiar with the udf. And I think it would be great if we can add an example for every built-in function.

This Jira issue is an umbrella issue. As there are kinds of built-in functions, I think it would be better to create more subtasks for it. For example, add a subtask for adding examples for built-in Comparison Functions.

Issue Links

• relates to: FLINK-23804 Restructure documentation of built-in functions