DESCRIBE FUNCTION
說明
DESCRIBE FUNCTION
陳述式會傳回現有函數的基本元資料資訊。元資料資訊包括函數名稱、實作類別和使用細節。如果指定選用的 EXTENDED
選項,則會傳回基本元資料資訊和延伸使用資訊。
語法
{ DESC | DESCRIBE } FUNCTION [ EXTENDED ] function_name
參數
-
function_name
指定系統中現有函數的名稱。函數名稱可以選擇使用資料庫名稱限定。如果
function_name
使用資料庫限定,則會從使用者指定的資料庫解析函數,否則會從目前資料庫解析。語法:
[ database_name. ] function_name
範例
-- Describe a builtin scalar function.
-- Returns function name, implementing class and usage
DESC FUNCTION abs;
+-------------------------------------------------------------------+
|function_desc |
+-------------------------------------------------------------------+
|Function: abs |
|Class: org.apache.spark.sql.catalyst.expressions.Abs |
|Usage: abs(expr) - Returns the absolute value of the numeric value.|
+-------------------------------------------------------------------+
-- Describe a builtin scalar function.
-- Returns function name, implementing class and usage and examples.
DESC FUNCTION EXTENDED abs;
+-------------------------------------------------------------------+
|function_desc |
+-------------------------------------------------------------------+
|Function: abs |
|Class: org.apache.spark.sql.catalyst.expressions.Abs |
|Usage: abs(expr) - Returns the absolute value of the numeric value.|
|Extended Usage: |
| Examples: |
| > SELECT abs(-1); |
| 1 |
| |
+-------------------------------------------------------------------+
-- Describe a builtin aggregate function
DESC FUNCTION max;
+--------------------------------------------------------------+
|function_desc |
+--------------------------------------------------------------+
|Function: max |
|Class: org.apache.spark.sql.catalyst.expressions.aggregate.Max|
|Usage: max(expr) - Returns the maximum value of `expr`. |
+--------------------------------------------------------------+
-- Describe a builtin user defined aggregate function
-- Returns function name, implementing class and usage and examples.
DESC FUNCTION EXTENDED explode
+---------------------------------------------------------------+
|function_desc |
+---------------------------------------------------------------+
|Function: explode |
|Class: org.apache.spark.sql.catalyst.expressions.Explode |
|Usage: explode(expr) - Separates the elements of array `expr` |
| into multiple rows, or the elements of map `expr` into |
| multiple rows and columns. Unless specified otherwise, uses |
| the default column name `col` for elements of the array or |
| `key` and `value` for the elements of the map. |
|Extended Usage: |
| Examples: |
| > SELECT explode(array(10, 20)); |
| 10 |
| 20 |
+---------------------------------------------------------------+