UDCF Manifest File | VantageCloud Lake - UDCF Manifest File - Teradata VantageCloud Lake

Lake - Using Queries, UDFs, and External Stored Procedures
Deployment
VantageCloud
Edition
Lake
Product
Teradata VantageCloud Lake
Release Number
Published
February 2025
ft:locale
en-US
ft:lastEdition
2025-08-12
dita:mapPath
vgj1683671089901.ditamap
dita:ditavalPath
pny1626732985837.ditaval
dita:id
vgj1683671089901

Scalar manifest example

{
   "manifest_version": "v1",
   "source_language": "CPP",
   "is_deterministic": true,
   "parameter_spec": "param1 VARCHAR(10)",
   "return_spec": "VARCHAR(10)",
   "function_class": "scalar",
   "parameter_style": "sql",
   "null_call": false,
   "routine_kind": "regular_function",
   "lambda_arn": "<your lambda arn>",
   "iam_role_arn": "<your iam role arn>"
}

Table operator manifest example

{
    "manifest_version": "v1",
    "source_language": "CPP",
    "is_deterministic": true,
    "function_class": "table_operator",
    "contract_function": "my_tableoperator_contract",
    "parameter_style": "sqltable",
    "null_call": false,
    "routine_kind": "regular_function",
    "lambda_arn": "<your lambda arn>",
    "iam_role_arn": "<your iam role arn>"
}

Manifest File Property Details

Property Description
manifest_version Required

The value must be "v1" for the manifest schema version.
source_language Required

The programming language in which the UDCF is written.

Default value: CPP
is_deterministic Whether or not the UDCF returns a deterministic result.

If true, the UDCF always returns the same results if given the same input.

If false, the UDCF may return different results even when given the same input.

Default: false
parameter_spec List of input parameters for the UDCF in the format:
  • For scalar UDCFs:

    "ParamName1 Data_Type"

Allowed data_type value: VARCHAR
return_spec Required

The data type of the value returned by the UDCF.

Allowed value: VARCHAR
function_class The class of the UDCF.

Allowed values: "scalar" or "table_operator"

contract_function Optional

Use this property when function_class = table_operator.

Specifies the name of the contract function used in the table operator UDCF. If "contract_function" is not specified, the contract function name will be the name of the table operator (function_name) used in the tdextroutine udcf create command but with “_contract” appended to it.
parameter_style How parameters are passed to the UDF.
Allowed values:
  • "sql" (for scalar UDCFs) or "sqltable" (for table operator UDCFs)

    Uses indicator variables to pass arguments. Nulls can be passed as input and returned in the results.
null_call Whether or not the UDCF is called when input values are null.

If true, the function is evaluated whether or not the input parameters are null.

If false, the function is not evaluated and a null result is returned if any of the parameters are null.

Default: true
routine_kind Specifies if the UDCF is used for algorithmic compression of data.

Allowed value: "REGULAR_FUNCTION"
lambda_arn String that specifies the ARN of the Lambda created previously in the section Establish trust between your AWS Lambda Function and VantageCloud Lake Environment.
iam_role_arn String that specifies the role ARNs in the output tdextroutine udcf status in the Get the Status of the enable/disable operation of UDCFs section.