USER_FUNCTION_PARAMETERS
Provides information about the parameters of a C++ user-defined function (UDx).
Provides information about the parameters of a C++ user-defined function (UDx). You can only view parameters that have the Properties.visible parameter set to TRUE.
| Column Name | Data Type | Description |
|---|---|---|
SCHEMA_NAME |
VARCHAR(128) | The schema to which the function belongs. |
FUNCTION_NAME |
VARCHAR(128) | The name assigned by the user to the user-defined function. |
FUNCTION_TYPE |
VARCHAR(128) | The type of user-defined function. For example, 'User Defined Function'. |
FUNCTION_ARGUMENT_TYPE |
VARCHAR(8192) | The number and data types of input arguments for the function. |
PARAMETER_NAME |
VARCHAR(128) | The name of the parameter for the user-defined function. |
DATA_TYPE |
VARCHAR(128) | The data type of the parameter. |
DATA_TYPE_ID |
INTEGER | A number specifying the ID for the parameter's data type. |
DATA_TYPE_LENGTH |
INTEGER | The maximum length of the parameter's data type. |
IS_REQUIRED |
BOOLEAN |
Indicates whether the parameter is required or not. If set to TRUE, and you don't provide the parameter, Vertica throws an error. |
CAN_BE_NULL |
BOOLEAN |
Indicates whether the parameter can be passed as a NULL value. If set to FALSE, you pass the parameter with a NULL value, Vertica throws an error. |
COMMENT |
VARCHAR(128) | A user-supplied description of the parameter. |
Privileges
Any user can query the USER_FUNCTION_PARAMETERS table. However, users can only see table information about those UDx functions which the user has permission to use.