DESCRIBE FUNCTION - Kinetica Docs

Displays the attributes of the given UDF/UDTF in tabular format. Users with SYSTEM ADMIN or ADMIN permission on the UDF (or all UDFs) will see the entire UDF configuration, while users with EXECUTE permissions will only see the name of the UDF & its execution mode.

DESCRIBE FUNCTION Syntax

DESC[RIBE] FUNCTION < <function name> | * >

Parameters

Name of the UDF whose attributes will be output. Use * instead to output the attributes of all UDFs.

Response

The response to DESCRIBE FUNCTION is a six-column result set:

Output Column	Description
`FUNCTION_NAME`	Name of the UDF/UDTF
`MODE`	Execution mode of the function; distributed or nondistributed
`RUN_COMMAND`	Command used to run the function
`RUN_COMMAND_ARGS`	Command arguments used to run the function
`FILE_PATHS`	List of files involved in the execution of the function
`WITH_OPTIONS`	List of key/value pairs of options used to create the function

Examples

To describe the UDF_SOS_PY_PROC UDF:

DROP FUNCTION Example

DESCRIBE FUNCTION UDF_SOS_PY_PROC

​Parameters

​Response

​Examples

Parameters

Response

Examples