Skip to content

Latest commit

 

History

History
35 lines (27 loc) · 3.24 KB

MultiArrayUDF.md

File metadata and controls

35 lines (27 loc) · 3.24 KB

MultiArrayUDF

User-defined function

Properties

Name Type Description Notes
udfInfoName String name of UDFInfo to run, format is {namespace}/{udf_name}. Can not be used with exec [optional]
language UDFLanguage [optional]
version String Type-specific version [optional]
imageName String Docker image name to use for UDF [optional]
accessCredentialsName String The name of the access credentials to use. if unset, no credentials will be configured in the environment. [optional]
resourceClass String The resource class to use for the UDF execution. Resource classes define resource limits for memory and CPUs. If this is empty, then the UDF will execute in the standard resource class of the TileDB Cloud provider. [optional]
exec String Type-specific executable text [optional]
execRaw String optional raw text to store of serialized function, used for showing in UI [optional]
resultFormat ResultFormat [optional]
taskName String name of task, optional [optional]
argument String Deprecated: Prefer to use `argument_json` instead. Argument(s) to pass to UDF function, tuple or list of args/kwargs which can be in native or JSON format [optional]
argumentsJson List<TGUDFArgument> A series of key-value pairs to be passed as arguments into the UDF. See `TGUDFNodeData.arguments` for more information. If this format is used to pass arguments, arrays will be passed into the UDF as specified by the Node placeholders passed in here, rather than the classic method of putting all array arguments in the first parameter. Either this or `argument` should be set. [optional]
storedParamUuids List<String> The UUIDs of stored input parameters (passed in a language-specific format within &quot;argument&quot;) to be retrieved from the server-side cache. Serialized in standard hex format with no {}. [optional]
storeResults Boolean store results for later retrieval [optional]
dontDownloadResults Boolean Set to true to avoid downloading the results of this UDF. Useful for intermediate nodes in a task graph where you will not be using the results of your function. Defaults to false (&quot;yes download results&quot;). [optional]
ranges QueryRanges [optional]
subarray UDFSubarray [optional]
buffers List<String> List of buffers to fetch (attributes + dimensions). Deprecated; please set arrays with `UDFArrayDetails`. [optional]
arrays List<UDFArrayDetails> Array ranges/buffer into to run UDF on [optional]
timeout Integer UDF-type timeout in seconds (default: 900) [optional]
taskGraphUuid String If set, the ID of the log for the task graph that this was part of. [optional]
clientNodeUuid String If set, the client-defined ID of the node within this task's graph. [optional]