Apache Doris 函数管理指南：SHOW FUNCTIONS 命令详解

概述

在 Apache Doris 分布式分析数据库中，函数是数据处理的重要工具。本文将深入解析 SHOW FUNCTIONS 命令的使用方法，帮助开发者和管理员全面了解数据库中的函数资源。

命令语法

SHOW FUNCTIONS 命令提供了多种语法形式，满足不同场景下的查询需求：

基础语法

SHOW [FULL] [BUILTIN] FUNCTIONS [{IN | FROM} <db>] [LIKE '<function_pattern>']

全局函数查询语法

SHOW GLOBAL [FULL] FUNCTIONS [LIKE '<function_pattern>']

参数详解

必选参数

函数名称模式（function_pattern）：

• 使用 SQL LIKE 语法模式匹配函数名称
• 支持通配符 %（匹配任意多个字符）和 _（匹配单个字符）

可选参数

1. FULL：

   • 显示函数的完整信息，包括签名、返回类型、函数类型等
   • 不加此参数时仅显示函数名称

2. BUILTIN：

   • 仅显示系统内置函数
   • 不加此参数时显示所有函数（包括自定义函数）

3. 数据库名称（db）：

   • 指定查询的数据库范围
   • 不加此参数时默认查询当前数据库

返回结果说明

当使用 FULL 参数时，返回结果包含以下详细列：

列名	说明
Signature	函数签名（名称+参数类型）
Return Type	函数返回值类型
Function Type	函数类型（标量/聚合/别名等）
Intermediate Type	中间结果类型（聚合函数使用）
Properties	函数属性详情（如实现文件路径、MD5校验等）

权限要求

执行此命令需要至少具备以下权限：

• 对目标函数的 SHOW_PRIV 权限

实用示例

示例1：查看数据库中的完整函数信息

SHOW FULL FUNCTIONS IN testDb;

典型输出：

*************************** 1. row ***************************
Signature: my_add(INT,INT)
Return Type: INT
Function Type: Scalar
Intermediate Type: NULL
Properties: {"symbol":"_ZN9doris_udf6AddUdfEPNS_15FunctionContextERKNS_6IntValES4_","object_file":"http://host:port/libudfsample.so","md5":"cfe7a362d10f3aaf6c49974ee0f1f878"}

示例2：查询特定模式的内置函数

SHOW BUILTIN FUNCTIONS IN testDb LIKE 'year%';

输出：

+---------------+
| Function Name |
+---------------+
| year          |
| years_add     |
| years_diff    |
| years_sub     |
+---------------+

示例3：查看全局函数

SHOW GLOBAL FULL FUNCTIONS;

输出：

*************************** 1. row ***************************
Signature: decimal(ALL, INT, INT)
Return Type: VARCHAR
Function Type: Alias
Intermediate Type: NULL
Properties: {"parameter":"col, precision, scale","origin_function":"CAST(`col` AS decimal(`precision`, `scale`))"}

最佳实践建议

1. 函数发现：使用 LIKE 子句配合通配符可以快速定位特定功能的函数

2. 版本管理：通过 FULL 选项查看的 Properties 中的 MD5 值可用于校验函数实现文件的一致性

3. 权限控制：合理分配 SHOW_PRIV 权限，避免敏感函数信息泄露

4. 性能考虑：在大型数据库中使用模式匹配可以显著减少返回结果数量，提高查询效率

5. 开发调试：通过查看函数签名和返回类型可以快速验证函数调用方式是否正确

通过掌握 SHOW FUNCTIONS 命令，您可以更好地管理和利用 Apache Doris 中的函数资源，提高数据处理的效率和灵活性。