SHOW USER FUNCTIONS

列出您拥有访问权限的所有用户定义函数 (UDFs)。使用此命令可列出指定数据库或架构(或会话的当前数据库/架构)或整个账户的 UDFs。

有关列出所有函数(包括内置函数)的命令,请参阅 SHOW FUNCTIONS

另请参阅:

SHOW FUNCTIONSSHOW EXTERNAL FUNCTIONSFUNCTIONS 视图 (Information Schema)、FUNCTIONS 视图 (Account Usage)

语法

SHOW USER FUNCTIONS [ LIKE '<pattern>' ]
  [ IN
    {
      ACCOUNT                                         |

      DATABASE                                        |
      DATABASE <database_name>                        |

      SCHEMA                                          |
      SCHEMA <schema_name>                            |
      <schema_name>

      APPLICATION <application_name>                  |
      APPLICATION PACKAGE <application_package_name>  |
    }
  ]
Copy

参数

LIKE 'pattern'

(可选)按对象名称筛选命令输出。筛选器使用 不区分大小写 的模式匹配,并支持 SQL 通配符(%_)。

例如,以下模式返回 相同的 结果:

... LIKE '%testing%' ...
... LIKE '%TESTING%' ...

. 默认:无值(不对输出应用筛选)。

[ IN ... ]

(可选)指定命令的作用域。指定以下任一项:

ACCOUNT

返回整个账户的记录。

DATABASE. DATABASE db_name

返回当前正在使用的数据库或指定数据库 (db_name) 的记录。

如果指定 DATABASE 而不指定 db_name,并且没有使用任何数据库,则关键字对输出没有影响。

备注

在数据库上下文中使用不带 IN 子句的 SHOW 命令,这样可能会导致结果低于预期。

如果不使用 IN 子句,则具有相同名称的多个对象只会显示一次。例如,如果您在 schema1 中具有表 t1 且在 schema2 中具有表 t1,并且两者都在您指定的数据库上下文的作用域内(即,您所选的数据库是 schema1schema2 的父级),则 SHOW TABLES 只会显示其中一个 t1 表。

SCHEMA. SCHEMA schema_name

返回当前正在使用的架构或指定架构 (schema_name) 的记录。

如果数据库正在使用中,或者指定了完全限定 schema_name (例如 db.schema),则 SCHEMA 是可选选项。

如果未使用任何数据库,则指定 SCHEMA 对输出没有影响。

APPLICATION application_name. APPLICATION PACKAGE application_package_name

返回命名的 Snowflake Native App 或应用程序包的记录。

默认:取决于会话当前是否正在使用数据库:

  • 数据库:DATABASE 是默认值(即该命令返回您有权在数据库中查看的对象)。

  • 无数据库:ACCOUNT 是默认值(即该命令返回您有权在账户中查看的对象)。

输出

命令输出在以下列中提供用户函数属性和元数据:

描述

created_on

用户定义函数 (UDF) 的创建时间戳。

name

UDF 的名称。

schema_name

UDF 所在架构的名称。

is_builtin

对于用户定义函数,始终为 N。有关列出所有函数(包括内置函数)的命令,请参阅 SHOW FUNCTIONS

is_aggregate

如果函数是聚合函数,则为 Y,否则为 N

is_ansi

目前不适用。

min_num_arguments

UDF 实参的最小数量。

max_num_arguments

UDF 实参的最大数量。

arguments

实参和返回值的数据类型。

description

UDF 的描述。

catalog_name

UDF 所在数据库的名称。

is_table_function

如 UDF 是表函数,则为 Y;否则为 N

valid_for_clustering

如 UDF 可在 CLUSTER BY 表达式中使用,则为 Y;否则为 N

is_secure

如果 UDF 是安全的 UDF,则为 Y;否则为 N

secrets

函数的 SECRETS 参数指定的 密钥 值的映射,其中映射密钥是密钥变量名称,映射值是密钥对象名称。

external_access_integrations

由函数的 EXTERNAL_ACCESS_INTEGRATION 参数指定的 外部访问集成 的名称。

is_external_function

如果函数是外部函数,则为 Y;否则,为 N。有关列出外部函数的命令,请参阅 SHOW EXTERNAL FUNCTIONS

language

UDF 的编程语言(例如 PYTHONSQL)。

is_memoizable

如果函数是 可记忆的,则为 Y;否则,为 N

is_data_metric

如果函数为 数据指标函数,则为 Y;否则,为 N

使用说明

  • 该命令不需要正在运行的仓库即可执行。

  • 该命令仅返回当前用户的当前角色已获授至少一项访问权限的对象。

  • MANAGE GRANTS 访问权限隐式允许其持有者查看账户中的每个对象。默认情况下,只有账户管理员(具有 ACCOUNTADMIN 角色的用户)和安全管理员(具有 SECURITYADMIN 角色的用户)才具有 MANAGE GRANTS 权限。

  • 若要对此命令的输出进行后处理,可以使用 RESULT_SCAN 函数,该函数会将输出视为可查询的表。

  • 该命令 最多 返回指定对象类型的 1 万条记录,由用于执行命令的角色的访问权限决定。即使应用了筛选器,也不会返回任何超出 1 万条限制后的记录。

    要查看存在超过 1 万条记录的结果,请在 Snowflake Information Schema 中查询相应的视图(如果存在)。

示例

显示您有权在当前数据库中查看的所有 UDFs:

SHOW USER FUNCTIONS LIKE 'ALLOWED_REGIONS%' IN SCHEMA;
Copy
---------------------------------+--------------------------+-------------+------------+--------------+---------+-------------------+-------------------+-----------------------------------------+-----------------------+----------------+-------------------+----------------------+-----------+---------+-----------------------------+----------------------+----------+---------------+----------------+
          created_on             |           name           | schema_name | is_builtin | is_aggregate | is_ansi | min_num_arguments | max_num_arguments |                arguments                |      description      |  catalog_name  | is_table_function | valid_for_clustering | is_secure | secrets | external_access_integration | is_external_function | language | is_memoizable | is_data_metric |
---------------------------------+--------------------------+-------------+------------+--------------+---------+-------------------+-------------------+-----------------------------------------+-----------------------+----------------+-------------------+----------------------+-----------+---------+-----------------------------+----------------------+----------+---------------+----------------+
 Fri, 23 Jun 1967 00:00:00 -0700 | ALLOWED_REGIONS          | PUBLIC      | N          | N            | N       | 0                 | 0                 | ALLOWED_REGIONS() RETURN ARRAY          | user-defined function | MEMO_FUNC_TEST | N                 | N                    | N         |         |                             | N                    | SQL      | Y             | N              |
 Fri, 23 Jun 1967 00:00:00 -0700 | ALLOWED_REGIONS_NON_MEMO | PUBLIC      | N          | N            | N       | 0                 | 0                 | ALLOWED_REGIONS_NON_MEMO() RETURN ARRAY | user-defined function | MEMO_FUNC_TEST | N                 | N                    | N         |         |                             | N                    | SQL      | N             | N              |
---------------------------------+--------------------------+-------------+------------+--------------+---------+-------------------+-------------------+-----------------------------------------+-----------------------+----------------+-------------------+----------------------+-----------+---------+-----------------------------+----------------------+----------+---------------+----------------+
语言: 中文