DESCRIBE FUNCTION (Snowpark Container Services)

描述指定的 服务功能，包括签名（参数）、返回值、语言和正文（ Snowpark Container Services 服务的路径）。

另请参阅：

服务函数、CREATE FUNCTION、ALTER FUNCTION、DROP FUNCTION

语法

{ DESC | DESCRIBE } FUNCTION [ IF EXISTS ] <name> ( [ <arg_data_type> ] [ , ... ] )
Copy

必填参数

name

指定要描述的服务函数的标识符。如果标识符包含空格或特殊字符，则整个字符串必须放在双引号内。放在双引号内的标识符也区分大小写。

( [ arg_name arg_data_type ] [ , ... ] )

指定服务函数的实参/输入。这些实参应该与服务所期望的实参相对应。

如果没有实参，则包括不带任何实参名称和数据类型的括号。

访问控制要求

用于执行此操作的 角色 必须至少具有以下 权限：

权限

对象

备注

USAGE

服务函数

要对架构中的任何对象执行操作，需要对父数据库和架构具有 USAGE 权限。

有关创建具有指定权限集的自定义角色的说明，请参阅 创建自定义角色。

有关对 安全对象 执行 SQL 操作的相应角色和权限授予的一般信息，请参阅 访问控制概述。

使用说明

  • To post-process the output of this command, you can use the pipe operator (->>) or the RESULT_SCAN function. Both constructs treat the output as a result set that you can query.

    此命令的输出列名称以小写形式生成。如果您通过管道运算符或 RESULT_SCAN 函数使用此命令的结果集，请在查询中对列名使用 加双引号的标识符，以确保它们与已扫描输出中的列名相匹配。例如，如果输出列的名称为 type，则为标识符指定 "type"。

示例

在 教程 1 中，您可以创建一个服务函数 (my_echo_udf)。以下 DESC FUNCTION 命令返回了服务函数描述：

DESC FUNCTION my_echo_udf(VARCHAR);
Copy

输出示例：

+--------------------+----------------------+
| property           | value                |
|--------------------+----------------------|
| signature          | (INPUTTEXT VARCHAR)  |
| returns            | VARCHAR              |
| language           | NULL                 |
| null handling      | CALLED ON NULL INPUT |
| volatility         | VOLATILE             |
| body               | /echo                |
| headers            | null                 |
| context_headers    | null                 |
| max_batch_rows     | not set              |
| service            | ECHO_SERVICE         |
| service_endpoint   | echoendpoint         |
| max_batch_retries  | 3                    |
| on_batch_failure   | ABORT                |
| batch_timeout_secs | not set              |
+--------------------+----------------------+
语言: 中文