Example: Commenting on a UDF - Advanced SQL Engine - Teradata Database

SQL Data Definition Language Syntax and Examples

Product
Advanced SQL Engine
Teradata Database
Release Number
17.00
Published
September 2020
Language
English (United States)
Last Update
2021-01-23
dita:mapPath
wgr1555383704548.ditamap
dita:ditavalPath
lze1555437562152.ditaval
dita:id
B035-1144
lifecycle
previous
Product Category
Teradata Vantage™

Function Definition for Examples

Following is the UDF definition for the examples below:

    CREATE FUNCTION find_text
         ( searched_string VARCHAR(500), pattern VARCHAR(500) )
         RETURNS CHAR
         LANGUAGE C
         NO SQL
         EXTERNAL 
         PARAMETER STYLE SQL;

Example: Commenting on the Parameter Pattern of a UDF

This statement places a comment on the parameter pattern of the UDF find_text :

    COMMENT ON COLUMN find_text.pattern 
    IS 'The pattern matching string';

Because the object kind for this request is COLUMN, you must specify the keyword COLUMN for the object kind when you code it.

Example: Commenting on the Definition of an External UDF

This statement places a comment on the definition of the external UDF find_text :

    COMMENT ON FUNCTION find_text
    IS 'Text search function';

Because the object kind for this request is FUNCTION, you must specify the keyword FUNCTION for the object kind when you code it.