DESCRIBE FUNCTION
描述
DESCRIBE FUNCTION
语句返回现有函数的基本元数据信息。元数据信息包括函数名称、实现类和用法详情。
如果指定了可选的 EXTENDED
选项,则返回基本元数据信息以及扩展用法信息。
语法
{ DESC | DESCRIBE } FUNCTION [ EXTENDED ] function_name
参数
function_name
指定系统中的现有函数的名称。函数名称可以可选地用数据库名称限定。
如果function_name
用数据库名称限定,则从指定的数据库中解析函数,否则从当前数据库中解析函数。语法:
[ database_name. ] function_name
示例
-- 描述一个内置标量函数。
-- 返回函数名称、实现类和用法。
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.|
+-------------------------------------------------------------------+
-- 描述一个内置标量函数。
-- 返回函数名称、实现类、用法和示例。
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 |
| |
+-------------------------------------------------------------------+
-- 描述一个内置聚合函数。
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`. |
+--------------------------------------------------------------+
-- 描述一个内置聚合函数。
-- 返回函数名称、实现类、用法和示例。
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 |
+---------------------------------------------------------------+