云数据库 GAUSSDB-DBE_UTILITY:接口介绍

时间：2024-04-26 16:15:24

云数据库 GAUSSDB 二次封装接口(推荐)

接口介绍

高级功能包DBE_UTILITY支持的所有接口请参见表1。

表1 DBE_UTILITY
接口名称	描述
DBE_UTILITY.FORMAT_ERROR_BACKTRACE	输出存储过程异常的调用堆栈。
DBE_UTILITY.FORMAT_ERROR_STACK	输出存储过程异常的具体信息。
DBE_UTILITY.FORMAT_CALL_STACK	输出存储过程的调用堆栈。
DBE_UTILITY.GET_TIME	输出当前时间，一般用于做差得到执行时长。
DBE_UTILITY.COMPILE_SCHEMA	重编译指定schema下的PL/SQL类型包和函数（系统自带的包和函数除外）。该包已废弃。推荐使用pkg_util.gs_compile_schema。
DBE_UTILITY.CANONICALIZE	用于给表名字符串做规范。
DBE_UTILITY.COMMA_TO_TABLE	将用逗号隔开的名字列表的字符串转换为PL/SQL表名列表。
DBE_UTILITY.DB_VERSION	返回数据库的版本号和兼容性版本号。
DBE_UTILITY.EXEC_DDL_STATEMENT	用于执行用户输入的DDL语句。
DBE_UTILITY.EXPAND_SQL_TEXT_PROC	用于展开SQL查询的视图。
DBE_UTILITY.GET_CPU_TIME	返回当前CPU处理时间的测量值。
DBE_UTILITY.GET_ENDIANNESS	用于获取数据库所在平台字节序的大小端信息。
DBE_UTILITY.GET_HASH_VALUE	返回一个给定字符串的hash值。
DBE_UTILITY.GET_SQL_HASH	输出一个给定字符串的hash值，该存储过程在不打开proc_outparam_override时使用。
DBE_UTILITY.IS_BIT_SET	用于检查参数n是否存在于r。
DBE_UTILITY.IS_CLUSTER_DATABASE	用于判断当前数据库是否在数据库集群模式下运行。
DBE_UTILITY.NAME_RESOLVE	解析给定的对象名称，包括同义词翻译和必要的授权检查。
DBE_UTILITY.NAME_TOKENIZE	用于解析a [. b [. c ]][@ dblink ]形式的名字。
DBE_UTILITY.OLD_CURRENT_SCHEMA	返回当前用户环境下的数据库模式名称。
DBE_UTILITY.OLD_CURRENT_USER	返回当前用户的名称。
DBE_UTILITY.TABLE_TO_COMMA	将PL/SQL中的表名转换为用逗号隔开的名字列表的字符串。
DBE_UTILITY.GET_SQL_HASH_FUNC	功能同DBE_UTILITY.GET_SQL_HASH，该函数在打开proc_outparam_override时使用。
DBE_UTILITY.EXPAND_SQL_TEXT	内部函数，不建议用户使用。
DBE_UTILITY.CANONICALIZE_RET	内部函数，不建议用户使用。
DBE_UTILITY.COMMA_TO_TABLE_FUN	内部函数，不建议用户使用。
DBE_UTILITY.COMPILE_SCHEMA	内部函数，不建议用户使用。
DBE_UTILITY.NAME_SEPARATE	内部函数，不建议用户使用。
DBE_UTILITY.NAME_TOKENIZE_FUNC	内部函数，不建议用户使用。
DBE_UTILITY.NAME_TOKENIZE_LOWER	内部函数，不建议用户使用。
DBE_UTILITY.NAME_TOKENIZE_LOWER_FUNC	内部函数，不建议用户使用。
DBE_UTILITY.PRIVILEGE_CHECK	内部函数，不建议用户使用。
DBE_UTILITY.SEARCH_CLASS_WITH_NSPOID_ONAME_TYPE	内部函数，不建议用户使用。
DBE_UTILITY.SEARCH_OBJECTS	内部函数，不建议用户使用。
DBE_UTILITY.SEARCH_OBJECTS_SYNONYM_FILL_SECHEMA	内部函数，不建议用户使用。
DBE_UTILITY.SEARCH_PROCEDURE_WITH_NSPOID_ONAME	内部函数，不建议用户使用。
DBE_UTILITY.SEARCH_SYNONM_WITH_NSPOID_ONAME	内部函数，不建议用户使用。
DBE_UTILITY.TABLE_TO_COMMA_FUNC	内部函数，不建议用户使用。
DBE_UTILITY.USER_NAME	内部函数，不建议用户使用。

DBE_UTILITY.FORMAT_ERROR_BACKTRACE
存储过程FORMAT_ERROR_BACKTRACE返回在执行过程中出现错误时，出现错误位置的调用堆栈。DBE_UTILITY.FORMAT_ERROR_BACKTRACE函数原型为：
1 2

DBE_UTILITY.FORMAT_ERROR_BACKTRACE() RETURN TEXT;

DBE_UTILITY.FORMAT_ERROR_STACK
存储过程FORMAT_ERROR_STACK返回在执行过程中出现错误时，出现错误位置的具体信息。DBE_UTILITY.FORMAT_ERROR_STACK函数原型为：
1 2

DBE_UTILITY.FORMAT_ERROR_STACK() RETURN TEXT;

DBE_UTILITY.FORMAT_CALL_STACK
存储过程FORMAT_CALL_STACK设置输出函数调用堆栈。DBE_UTILITY.FORMAT_CALL_STACK函数原型为：
1 2

DBE_UTILITY.FORMAT_CALL_STACK() RETURN TEXT;

DBE_UTILITY.COMPILE_SCHEMA

重编译指定schema下的PL/SQL类型包和函数（系统自带的包和函数除外）， DBE_UTILITY.COMPILE_SCHEMA函数原型为：

DBE_UTILITY.COMPILE_SCHEMA (
SCHEMA IN VARCHAR2,
COMPILE_ALL IN BOOLEAN DEFAULT TRUE,
REUSE_SETTINGS IN BOOLEAN DEFAULT FALSE
)
RETURNS VOID；
示例参考11.12.1.2中pkg_util.utility_compile_schema函数使用方式， 调用处改为：
call DBE_UTILITY.compile_schema('pkg_var_test');