DELETE UDF Parameter List - Analytics Database - Teradata Vantage

SQL External Routine Programming

Deployment
VantageCloud
VantageCore
Edition
Enterprise
IntelliFlex
VMware
Product
Analytics Database
Teradata Vantage
Release Number
17.20
Published
June 2022
Language
English (United States)
Last Update
2023-07-11
dita:mapPath
iiv1628111441820.ditamap
dita:ditavalPath
qkf1628213546010.ditaval
dita:id
B035-1147
lifecycle
latest
Product Category
Teradata Vantageā„¢
DELETE UDFs implement the security policy for a DELETE operation. The parameter list for a DELETE UDF consists of:
  • An input parameter that takes the security label from the target row as the argument.
  • A result parameter that returns 'T' if the DELETE request passed the security policy or 'F' if the request failed the security policy. For details about the valid return values, see Return Values for SELECT or DELETE UDFs.
  • Indicator parameters for the input and result parameters. These are required only if the constraint object allows nulls.

Here is an example of how to declare a DELETE UDF:

/*****  C source file name: deletelevel.c  *****/
   
#define SQL_TEXT Latin_Text
#include <sqltypes_td.h>
   
void DeleteLevel( short int  *curr_row,
                  char       *result )
{
     ...
}

The corresponding CREATE FUNCTION statement looks like this:

CREATE FUNCTION SYSLIB.DeleteLevel( input_row SMALLINT )
        RETURNS CHAR
        LANGUAGE C
        NO SQL
        PARAMETER STYLE TD_GENERAL
        EXTERNAL NAME 'CS!deletelevel!cctests/deletelevel.c';
where:
  • input_row is the system-defined parameter name that identifies the security label from the target row.
  • PARAMETER STYLE is SQL if the constraint object allows nulls; otherwise, PARAMETER STYLE is TD_GENERAL.