16.20 - INSERT UDF Parameter List - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL External Routine Programming

Product
Advanced SQL Engine
Teradata Database
Release Number
16.20
Release Date
April 2020
Content Type
Programming Reference
Publication ID
B035-1147-162K
Language
English (United States)
INSERT UDFs implement the security policy for an INSERT operation. The parameter list for an INSERT UDF consists of:
  • An input parameter that takes the current session security label as the argument.
  • A result parameter that returns the current session security label if the INSERT request passed the security policy; otherwise, it returns 0. For details about the valid return values, see Return Values for INSERT or UPDATE UDFs. The return data type must be the same as the type specified in the definition of the constraint object.
  • 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 an INSERT UDF:

/*****  C source file name: insertlevel.c  *****/
   
#define SQL_TEXT Latin_Text
#include <sqltypes_td.h>
   
void InsertLevel( short int  *sess_level,
                  short int  *new_row )
{
     ...
}

The corresponding CREATE FUNCTION statement looks like this:

CREATE FUNCTION SYSLIB.InsertLevel( current_session SMALLINT )
        RETURNS SMALLINT
        LANGUAGE C
        NO SQL
        PARAMETER STYLE TD_GENERAL
        EXTERNAL NAME 'CS!insertlevel!cctests/insertlevel.c';
where:
  • Current_session is the system-defined parameter name that identifies the security label currently set for the session.
  • The RETURNS data_type is the same as the data type specified in the definition of the constraint object.
  • PARAMETER STYLE is SQL if the constraint object allows nulls; otherwise, PARAMETER STYLE is TD_GENERAL.