ADMIN_GET_SYSIBM_FUNCTIONS table function - Returns information about Db2 built-in functions

The ADMIN_GET_SYSIBM_FUNCTIONS table function returns information about Db2 built-in functions.

Authorization

To execute the routine, one of the following authorizations is required:
  • EXECUTE privilege on the routine
  • DATAACCESS authority
  • DBADM authority
  • SQLADM authority

Default PUBLIC privilege

In a non-restrictive database, the EXECUTE privilege is granted to PUBLIC when the function is automatically created.

Syntax

Read syntax diagramSkip visual syntax diagram ADMIN_GET_SYSIBM_FUNCTIONS ( routinename , functiontype )

The schema is SYSPROC.

Routine parameters

routinename
An input argument of type VARCHAR(128) that specifies a built-in routine name. Trailing spaces for the parameter are ignored by the function. The argument must be in upper case.
functiontype
An input argument of type CHAR(1) that specifies the type of the built-in routine. Trailing spaces for the parameter are ignored by the function. The argument must be in upper case.

If the routinename parameter and the functiontype parameter are both NULL, all the rows are returned.

Information returned

Table 1. Information returned by the ADMIN_GET_SYSIBM_FUNCTIONS routine
Column name Data type Description
ROUTINESCHEMA VARCHAR(128) The name of the schema of the built-in function. The name is always SYSIBM.
ROUTINEMODULENAME VARCHAR(128) The name of the module of the built-in function. The name is always NULL.
ROUTINENAME VARCHAR(128) The unqualified name of the routine.
ROUTINETYPE CHAR(1) The type of the routine. The type is always F.
OWNER VARCHAR(128) The owner of the built-in function. The name is always SYSIBM.
OWNERTYPE CHAR(1) The type of the owner of the built-in function. The type is always S.
SPECIFICNAME VARCHAR(128) The specific name of the built-in function. The value is SYS appended with routineid, where routineid is the value of the routineid column.
ROUTINEID INTEGER The ID of the routine of the built-in function.
ROUTINEMODULEID INTEGER The ID of the module of the built-in function. The value is always NULL.
RETURN_TYPESCHEMA VARCHAR(128) The schema of the function of the return type. If the value of the FUNCTIONTYPE column is T, the value is NULL, otherwise SYSIBM.
RETURN_TYPEMODULE VARCHAR(128) The name of the module of the function return type. The value is always NULL.
RETURN_TYPENAME VARCHAR(128) The name of the function return type. If the value of the FUNCTIONTYPE column is T, the value is NULL, otherwise the unqualified name of the return type.
ORIGIN CHAR(1) The origin for all built-in functions. The value is always B.
FUNCTIONTYPE CHAR(1) The type of the function.
S
Scalar built-in function
C
Aggregate built-in function
T
Table built-in function
PARM_COUNT SMALLINT The number of routine parameters, or 1 if the function accepts a variable number of parameters.
LANGUAGE CHAR(8) For built-in functions, this column is always left blank.
DIALECT VARCHAR(10) For built-in functions, this column is always left blank.
SOURCESCHEMA VARCHAR(128) For built-in functions, the value is always NULL.
SOURCEMODULENAME VARCHAR(128) For built-in functions, the value is always NULL.
SOURCESPECIFIC VARCHAR(128) For built-in functions, the value is always NULL.
PUBLISHED CHAR(1) For built-in functions, the value is always NULL.
DETERMINISTIC CHAR(1) Specifies whether the results are deterministic.
N
Results are not deterministic because the same parameters might produce different results in different routine calls.
Y
Results are deterministic.
EXTERNAL_ACTION CHAR(1) For built-in functions, this column is always left blank.
NULLCALL CHAR(1) For built-in functions, this column is always left blank.
CAST_FUNCTION CHAR(1) Specifies whether the function is a CAST function.
N
Not a CAST function.
Y
CAST function.
ASSIGN_FUNCTION CHAR(1) Specifies whether the function is an assignment function.
N
Not an assignment function.
Y
Assignment function.
SCRATCHPAD CHAR(1) The value for this column is always N because built-in functions do not use scratchpads.
SCRATCHPAD_LENGTH SMALLINT The value for this column is always 0.
FINALCALL CHAR(1) For built-in functions, this column is always left blank.
PARALLEL CHAR(1) For built-in functions, this column is always left blank.
PARAMETER_STYLE CHAR(8) For built-in functions, this column is always left blank.
FENCED CHAR(1) For built-in functions, this column is always left blank.
SQL_DATA_ACCESS CHAR(1) For built-in functions, this column is always left blank.
DBINFO CHAR(1) For built-in functions, this column is always left blank.
PROGRAMTYPE CHAR(1) For built-in functions, this column is always left blank.
COMMIT_ON_RETURN CHAR(1) For built-in functions, this column is always left blank.
AUTONOMOUS CHAR(1) For built-in functions, this column is always left blank.
RESULT_SETS SMALLINT For built-in functions, the value of result sets is always 0.
SPEC_REG CHAR(1) For built-in functions, this column is always left blank.
FEDERATED CHAR(1) For built-in functions, this column is always left blank.
THREADSAFE CHAR(1) For built-in functions, this column is always left blank.
VALID CHAR(1) For built-in functions, this column is always left blank.
MODULEROUTINEIMPLEMENTED CHAR(1) For built-in functions, this column is always left blank.
METHODIMPLEMETED CHAR(1) For built-in functions, this column is always left blank.
METHOD_EFFECT CHAR(2) For built-in functions, this column is always left blank.
TYPE_PRESERVING CHAR(1) For built-in functions, this column is always left blank.
WITH_FUNC_ACCESS CHAR(1) For built-in functions, this column is always left blank.
OVERRIDDEN_METHODID INTEGER For built-in functions, the value is always NULL.
SUBJECT_TYPESCHEMA VARCHAR (128) For built-in functions, the value is always NULL.
SUBJECT_TYPENAME VARCHAR (128) For built-in functions, the value is always NULL.
CLASS VARCHAR (384) For built-in functions, the value is always NULL.
JAR_ID VARCHAR (128) For built-in functions, the value is always NULL.
JARSCHEMA VARCHAR (128) For built-in functions, the value is always NULL.
JAR_SIGNATURE VARCHAR(2048) For built-in functions, the value is always NULL.
CREATE_TIME TIMESTAMP The value of this column is the timestamp representation of the Db2 build level.
ALTER_TIME TIMESTAMP For built-in functions, the value is the timestamp representation of the Db2 build level.
FUNC_PATH CLOB(2K) For built-in functions, the value is always NULL.
QUALIFIER VARCHAR(128) For built-in functions, the value is always SYSIBM.
IOS_PER_INVOC DOUBLE For built-in functions, the value is always -1.
INSTS_PER_INVOC DOUBLE For built-in functions, the value is always -1.
IOS_PER_ARGBYTE DOUBLE For built-in functions, the value is always -1.
INSTS_PER_ARGBYTE DOUBLE For built-in functions, the value is always -1.
PERCENT_ARGBYTES SMALLINT For built-in functions, the value is always -1.
INITIAL_IOS DOUBLE For built-in functions, the value is always -1.
INITIAL_INSTS DOUBLE For built-in functions, the value is always -1.
CARDINALITY BIGINT For built-in functions, the value is always -1.
SELECTIVITY DOUBLE For built-in functions, the value is always -1.
RESULT_COLS SMALLINT For built-in functions, the value is always 1.
IMPLEMENTATION VARCHAR(762) For built-in functions, the value is always NULL.
LIB_ID INTEGER For built-in functions, the value is always NULL.
TEXT_BODY_OFFSET INTEGER For built-in functions, the value is always -1.
TEXT CLOB(2M) For built-in functions, the value is always NULL.
NEWSAVEPOINTLEVEL CHAR(1) For built-in functions, this column is always left blank.
DEBUG_MODE VARCHAR(8) For built-in functions, this column is always left blank.
TRACE_LEVEL VARCHAR(1) For built-in functions, the value is always NULL.
DIAGNOSTIC_LEVEL VARCHAR(1) For built-in functions, the value is always NULL.
CHECKOUT_USERID VARCHAR(128) For built-in functions, the value is always NULL.
PRECOMPILE_OPTIONS VARCHAR(1024) For built-in functions, the value is always NULL.
COMPILE_OPTIONS VARCHAR(1024) For built-in functions, the value is always NULL.
EXECUTION_CONTROL CHAR(1) For built-in functions, this column is always left blank.
CODEPAGE SMALLINT For built-in functions, the value is always 0.
COLLATION_SCHEMA VARCHAR(128) For built-in functions, the value is always SYSIBM.
COLLATIONNAME VARCHAR(128) For built-in functions, the value is the database collation.
COLLATIONSCHEMA_ORDERBY VARCHAR(128) For built-in functions, the value is always SYSIBM.
COLLATIONNAME_ORDERBY VARCHAR(128) For built-in functions, the value is the database collation.
ENCODING_SCHEME CHAR(1) For built-in functions, this column is always left blank.
LAST_REGEN_TIME TIMESTAMP For built-in functions, the value is the timestamp representation of the Db2 build level.
INHERITLOCKREQUEST CHAR(1) For built-in functions, this column is always left blank.
DEFINER VARCHAR(128) For built-in functions, the value is always SYSIBM.
SECURE CHAR(1) For built-in functions, the value is always Y.
ENVSTRINGUNITS VARCHAR(11) For built-in functions, the value is always SYSTEM.
REMARKS VARCHAR(254) For built-in functions, the value is always NULL.