SHOW DATA METRIC FUNCTIONS¶

Lists the data metric functions (DMFs) for which you have access privileges.

You can use this command to list the DMFs in the current database and schema for the session, a specified database or schema, or your entire account.

See also:

CREATE DATA METRIC FUNCTION , ALTER FUNCTION (DMF), DESCRIBE FUNCTION (DMF) , DROP FUNCTION (DMF)

Syntax¶

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

        DATABASE                 |
        DATABASE <database_name> |

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

Parameters¶

LIKE 'pattern'

Optionally filters the command output by object name. The filter uses case-insensitive pattern matching, with support for SQL wildcard characters (% and _).

For example, the following patterns return the same results:

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

. Default: No value (no filtering is applied to the output).

[ IN ... ]

Optionally specifies the scope of the command. Specify one of the following:

ACCOUNT

Returns records for the entire account.

DATABASE, . DATABASE db_name

Returns records for the current database in use or for a specified database (db_name).

If you specify DATABASE without db_name and no database is in use, the keyword has no effect on the output.

SCHEMA, . SCHEMA schema_name, . schema_name

Returns records for the current schema in use or a specified schema (schema_name).

SCHEMA is optional if a database is in use or if you specify the fully qualified schema_name (for example, db.schema).

If no database is in use, specifying SCHEMA has no effect on the output.

Default: Depends on whether the session currently has a database in use:

  • Database: DATABASE is the default (that is, the command returns the objects you have privileges to view in the database).

  • No database: ACCOUNT is the default (that is, the command returns the objects you have privileges to view in your account).

STARTS WITH 'name_string'

Optionally filters the command output based on the characters that appear at the beginning of the object name. The string must be enclosed in single quotes and is case-sensitive.

For example, the following strings return different results:

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

. Default: No value (no filtering is applied to the output)

Output¶

The command output provides DMF properties and metadata in the following columns:

Column

Description

created_on

The timestamp at which the function was created.

name

The function’s name.

schema_name

The name of the schema that the function exists in. (NULL for built-in functions.)

is_builtin

Y (yes) if the function is a built-in function; N (no) otherwise.

is_aggregate

Y (yes) if the function is an aggregate function; N (no) otherwise.

is_ansi

Y (yes) if the function is defined as part of the ANSI SQL standard; N (no) otherwise.

min_num_arguments

Minimum number of arguments.

max_num_arguments

Maximum number of arguments.

arguments

Shows the data types of the arguments and of the return value.

description

Description of the function.

catalog_name

The name of the database that the function exists in. (NULL for built-in functions.)

is_table_function

Y (yes) if the function is a table function; N (no) otherwise.

valid_for_clustering

Y (yes) if the function can be used in a CLUSTER BY expression; N (no) otherwise.

is_secure

Y (yes) if the function is a secure function; N (no) otherwise.

is_external_function

Y (yes) if the function is an external function; N (no) otherwise.

language

  • For built-in functions, this column shows SQL.

  • For user-defined functions, this column shows the language in which the function was written, such as JAVASCRIPT or SQL.

  • For external functions, this column shows EXTERNAL.

is_memoizable

Y (yes) if the function is memoizable, N (no) otherwise.

is_data_metric

Y (yes) if the function is a DMF, N (no) otherwise.

Access control requirements¶

A role used to execute this SQL command must have the following privileges at a minimum:

Privilege

Object

Notes

USAGE

Data metric function

Note that operating on any object in a schema also requires the USAGE privilege on the parent database and schema.

For instructions on creating a custom role with a specified set of privileges, see Creating custom roles.

For general information about roles and privilege grants for performing SQL actions on securable objects, see Overview of Access Control.

Usage notes¶

  • Columns that start with the prefix is_ return either Y (yes) or N (no).

  • The command does not require a running warehouse to execute.

  • The command returns a maximum of 10K records for the specified object type, as dictated by the access privileges for the role used to execute the command; any records above the 10K limit are not returned, even with a filter applied.

    To view results for which more than 10K records exist, query the corresponding view (if one exists) in the Snowflake Information Schema.

  • To post-process the output of this command, you can use the RESULT_SCAN function, which treats the output as a table that can be queried.

Examples¶

The following example lists the DMFs that you have the privileges to view in the dmfs schema of the governance database:

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              |
+--------------------------+------------------------+-------------+------------+--------------+---------+-------------------+-------------------+--------------------------------------------------------------------------------------------+-----------------------+--------------+-------------------+----------------------+-----------+----------------------+----------+---------------+----------------+
Language: English