UDF

Class defining UDF objects.

Key	Value
type	object
relationship	Package -> UDFCollection -> UDF
object path	$.udfs.udfs[*]
package file path	{package-root}/udfs.yaml

Fields

Field	Type	Required	Description	Constraints	Default
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)	-	-
name	string	yes	Name of the UDF with no spaces	-	-
udf_sym	string	yes	The udf namespace this function is stored under with no spaces	-	-
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
tag	string	no	Tag for the udf e.g. 1.0.0	-	""
uuid	string | null	no	-	format: "uuid"	-

Links To

• metadata: ComponentMetadata

Used In

• UDFCollection via udfs