文档首页/ 云数据库 GaussDB/ 开发指南（分布式_V2.0-8.x）/ 存储过程/ 高级包/ 基础接口/ DBE_XML

更新时间：2024-11-12 GMT+08:00

DBE_XML

DBE_XML支持的所有接口请参见表1：

表1 DBE_XML接口参数说明
接口名称	描述
DBE_XML.XML_FREE_PARSER	释放PARSER。
DBE_XML.XML_PARSER_GET_DOC	获取解析的document节点。
DBE_XML.XML_GET_VALIDATION_MODE	获取validate属性。
DBE_XML.XML_NEW_PARSER	新建PARSER实例。
DBE_XML.XML_PARSE_BUFFER	解析VARCHAR字符串。
DBE_XML.XML_PARSE_CLOB	解析CLOB字符串。
DBE_XML.XML_SET_VALIDATION_MODE	设置validate属性。
DBE_XML.XML_DOM_APPEND_CHILD	将newchild node添加到parent(n)节点最后面,并返回新添加的Node节点。
DBE_XML.XML_DOM_CREATE_ELEMENT	返回创建指定名称的DOMELEMENT对象。
DBE_XML.XML_DOM_CREATE_ELEMENT_NS	返回创建指定名称和命名空间的DOMELEMENT对象。
DBE_XML.XML_DOM_CREATE_TEXT_NODE	创建并返回DOMTEXT对象。
DBE_XML.XML_DOM_FREE_DOCUMENT	将指定的xmldom类型对象释放。
DBE_XML.XML_DOM_FREE_ELEMENT	将指定的xmldom类型对象释放。
DBE_XML.XML_DOM_FREE_NODE	释放DOMNODE节点。
DBE_XML.XML_DOM_FREE_NODELIST	释放DOMNODELIST节点。
DBE_XML.XML_DOM_GET_ATTRIBUTE	获取指定的xmldom类型对象的属性。
DBE_XML.XML_DOM_GET_ATTRIBUTES	将DOMNode节点属性值作为map返回。
DBE_XML.XML_DOM_GET_CHILD_NODES	将节点下的若干子节点转换成节点列表。
DBE_XML.XML_DOM_GET_CHILDREN_BY_TAGNAME	获取指定的xmldom类型对象指定子节点组成的列表。
DBE_XML.XML_DOM_GET_CHILDREN_BY_TAGNAME_NS	获取指定的xmldom类型对象指定命名空间指定子节点组成的列表。
DBE_XML.XML_DOM_GET_DOCUMENT_ELEMENT	返回指定DOCUMENT的首个子节点。
DBE_XML.XML_DOM_GET_FIRST_CHILD	返回node节点的第一个子节点。
DBE_XML.XML_DOM_GET_LAST_CHILD	返回node节点的最后一个子节点。
DBE_XML.XML_DOM_GET_LENGTH	根据类型节点中内容返回节点数。
DBE_XML.XML_DOM_GET_LOCALNAME	返回给定对象的本地名称。
DBE_XML.XML_DOM_GET_NAMED_ITEM	检索由名称指定的节点。
DBE_XML.XML_DOM_GET_NAMED_ITEM_NS	检索由名称和命名空间指定的节点。
DBE_XML.XML_DOM_GET_NEXT_SIBLING	返回该节点的下一个节点。
DBE_XML.XML_DOM_GET_NODE_NAME	返回节点的名称。
DBE_XML.XML_DOM_GET_NODE_TYPE	返回节点的类型。
DBE_XML.XML_DOM_GET_NODE_VALUE	返回NODE节点的值。
DBE_XML.XML_DOM_GET_PARENT_NODE	返回给定NODE节点的父节点。
DBE_XML.XML_DOM_GET_TAGNAME	获取指定的xmldom类型对象的标签名。
DBE_XML.XML_DOM_HAS_CHILD_NODES	检查DOMNODE对象是否拥有任一子节点。
DBE_XML.XML_DOM_IMPORT_NODE	该函数将节点复制到另一节点中，并将复制后的节点挂载到指定document中。
DBE_XML.XML_DOM_IS_NULL	判断给定对象是否为NULL。
DBE_XML.XML_DOM_ITEM	根据索引返回list或map中与索引对应的元素。
DBE_XML.XML_DOM_MAKE_ELEMENT	返回转换后的DOMELEMENT对象。
DBE_XML.XML_DOM_MAKENODE	将给定对象强制转换为DOMNODE类型。
DBE_XML.XML_DOM_NEW_DOM_DOCUMENT_EMPTY	返回新的DOMDOCUMENT对象。
DBE_XML.XML_DOM_NEW_DOM_DOCUMENT_CLOB	返回从指定的CLOB类型创建的新DOMDOCUMENT实例对象。
DBE_XML.XML_DOM_NEW_DOCUMENT_XMLTYPE	返回从指定的XMLType类型创建的新DOMDOCUMENT实例对象。
DBE_XML.XML_DOM_SET_ATTRIBUTE	设置指定的xmldom类型对象的属性。
DBE_XML.XML_DOM_SET_CHARSET	设置DOM设置DOMDOCUMENT的CHATSET字符集。
DBE_XML.XML_DOM_SET_DOCTYPE	设置DOMDOCUMENT的外部DTD。
DBE_XML.XML_DOM_SET_NODE_VALUE	此函数用于向DOMNODE对象中设置节点的值。
DBE_XML.XML_DOM_WRITE_TO_BUFFER_DOC	将给定的DOMDOCUMENT类型对象写入缓冲区。
DBE_XML.XML_DOM_WRITE_TO_BUFFER_NODE	将给定的DOMNODE类型对象写入缓冲区。
DBE_XML.XML_DOM_WRITE_TO_CLOB_DOC	将给定的DOMDOCUMENT类型对象写入Clob。
DBE_XML.XML_DOM_WRITE_TO_CLOB_NODE	将给定的DOMNODE类型对象写入Clob。
DBE_XML.XML_DOM_WRITE_TO_FILE_DOC	使用数据库字符集将XML节点写入指定文件。
DBE_XML.XML_DOM_WRITE_TO_FILE_NODE	使用数据库字符集将XML节点写入指定文件。
DBE_XML.XML_DOM_GET_SESSION_TREE_NUM	显示当前session中所有类型的dom树的数量。
DBE_XML.XML_DOM_GET_DOC_TREES_INFO	显示document类型的dom树的内存占用、节点数量等统计信息。
DBE_XML.XML_DOM_GET_DETAIL_DOC_TREE_INFO	显示特定的document变量的各类型节点数量。

DBE_XML.XML_FREE_PARSER

释放给定的PARSER对象。

DBE_XML.XML_FREE_PARSER的存储过程原型为：

     
          DBE_XML.XML_FREE_PARSER(
id IN RAW(13))
returns VOID;

表2 DBE_XML.XML_FREE_PARSER接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的parser类型对象。

DBE_XML.XML_PARSER_GET_DOC

XML_PARSER_GET_DOC返回PARSER构建的DOM树文档的根节点。

DBE_XML.XML_PARSER_GET_DOC的函数原型为：

     
          DBE_XML.XML_PARSER_GET_DOC(
id IN RAW(13))
returns RAW(13);

表3 DBE_XML.XML_PARSER_GET_DOC接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的parser类型对象。

DBE_XML.XML_PARSER_GET_DOC函数传空，返回NULL。
DBE_XML.XML_PARSER_GET_DOC函数传入的parser还没有解析文档，返回NULL。

DBE_XML.XML_GET_VALIDATION_MODE

获取给定Parser的解析验证模式。如果DTD验证开启返回TRUE，否则返回FALSE。

DBE_XML.XML_GET_VALIDATION_MODE的函数原型为：

     
          DBE_XML.XML_GET_VALIDATION_MODE(
id RAW(13))
returns BOOL;

表4 DBE_XML.XML_GET_VALIDATION_MODE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的parser类型对象。

DBE_XML.XML_NEW_PARSER

新建Parser对象，返回一个新的解析器实例。

DBE_XML.XML_NEW_PARSER的函数原型为：
1 2

DBE_XML.XML_NEW_PARSER() RETURNS RAW(13);

DBE_XML.XML_PARSE_BUFFER

XML_PARSE_BUFFER解析存储在字符串中的XML文档。

DBE_XML.XML_PARSE_BUFFER的存储过程原型为：

     
          DBE_XML.XML_PARSE_BUFFER(
id RAW(13),
xmlstr VARCHAR2)
RETURNS VOID;

表5 DBE_XML.XML_PARSE_BUFFER接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的parser类型对象。
xmlstr	VARCHAR2	IN	否	存储XML文档的字符串。

xml_parse_buffer函数能够解析的字符串最大长度为32767，超过最大长度解析报错。
与ORA数据库差异：字符串encoding只支持UTF-8；version字段只支持1.0，1.0-1.9解析警告但正常执行，1.9以上报错。

与ORA数据库DTD校验差异：
- !ATTLIST to type (CHECK|check|Check) "Ch..."将报错，因默认值"Ch..."不属于括号中枚举值，而ORA数据库不报错。
- <!ENTITY baidu "www.baidu.com">...... &Baidu;&writer将报错，因区分字母大小写，Baidu无法与baidu对应，而ORA数据库不报错。
与ORA数据库命名空间校验差异：解析未声明的命名空间标签正常执行，而ORA数据库会报错。
与ORA数据库xml预定义实体解析差异：'"会被解析转义为字符’”，而ORA数据库中预定义实体统一都没有转义为字符。

DBE_XML.XML_PARSE_CLOB

XML_PARSE_CLOB解析存储在Clob中的XML文档。

DBE_XML.XML_PARSE_CLOB的存储过程原型为：

      
           DBE_XML.XML_PARSE_CLOB(
id IN RAW(13),
doc IN CLOB)
returns VOID；

表6 DBE_XML.XML_PARSE_CLOB接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的parser类型对象。
doc	CLOB	IN	否	存储XML文档的字符串。

xml_parse_clob不支持解析大于1GB的CLOB。
与ORA数据库差异：字符串encoding只支持UTF-8；version字段只支持1.0，1.0-1.9解析警告但正常执行，1.9以上报错。
与ORA数据库DTD校验差异：
- !ATTLIST to type (CHECK|check|Check) "Ch..."将报错，因默认值"Ch..."不属于括号中枚举值，而ORA数据库不报错。
- <!ENTITY baidu "www.baidu.com">...... &Baidu;&writer将报错，因区分字母大小写，Baidu无法与baidu对应，而ORA数据库不报错。
与ORA数据库命名空间校验差异：解析未声明的命名空间标签正常执行，而ORA数据库会报错。
与ORA数据库XML预定义实体解析差异：'"会被解析转义为字符’”，而ORA数据库中预定义实体统一都没有为字符。

DBE_XML.XML_SET_VALIDATION_MODE

设置给定Parser的解析验证模式。

DBE_XML.XML_SET_VALIDATION_MODE的存储过程原型为：

     
          DBE_XML.XML_SET_VALIDATION_MODE(
id RAW(13), 
validate BOOLEAN)
returns VOID;

表7 DBE_XML.XML_SET_VALIDATION_MODE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的parser类型对象
validate	BOOLEAN	IN	是	要设置的模式： TRUE：开启DTD验证。 FALSE：不开启验证。

DBE_XML.XML_SET_VALIDATION_MODE函数validate传入为空，不改变parser的解析验证模式。
parser初始化默认为开启DTD验证模式。

DBE_XML.XML_DOM_APPEND_CHILD

将newchild node添加到parent(n)节点最后面,并返回新添加的Node节点。

DBE_XML.XML_DOM_APPEND_CHILD的存储过程原型为：

     
          DBE_XML.XML_DOM_APPEND_CHILD(
    parentId IN RAW(13),
    childId IN RAW(13)
)
RETURNS RAW(13);

表8 DBE_XML.XML_DOM_APPEND_CHILD接口参数说明
参数	类型	入参/出参	是否可以为空	描述
parentId	RAW(13)	IN	否	指定的xmldom类型对象
childId	RAW(13)	IN	否	指定的xmldom类型对象

DBE_XML.XML_DOM_CREATE_ELEMENT

返回创建指定名称的DOMELEMENT对象。

DBE_XML.XML_DOM_CREATE_ELEMENT的函数原型为：

     
          DBE_XML.XML_DOM_CREATE_ELEMENT(
    id IN RAW(13),
    tagname IN VARCHAR2
)
RETURNS RAW(13);

表9 DBE_XML.XML_DOM_CREATE_ELEMENT接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象
tagname	VARCHAR2	IN	否	新建的DOMELEMENT名称

DBE_XML.XML_DOM_CREATE_ELEMENT_NS

返回创建指定名称和命名空间的DOMELEMENT对象。

DBE_XML.XML_DOM_CREATE_ELEMENT_NS的函数原型为：

     
          DBE_XML.XML_DOM_CREATE_ELEMENT_NS(
    id IN RAW(13),
    tagname IN VARCHAR2,
    ns IN VARCHAR2
)
RETURNS RAW(13);

**表10** DBE_XML.XML_DOM_CREATE_ELEMENT_NS接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象
tagname	VARCHAR2	IN	否	新建的DOMELEMENT名称
ns	VARCHAR2	IN	否	命名空间

DBE_XML.XML_DOM_CREATE_TEXT_NODE

创建并返回DOMTEXT对象。

DBE_XML.XML_DOM_CREATE_TEXT_NODE的函数原型为：

     
          DBE_XML.XML_DOM_CREATE_TEXT_NODE(
    id IN RAW(13),
    data IN VARCHAR2
)
RETURNS RAW(13);

**表11** DBE_XML.XML_DOM_CREATE_TEXT_NODE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象。
data	VARCHAR2	IN	否	新建的DOMTEXT节点内容。

DBE_XML.XML_DOM_FREE_DOCUMENT

将指定的xmldom类型对象释放。

DBE_XML.XML_DOM_FREE_DOCUMENT的存储过程原型为：

      
           DBE_XML.XML_DOM_FREE_DOCUMENT(
    id RAW(13)
)
RETURNS VOID;

**表12** DBE_XML.XML_DOM_FREE_DOCUMENT接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象。

DBE_XML.XML_DOM_FREE_ELEMENT

将指定的xmldom类型对象释放

DBE_XML.XML_DOM_FREE_ELEMENT的存储过程原型为：

DBE_XML.XML_DOM_FREE_ELEMENT (
    id RAW(13)
)
RETURNS VOID;

**表13** DBE_XML.XML_DOM_FREE_ELEMENT接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象

DBE_XML.XML_DOM_FREE_NODE

释放DOMNODE节点。

DBE_XML.XML_DOM_FREE_NODE的函数原型为：

     
          DBE_XML.XML_DOM_FREE_NODE (
    id RAW(13)
)
RETURNS VOID;

**表14** DBE_XML.XML_DOM_FREE_NODE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象

DBE_XML.XML_DOM_FREE_NODELIST

释放DOMNODELIST节点

DBE_XML.XML_DOM_FREE_NODELIST的存储过程原型为：

     
          DBE_XML.XML_DOM_FREE_NODELIST(
    id IN RAW(13)
    
)
RETURNS VOID

**表15** DBE_XML.XML_DOM_FREE_NODELIST接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象

DBE_XML.XML_DOM_GET_ATTRIBUTE

获取指定的xmldom类型对象的属性

DBE_XML.XML_DOM_GET_ATTRIBUTE的存储过程原型为：

     
          DBE_XML.XML_DOM_GET_ATTRIBUTE (
    docid   IN  RAW(13),
    name    IN  VARCHAR2
)
RETURNS VARCHAR2;

**表16** DBE_XML.XML_DOM_GET_ATTRIBUTE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
docid	RAW(13)	IN	否	指定的xmldom类型对象
name	VARCHAR2	IN	否	字符串

DBE_XML.XML_DOM_GET_ATTRIBUTES

将DOMNode节点属性值作为map返回。

DBE_XML.XML_DOM_GET_ATTRIBUTES的函数原型为：

     
          DBE_XML.XML_DOM_GET_ATTRIBUTES (
    id RAW(13)
)
RETURNS RAW(13);

**表17** DBE_XML.XML_DOM_GET_ATTRIBUTES接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象

DBE_XML.XML_DOM_GET_CHILD_NODES

将节点下的若干子节点转换成节点列表

DBE_XML.XML_DOM_GET_CHILD_NODES的函数原型为：

     
          DBE_XML.XML_DOM_GET_CHILD_NODES(
    id IN RAW(13)
)
RETURNS RAW(13);

**表18** DBE_XML.XML_DOM_GET_CHILD_NODES接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象

DBE_XML.XML_DOM_GET_CHILDREN_BY_TAGNAME

获取指定的xmldom类型对象指定子节点组成的列表

DBE_XML.XML_DOM_GET_CHILDREN_BY_TAGNAME的存储过程原型为：

     
          DBE_XML.XML_DOM_GET_CHILDREN_BY_TAGNAME (
    docid   IN  RAW(13),
    name    IN  VARCHAR2
)
RETURNS RAW(13);

**表19** DBE_XML.XML_DOM_GET_CHILDREN_BY_TAGNAME 接口参数说明
参数	类型	入参/出参	是否可以为空	描述
docid	RAW(13)	IN	否	指定的xmldom类型对象
name	VARCHAR2	IN	否	字符串

DBE_XML.XML_DOM_GET_CHILDREN_BY_TAGNAME_NS

获取指定的xmldom类型对象指定命名空间指定子节点组成的列表

DBE_XML.XML_DOM_GET_CHILDREN_BY_TAGNAME_NS的存储过程原型为：

     
          DBE_XML.XML_DOM_GET_CHILDREN_BY_TAGNAME_NS (
    docid   IN  RAW(13),
    name    IN  VARCHAR2,
    ns      IN  VARCHAR2
)
RETURNS RAW(13);

**表20** DBE_XML.XML_DOM_GET_CHILDREN_BY_TAGNAME_NS接口参数说明
参数	类型	入参/出参	是否可以为空	描述
docid	RAW(13)	IN	否	指定的xmldom类型对象
name	VARCHAR2	IN	否	字符串
ns	VARCHAR2	IN	是	字符串

DBE_XML.XML_DOM_GET_DOCUMENT_ELEMENT

返回指定DOCUMENT的首个子节点。

DBE_XML.XML_DOM_GET_DOCUMENT_ELEMENT的存储过程原型为：

     
          DBE_XML.XML_DOM_GET_DOCUMENT_ELEMENT(
    id  RAW(13)
)
RETURNS RAW(13);

**表21** DBE_XML.XML_DOM_GET_DOCUMENT_ELEMENT接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象

DBE_XML.XML_DOM_GET_FIRST_CHILD

返回node节点的第一个子节点。

DBE_XML.XML_DOM_GET_FIRST_CHILD的函数原型为：

     
          DBE_XML.XML_DOM_GET_FIRST_CHILD(
    id IN RAW(13)
)
RETURNS RAW(13);

**表22** DBE_XML.XML_DOM_GET_FIRST_CHILD接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象

DBE_XML.XML_DOM_GET_LAST_CHILD

返回node节点的最后一个子节点。

DBE_XML.XML_DOM_GET_LAST_CHILD的函数原型为：

     
          DBE_XML.XML_DOM_GET_LAST_CHILD(
    id IN RAW(13)
)
RETURNS RAW(13);

**表23** DBE_XML.XML_DOM_GET_LAST_CHILD接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象

DBE_XML.XML_DOM_GET_LENGTH

根据类型节点中内容返回节点数。

DBE_XML.XML_DOM_GET_LENGTH的存储过程原型为：

     
          DBE_XML.XML_DOM_GET_LENGTH(
    id RAW(13)
)
RETURNS VOID;

**表24** DBE_XML.XML_DOM_GET_LENGTH接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的xmldom类型对象

DBE_XML.XML_DOM_GET_LOCALNAME

返回给定对象的本地名称

DBE_XML.XML_DOM_GET_LOCALNAME的存储过程原型为：

     
          DBE_XML.XML_DOM_GET_LOCALNAME (
    id  RAW(13)
)
RETURNS VARCHAR2;

**表25** DBE_XML.XML_DOM_GET_LOCALNAME接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的xmldom类型对象

DBE_XML.XML_DOM_GET_NAMED_ITEM

检索由名称指定的节点

DBE_XML.XML_DOM_GET_NAMED_ITEM的函数原型为：

     
          DBE_XML.XML_DOM_GET_NAMED_ITEM(
    id IN RAW(13),
    nodeName IN VARCHAR2
)
RETURNS RAW(13);

**表26** DBE_XML.XML_DOM_GET_NAMED_ITEM接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象
nodeName	VARCHAR2	IN	否	要检索的元素的名称

DBE_XML.XML_DOM_GET_NAMED_ITEM_NS

检索由名称和命名空间指定的节点

DBE_XML.XML_DOM_GET_NAMED_ITEM_NS的函数原型为：

     
          DBE_XML.XML_DOM_GET_NAMED_ITEM_NS(
    id  RAW(13),
    nodeName IN VARCHAR2,
    ns IN VARCHAR2
)
RETURNS RAW(13);

**表27** DBE_XML.XML_DOM_GET_NAMED_ITEM_NS接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象
nodeName	VARCHAR2	IN	否	要检索的元素的名称
ns	VARCHAR2	IN	是	命名空间

DBE_XML.XML_DOM_GET_NEXT_SIBLING

返回该节点的下一个节点。

DBE_XML.XML_DOM_GET_NEXT_SIBLING的函数原型为：

     
          DBE_XML.XML_DOM_GET_NEXT_SIBLING(
    id IN RAW(13)
)
RETURNS RAW(13);

**表28** DBE_XML.XML_DOM_GET_NEXT_SIBLING接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象

DBE_XML.XML_DOM_GET_NODE_NAME

返回节点的名称。

DBE_XML.XML_DOM_GET_NODE_NAME的函数原型为：

     
          DBE_XML.XML_DOM_GET_NODE_NAME(
    id IN RAW(13)
)
RETURNS VARCHAR2;

**表29** DBE_XML.XML_DOM_GET_NODE_NAME接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象

DBE_XML.XML_DOM_GET_NODE_TYPE

返回节点的类型。

DBE_XML.XML_DOM_GET_NODE_TYPE的函数原型为：

     
          DBE_XML.XML_DOM_GET_NODE_TYPE(
    id IN RAW(13)
)
RETURNS INTEGER;

**表30** DBE_XML.XML_DOM_GET_NODE_TYPE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象

DBE_XML.XML_DOM_GET_NODE_VALUE

返回NODE节点的值。

DBE_XML.XML_DOM_GET_NODE_VALUE的存储过程原型为：

     
          DBE_XML.XML_DOM_GET_NODE_VALUE(
id IN RAW(13))
RETURNS VARCHAR2;

**表31** DBE_XML.XML_DOM_GET_NODE_VALUE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的xmldom类型对象

DBE_XML.XML_DOM_GET_PARENT_NODE

返回给定NODE节点的父节点。

DBE_XML.XML_DOM_GET_PARENT_NODE的存储过程原型为：

     
          DBE_XML.XML_DOM_GET_PARENT_NODE(
id IN RAW(13))
RETURNS RAW(13);

**表32** DBE_XML.XML_DOM_GET_PARENT_NODE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的xmldom类型对象

DBE_XML.XML_DOM_GET_TAGNAME

获取指定的xmldom类型对象的标签名

DBE_XML.XML_DOM_GET_TAGNAME的存储过程原型为：

     
          DBE_XML.XML_DOM_GET_TAGNAME (
    docid RAW(13)
)
RETURNS VARCHAR2;

**表33** DBE_XML.XML_DOM_GET_TAGNAME接口参数说明
参数	类型	入参/出参	是否可以为空	描述
docid	RAW(13)	IN	是	指定的xmldom类型对象

DBE_XML.XML_DOM_HAS_CHILD_NODES

检查DOMNODE对象是否拥有任一子节点。

DBE_XML.XML_DOM_HAS_CHILD_NODES的存储过程原型为：

     
          DBE_XML.XML_DOM_HAS_CHILD_NODES(
id IN RAW(13))
RETURNS BOOLEAN

**表34** DBE_XML.XML_DOM_HAS_CHILD_NODES接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的xmldom类型对象

DBE_XML.XML_DOM_IMPORT_NODE

该函数将节点复制到另一节点中，并将复制后的节点挂载到指定document中。若被复制节点的类型不属于xmldom的constants所规定的12种类型，则直接抛出类型不支持异常。

DBE_XML.XML_DOM_IMPORT_NODE的函数原型为：

     
          DBE_XML.XML_DOM_IMPORT_NODE(
    doc_id IN RAW(13),
    node_id IN RAW(13),
    deep IN BOOLEAN
)
RETURNS RAW(13);

**表35** DBE_XML.XML_DOM_IMPORT_NODE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
doc_id	RAW(13)	IN	否	节点挂载的文档。
node_id	RAW(13)	IN	否	将要导入的节点。
deep	BOOLEAN	IN	否	设置递归导入：如果为TRUE，则导入该节点及其所有子节点。如果为FALSE，则指导入节点本身。

DBE_XML.XML_DOM_IS_NULL

判断给定对象是否为NULL，如果是则返回True，否则返回false。

DBE_XML.XML_DOM_IS_NULL的函数原型为：

     
          DBE_XML.XML_DOM_IS_NULL (
    id  RAW(13)
)
RETURNS BOOLEAN;

**表36** DBE_XML.XML_DOM_IS_NULL接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的xmldom类型对象。

DBE_XML.XML_DOM_ITEM

根据索引返回list或map中与索引对应的元素。

DBE_XML.XML_DOM_ITEM的函数原型为：

     
          DBE_XML.XML_DOM_ITEM (
    id IN RAW(13),
    index IN INTEGER
)
RETURNS RAW(13);

**表37** DBE_XML.XML_DOM_ITEM接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象。
index	INTEGER	IN	否	要检索的元素的索引。

DBE_XML.XML_DOM_MAKE_ELEMENT

返回转换后的DOMELEMENT对象。

DBE_XML.XML_DOM_MAKE_ELEMENT的存储过程原型为：

     
          DBE_XML.XML_DOM_MAKE_ELEMENT(
id IN RAW(13))
RETURNS RAW(13)

**表38** DBE_XML.XML_DOM_MAKE_ELEMENT接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象。

DBE_XML.XML_DOM_MAKENODE

将给定对象强制转换为DOMNODE类型。

DBE_XML.XML_DOM_MAKENODE的存储过程原型为：

     
          DBE_XML.XML_DOM_MAKENODE(
   id    RAW(13)
)
RETURNS DOMNODE;

**表39** DBE_XML.XML_DOM_MAKENODE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的xmldom类型对象。

DBE_XML.XML_DOM_NEW_DOM_DOCUMENT_EMPTY
返回新的DOMDOCUMENT对象。

DBE_XML.XML_DOM_NEW_DOM_DOCUMENT_EMPTY的函数原型为：
1 2

DBE_XML.XML_DOM_NEW_DOM_DOCUMENT_EMPTY() RETURNS RAW(13);

DBE_XML.XML_DOM_NEW_DOM_DOCUMENT_CLOB

返回从指定的CLOB类型创建的新DOMDOCUMENT实例对象。

DBE_XML.XML_DOM_NEW_DOM_DOCUMENT_CLOB的函数原型为：

     
          DBE_XML.XML_DOM_NEW_DOM_DOCUMENT_CLOB(
    content IN  CLOB
)
RETURNS RAW(13);

**表40** xml_dom_new_dom_document_clob接口参数说明
参数	类型	入参/出参	是否可以为空	描述
content	CLOB	IN	否	指定的CLOB类型。

DBE_XML.XML_DOM_NEW_DOCUMENT_XMLTYPE

返回从指定的XMLType类型创建的新DOMDOCUMENT实例对象。。

DBE_XML.XML_DOM_NEW_DOCUMENT_XMLTYPE的函数原型为：

     
          DBE_XML.XML_DOM_NEW_DOCUMENT_XMLTYPE(
    content IN  CLOB
)
RETURNS RAW(13);

**表41** DBE_XML.XML_DOM_NEW_DOCUMENT_XMLTYPE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
content	CLOB	IN	否	指定的CLOB类型。

DBE_XML.XML_DOM_SET_ATTRIBUTE

设置指定的xmldom类型对象的属性。

DBE_XML.XML_DOM_SET_ATTRIBUTE的存储过程原型为：

     
          DBE_XML.XML_DOM_SET_ATTRIBUTE(
    docid   IN  RAW(13),
    name    IN  VARCHAR2,
    value   IN  VARCHAR2
)
RETURNS void;

**表42** DBE_XML.XML_DOM_SET_ATTRIBUTE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象。
name	VARCHAR2	IN	否	字符串
value	VARCHAR2	IN	否	字符串

DBE_XML.XML_DOM_SET_CHARSET

设置DOM设置DOMDOCUMENT的CHATSET字符集。

DBE_XML.XML_DOM_SET_CHARSET的函数原型为：

     
          DBE_XML.XML_DOM_SET_CHARSET(
    id      IN RAW(13),
    charset IN VARCHAR2
)
RETURNS void;

**表43** DBE_XML.XML_DOM_SET_CHARSET接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象。
charset	VARCHAR2	IN	否	字符集

DBE_XML.XML_DOM_SET_DOCTYPE

设置DOMDOCUMENT的外部DTD。

DBE_XML.XML_DOM_SET_DOCTYPE的函数原型为：

     
          DBE_XML.XML_DOM_SET_DOCTYPE(
    id          IN  RAW(13),
    dtd_name    IN  VARCHAR2,
    system_id   IN  VARCHAR2,
    public_id   IN  VARCHAR2
)
RETURNS void;

**表44** DBE_XML.XML_DOM_SET_DOCTYPE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象。
dtd_name	VARCHAR2	IN	否	需要初始化doctype的名称。
system_id	VARCHAR2	IN	否	需要初始化doctype的system ID。
public_id	VARCHAR2	IN	否	需要初始化doctype的public ID。

DBE_XML.XML_DOM_SET_NODE_VALUE

此函数用于向DOMNODE对象中设置节点的值。

DBE_XML.XML_DOM_SET_NODE_VALUE的存储过程原型为：

     
          DBE_XML.XML_DOM_SET_NODE_VALUE(
id IN RAW(13),
node_value IN VARCHAR2)
RETURNS VOID

**表45** DBE_XML.XML_DOM_SET_NODE_VALUE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象。
node_value	VARCHAR2	IN	否	向DOMNODE对象中设置的字符串。

DBE_XML.XML_DOM_WRITE_TO_BUFFER_DOC

将给定的DOMDOCUMENT类型对象写入缓冲区。

DBE_XML.XML_DOM_WRITE_TO_BUFFER_DOC的存储过程原型为：

     
          DBE_XML.XML_DOM_WRITE_TO_BUFFER_DOC(
id IN RAW(13))
RETURNS VARCHAR2;

**表46** DBE_XML.XML_DOM_WRITE_TO_BUFFER_DOC接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的xmldom类型对象。

DBE_XML.XML_DOM_WRITE_TO_BUFFER_NODE

将给定的DOMNODE类型对象写入缓冲区。

DBE_XML.XML_DOM_WRITE_TO_BUFFER_NODE的存储过程原型为：

     
          DBE_XML.XML_DOM_WRITE_TO_BUFFER_NODE(
id IN RAW(13))
RETURNS VARCHAR2;

**表47** DBE_XML.XML_DOM_WRITE_TO_BUFFER_NODE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的xmldom类型对象。

DBE_XML.XML_DOM_WRITE_TO_CLOB_DOC

将给定的DOMDOCUMENT类型对象写入Clob。

DBE_XML.XML_DOM_WRITE_TO_CLOB_DOC的存储过程原型为：

     
          DBE_XML.XML_DOM_WRITE_TO_CLOB_DOC(
    id IN RAW(13)
)
RETURNS VARCHAR2;

**表48** DBE_XML.XML_DOM_WRITE_TO_CLOB_DOC接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的xmldom类型对象。

DBE_XML.XML_DOM_WRITE_TO_CLOB_NODE

将给定的DOMNODE类型对象写入Clob。

DBE_XML.XML_DOM_WRITE_TO_CLOB_NODE的存储过程原型为：

     
          DBE_XML.XML_DOM_WRITE_TO_CLOB_NODE(
    id          IN  RAW(13)
)
RETURNS CLOB;

**表49** DBE_XML.XML_DOM_WRITE_TO_CLOB_NODE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的xmldom类型对象。

DBE_XML.XML_DOM_WRITE_TO_FILE_DOC

使用数据库字符集将XML节点写入指定文件。

DBE_XML.XML_DOM_WRITE_TO_FILE_DOC的存储过程原型为：

     
          DBE_XML.XML_DOM_WRITE_TO_FILE_DOC(
id IN  RAW(13),
file_dir IN  VARCHAR2)
RETURNS VOID

DBE_XML.XML_DOM_WRITE_TO_FILE_DOC(
id IN  RAW(13),
file_dir IN  VARCHAR2,
charset  IN  VARCHAR2)
RETURNS VOID PACKAGE

**表50** DBE_XML.XML_DOM_WRITE_TO_FILE_DOC接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	是	指定的xmldom类型对象。
file_dir	VARCHAR2	IN	否	要写入的文件。
charset	VARCHAR2	IN	否	指定字符集。

DBE_XML.XML_DOM_WRITE_TO_FILE_NODE

使用数据库字符集将XML节点写入指定文件。

DBE_XML.XML_DOM_WRITE_TO_FILE_NODE的存储过程原型为：

     
          DBE_XML.XML_DOM_WRITE_TO_FILE_NODE(
id IN  RAW(13),
filename IN  VARCHAR2)
RETURNS VOID

**表51** DBE_XML.XML_DOM_WRITE_TO_FILE_NODE接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象。
filename	VARCHAR2	IN	否	指定文件地址。

DBE_XML.XML_DOM_GET_SESSION_TREE_NUM
查询当前session中所有类型的dom树数量。

DBE_XML.XML_DOM_GET_SESSION_TREE_NUM的函数原型为：
1 2

DBE_XML.XML_DOM_GET_SESSION_TREE_NUM() RETURNS INTEGER
DBE_XML.XML_DOM_GET_DOC_TREES_INFO
查询当前session中Document类型的dom树信息，如内存占用等。

DBE_XML.XML_DOM_GET_DOC_TREES_INFO的函数原型为：
1 2

DBE_XML.XML_DOM_GET_DOC_TREES_INFO() RETURNS VARCHAR2

DBE_XML.XML_DOM_GET_DETAIL_DOC_TREE_INFO

查询传入的document内的各类型子节点的数量。

DBE_XML.XML_DOM_GET_DETAIL_DOC_TREE_INFO的函数原型为：

     
          dbe_xml.xml_dom_get_detail_doc_tree_info(
id IN  RAW(13))
RETURNS VARCHAR2

**表52** DBE_XML.XML_DOM_GET_DETAIL_DOC_TREE_INFO接口参数说明
参数	类型	入参/出参	是否可以为空	描述
id	RAW(13)	IN	否	指定的xmldom类型对象。

父主题： 基础接口

上一篇：DBE_DESCRIBE

下一篇：二次封装接口（推荐）

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！您可在我的云声建议查看反馈及问题处理状态。

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消

如您有其它疑问，您也可以通过华为云社区问答频道来与我们联系探讨

智能客服提问云社区提问

DBE_XML

相关文档

意见反馈

文档内容是否对您有帮助？

7*24

备案

专业服务

退订

建议反馈

售前咨询热线