file_path |
string |
yes |
Location of the filepath within the package, inferred from context |
- |
- |
function |
string |
yes |
Native function name, inferred from code |
- |
- |
language |
string |
yes |
Language, inferred from the file extension (py or q) |
- |
- |
udf_sym |
string |
yes |
The udf namespace this function is stored under with no spaces |
- |
- |
agg |
object | null |
no |
Agg function for the uda, needs to point to a valid dap function (dap_fn) |
- |
- |
category |
array<string> |
no |
The categories of the udf, list or str |
- |
[] |
description |
string |
no |
A description of the udf |
- |
"" |
metadata |
ComponentMetadata | null |
no |
- |
- |
null |
misc |
object | null |
no |
Miscellaneous information about the uda, e.g. safe |
- |
- |
name |
string | null |
no |
Name of the uda with no spaces, e.g. .example.daAPI |
- |
"" |
params |
array<UDAParam> | null |
no |
List of parameters for the uda, each parameter is a dict |
- |
- |
returns |
object | null |
no |
Return type of the uda as a dict |
- |
- |
tag |
string |
no |
Tag for the udf e.g. 1.0.0 |
- |
"" |
uuid |
string | null |
no |
- |
format: "uuid" |
- |