DOCUMENT 子句

DOCUMENT 子句中带引号的字符串提供对 UDR 的摘要和描述。该字符串存储在 sysprocbody 系统目录表中，适用于 UDR 的用户。拥有对数据库访问特权的任何人均可查询 sysprocbody 系统目录表，以获取对存储在数据库中的一个或全部 UDR 的描述。

例如，以下查询获取对 SPL 函数所显示的 SPL 函数 update_by_pct 的描述：

SELECT data FROM sysprocbody b, sysprocedures p
        WHERE b.procid = p.procid 
        --join between the two catalog tables
        AND p.procname = 'update_by_pct' 
        -- look for procedure named update_by_pct
        AND b.datakey  = 'D'-- want user document;

先前的查询返回以下文本：

USAGE: Update a price by a percentage
      Enter an integer percentage from 1 - 100
      and a part id number

UDR 或者应用程序可查询系统目录表来取出 DOCUMENT 子句并为用户显示它。

对于 C 和 Java™ 语言函数，无论您指定是否使用 END FUNCTION 关键字，均可以在 CREATE FUNCTION 语句末尾包含 DOCUMENT 子句。