SHOW DATA METRIC FUNCTIONS

列出您具有访问权限的 数据指标函数 (DMFs)。

您可以使用此命令列出会话的当前数据库和架构、指定的数据库或架构,或者整个账户中的 DMFs。

另请参阅:

CREATE DATA METRIC FUNCTIONALTER FUNCTION (DMF)DESCRIBE FUNCTION (DMF)DROP FUNCTION (DMF)

语法

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

        DATABASE                 |
        DATABASE <database_name> |

        SCHEMA                   |
        SCHEMA <schema_name>     |
        <schema_name>
      }
  ]
  [ STARTS WITH '<name_string>' ]
Copy

参数

LIKE 'pattern'

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

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

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

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

[ IN ... ]

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

ACCOUNT

返回整个账户的记录。

DATABASE. DATABASE db_name

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

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

SCHEMA. SCHEMA schema_name. schema_name

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

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

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

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

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

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

STARTS WITH 'name_string'

(可选)根据对象名称开头显示的字符筛选命令输出。该字符串必须放在单引号内并且 区分大小写

例如,以下字符串会返回 不同的 结果:

... STARTS WITH 'B' ...
... STARTS WITH 'b' ...

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

输出

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

描述

created_on

创建函数时的时间戳。

name

函数的名称。

schema_name

函数所在架构的名称。(NULL 用于内置函数。)

is_builtin

如果函数是内置函数,则为 Y (是),否则为 N (否)。

is_aggregate

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

is_ansi

如果函数被定义为 ANSI SQL 标准的一部分,则为 Y (是),否则为 N (否)。

min_num_arguments

最小实参数量。

max_num_arguments

最大实参数量。

arguments

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

description

函数的描述。

catalog_name

函数所在数据库的名称。(NULL 用于内置函数。)

is_table_function

如果函数是表函数,则为 Y (是),否则为 N (否)。

valid_for_clustering

如果函数可以在 CLUSTER BY 表达式中使用,则为 Y (是),否则为 N (否)。

is_secure

如果函数是安全函数,则为 Y (是),否则为 N (否)。

is_external_function

如果函数是外部函数,则为 Y (是),否则为 N (否)。

language

  • 对于内置函数,此列显示 SQL

  • 对于用户定义的函数,此列显示编写函数时使用的语言,例如 JAVASCRIPTSQL

  • 对于外部函数,此列显示 EXTERNAL

is_memoizable

如果函数可记忆,则为 Y(是),否则为 N(否)。

is_data_metric

如果函数是 DMF,则为 Y(是),否则为 N(否)。

访问控制要求

用于执行此 SQL 命令的 角色 必须至少具有以下 权限

权限

对象

备注

USAGE

数据指标函数

请注意,对架构中的对象进行操作还需要对父数据库和架构具有 USAGE 权限。

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

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

使用说明

  • 以前缀 is_ 开头的列返回 Y (yes) 或 N (no)。

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

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

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

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

示例

以下示例列出了您有权在 governance 数据库的 dmfs 架构中查看的 DMFs:

USE SCHEMA governance.dmfs;

SHOW DATA METRIC FUNCTIONS;
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 | is_external_function | language | is_memoizable | is_data_metric |
+--------------------------+------------------------+-------------+------------+--------------+---------+-------------------+-------------------+--------------------------------------------------------------------------------------------+-----------------------+--------------+-------------------+----------------------+-----------+----------------------+----------+---------------+----------------+
| 2023-12-11T23:30:02.785Z | COUNT_POSITIVE_NUMBERS | DMFS        | N          | N            | N       | 1                 | 1                 | "COUNT_POSITIVE_NUMBERS(TABLE(NUMBER, NUMBER, NUMBER)) RETURNS NUMBER"                     | user-defined function | GOVERNANCE   | N                 | N                    | N         | N                    | SQL      | N             | Y              |
+--------------------------+------------------------+-------------+------------+--------------+---------+-------------------+-------------------+--------------------------------------------------------------------------------------------+-----------------------+--------------+-------------------+----------------------+-----------+----------------------+----------+---------------+----------------+
语言: 中文