SHOW FUNCTIONS¶
Lists native, user-defined, and external functions, or functions defined in machine learning models.
For more information, see Function and Stored Procedure Reference, User-Defined Functions Overview, Writing External Functions, and Snowpark ML Ops: Model Registry
- See also:
SHOW USER FUNCTIONS , SHOW EXTERNAL FUNCTIONS , CREATE FUNCTION , DROP FUNCTION , ALTER FUNCTION , DESCRIBE FUNCTION
Syntax¶
SHOW FUNCTIONS [ LIKE '<pattern>' ]
[ IN
{
ACCOUNT |
CLASS <class_name> |
DATABASE |
DATABASE <database_name> |
MODEL <model_name>
[ VERSION <version_name> ] |
SCHEMA |
SCHEMA <schema_name> |
<schema_name>
}
]
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.
CLASS class_name
Returns records for the specified class (
class_name
).DATABASE
, .DATABASE db_name
Returns records for the current database in use or a specified database (
db_name
).If you specify
DATABASE
withoutdb_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-qualifiedschema_name
(e.g.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).
MODEL model_name
, .MODEL model_name VERSION version_name
Returns records for the specified version (
version_name
) of the specified machine learning model (model_name
).If a version is not specified, records are displayed for the model’s default version.
Output¶
The output varies depending on whether you are showing functions in a model or in another type of function.
Most Kinds of Functions¶
For most kinds of functions, but not methods of machine learning models, the command output provides function properties and metadata in the following columns:
Column |
Description |
---|---|
|
The timestamp at which the function was created. |
|
The function’s name. |
|
The name of the schema that the function exists in. (NULL for built-in functions.) |
|
|
|
|
|
|
|
Minimum number of arguments. |
|
Maximum number of arguments. |
|
The data types of the arguments and of the return value. Optional arguments are displayed with the |
|
Description of the function. |
|
The name of the database that the function exists in. (NULL for built-in functions.) |
|
|
|
|
|
|
|
|
|
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”. |
|
|
|
This column is a placeholder for future functionality. |
Note
Methods of machine learning models are not included in the output.
Machine Learning Models¶
For methods of machine learning models, the SHOW FUNCTIONS IN MODEL command output instead provides function properties and metadata in the following columns:
Column |
Description |
---|---|
|
The timestamp at which the function was created. |
|
The function’s name. |
|
The name of the model version that the function exists in. |
|
Minimum number of arguments. |
|
Maximum number of arguments. |
|
The data types of the argument. Optional arguments are displayed with the DEFAULT keyword. |
|
The data type of the return value. |
|
Description of the function. |
|
The language in which the function was written, such as “PYTHON”. |
Note
Only methods of machine learning models are included in the output.
Usage Notes¶
Columns that start with the prefix
is_
return eitherY
(yes) orN
(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.
If you specify
CLASS
, the command only returns the following columns:| name | min_num_arguments | max_num_arguments | arguments | descriptions | language |
The output of this command might include objects with names like
SN_TEMP_OBJECT_<n>
(where<n>
is a number). These are temporary objects that are created by the Snowpark library on behalf of the user.
Examples¶
Show all functions:
SHOW FUNCTIONS;
Show only functions matching the specified regular expression:
SHOW FUNCTIONS LIKE 'SQUARE'; ------------+--------+-------------+------------+--------------+---------+-------------------+-------------------+----------------------------------------------------------------------+------------------------------------------------------------+----------+---------------+----------------+ created_on | name | schema_name | is_builtin | is_aggregate | is_ansi | min_num_arguments | max_num_arguments | arguments | description | language | is_memoizable | is_data_metric | ------------+--------+-------------+------------+--------------+---------+-------------------+-------------------+----------------------------------------------------------------------+------------------------------------------------------------+----------+---------------+----------------+ | SQUARE | | Y | N | Y | 1 | 1 | SQUARE(NUMBER(38,0)) RETURN NUMBER(38,0), SQUARE(FLOAT) RETURN FLOAT | Compute the square of the input expression. | SQL | N | N | ------------+--------+-------------+------------+--------------+---------+-------------------+-------------------+----------------------------------------------------------------------+------------------------------------------------------------+----------+---------------+----------------+