Skip to content

Commit 43fedb8

Browse files
maropuHyukjinKwon
authored andcommitted
[SPARK-31434][SQL][DOCS] Drop builtin function pages from SQL references
### What changes were proposed in this pull request? This PR intends to drop the built-in function pages from SQL references. We've already had a complete list of built-in functions in the API documents. See related discussions for more details: #28170 (comment) ### Why are the changes needed? For better SQL documents. ### Does this PR introduce any user-facing change? ![functions](https://user-images.githubusercontent.com/692303/79109009-793e5400-7db2-11ea-8cb7-4c3cf31ccb77.png) ### How was this patch tested? Manually checked. Closes #28203 from maropu/DropBuiltinFunctionDocs. Authored-by: Takeshi Yamamuro <yamamuro@apache.org> Signed-off-by: HyukjinKwon <gurwls223@apache.org> (cherry picked from commit 853c6c9) Signed-off-by: HyukjinKwon <gurwls223@apache.org>
1 parent b11a099 commit 43fedb8

8 files changed

+16
-159
lines changed

docs/_data/menu-sql.yaml

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -242,23 +242,11 @@
242242
- text: Functions
243243
url: sql-ref-functions.html
244244
subitems:
245-
- text: Build-in Functions
246-
url: sql-ref-functions-builtin.html
247-
subitems:
248-
- text: Build-in Aggregate Functions
249-
url: sql-ref-functions-builtin-aggregate.html
250-
- text: Build-in Array Functions
251-
url: sql-ref-functions-builtin-array.html
252-
- text: Build-in Date Time Functions
253-
url: sql-ref-functions-builtin-date-time.html
254-
- text: UDFs (User-Defined Functions)
255-
url: sql-ref-functions-udf.html
256-
subitems:
257-
- text: Scalar UDFs (User-Defined Functions)
258-
url: sql-ref-functions-udf-scalar.html
259-
- text: UDAFs (User-Defined Aggregate Functions)
260-
url: sql-ref-functions-udf-aggregate.html
261-
- text: Integration with Hive UDFs/UDAFs/UDTFs
262-
url: sql-ref-functions-udf-hive.html
245+
- text: Scalar UDFs (User-Defined Functions)
246+
url: sql-ref-functions-udf-scalar.html
247+
- text: UDAFs (User-Defined Aggregate Functions)
248+
url: sql-ref-functions-udf-aggregate.html
249+
- text: Integration with Hive UDFs/UDAFs/UDTFs
250+
url: sql-ref-functions-udf-hive.html
263251
- text: Datetime Pattern
264252
url: sql-ref-datetime-pattern.html

docs/sql-ref-functions-builtin-aggregate.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/sql-ref-functions-builtin-array.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/sql-ref-functions-builtin-date-time.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/sql-ref-functions-builtin-scalar.md

Lines changed: 0 additions & 22 deletions
This file was deleted.

docs/sql-ref-functions-builtin.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

docs/sql-ref-functions-udf.md

Lines changed: 0 additions & 26 deletions
This file was deleted.

docs/sql-ref-functions.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,13 @@ license: |
1919
limitations under the License.
2020
---
2121

22-
Spark SQL defines commonly used functions as built-in functions. It also provides User-Defined Functions (UDFs) to allow users to define their own functions when the system’s built-in functions are not enough to perform the desired task.
22+
Spark SQL provides two function features to meet a wide range of user needs: built-in functions and user-defined functions (UDFs).
23+
Built-in functions are commonly used routines that Spark SQL predefines and a complete list of the functions can be found in the [Built-in Functions](api/sql/) API document. UDFs allow users to define their own functions when the system’s built-in functions are not enough to perform the desired task.
24+
25+
### UDFs (User-Defined Functions)
26+
27+
User-Defined Functions (UDFs) are a feature of Spark SQL that allows users to define their own functions when the system's built-in functions are not enough to perform the desired task. To use UDFs in Spark SQL, users must first define the function, then register the function with Spark, and finally call the registered function. The User-Defined Functions can act on a single row or act on multiple rows at once. Spark SQL also supports integration of existing Hive implementations of UDFs, UDAFs and UDTFs.
28+
29+
* [Scalar User-Defined Functions (UDFs)](sql-ref-functions-udf-scalar.html)
30+
* [User-Defined Aggregate Functions (UDAFs)](sql-ref-functions-udf-aggregate.html)
31+
* [Integration with Hive UDFs/UDAFs/UDTFs](sql-ref-functions-udf-hive.html)

0 commit comments

Comments
 (0)