描述函数
描述
DESCRIBE FUNCTION
语句返回现有函数的基本元数据
信息。元数据包括函数名称、实现类和使用细节。如果指定了可选的
EXTENDED
选项，则基本
元数据将与扩展使用信息一起返回。
语法
{ DESC | DESCRIBE } FUNCTION [ 扩展的 ] function_name
参数
-
函数名称
指定系统中现有函数的名称。函数名称可以选用数据库名称进行限定。如果
function_name用数据库名限定，则函数从用户指定的数据库中解析，否则从当前数据库中解析。语法：
[ 数据库名称. ] 函数名称
示例
-- 描述一个内置标量函数。
-- 返回函数名称、实现类和用法
DESC FUNCTION abs;
+-------------------------------------------------------------------+
|function_desc |
+-------------------------------------------------------------------+
|Function: abs |
|Class: org.apache.spark.sql.catalyst.expressions.Abs |
|Usage: abs(expr) - 返回 数值 的 绝对值.|
+-------------------------------------------------------------------+
-- 描述一个内置标量函数。
-- 返回函数名称、实现类、用法和示例。
DESC FUNCTION EXTENDED abs;
+-------------------------------------------------------------------+
|function_desc |
+-------------------------------------------------------------------+
|Function: abs |
|Class: org.apache.spark.sql.catalyst.expressions.Abs |
|Usage: abs(expr) - 返回 数值 的 绝对值.|
|扩展 用法: |
| 示例: |
| > SELECT abs(-1); |
| 1 |
| |
+-------------------------------------------------------------------+
-- 描述一个内置聚合函数
DESC FUNCTION max;
+--------------------------------------------------------------+
|function_desc |
+--------------------------------------------------------------+
|Function: max |
|Class: org.apache.spark.sql.catalyst.expressions.aggregate.Max|
|Usage: max(expr) - 返回 数值 的 最大值 . |
+--------------------------------------------------------------+
-- 描述一个内置用户定义的聚合函数
-- 返回函数名称、实现类、用法和示例。
DESC FUNCTION EXTENDED explode
+---------------------------------------------------------------+
|function_desc |
+---------------------------------------------------------------+
|Function: explode |
|Class: org.apache.spark.sql.catalyst.expressions.Explode |
|Usage: explode(expr) - 将 数组的元素 分隔成 多行, 或者 将 映射的元素 转换成 |
| 多行 和 列. 除非 另有说明, 使用 |
| 默认的 列 名称 `col` 用于 数组的元素 或 |
| `key` 和 `value` 用于 映射的元素 . |
|扩展 用法: |
| 示例: |
| > SELECT explode(array(10, 20)); |
| 10 |
| 20 |
+---------------------------------------------------------------+