文档首页/ 云数据库 GaussDB/ 开发指南（主备版_3.x）/ 存储过程/ 高级包/ 基础接口/ DBE_XML

更新时间：2024-05-07 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_nod...	释放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_leng...	根据类型节点中内容返回节点数。
dbe_xml.xml_dom_get_loca...	返回给定对象的本地名称。
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_pare...	返回给定NODE节点的父节点。
dbe_xml.xml_dom_get_tagname	获取指定的xmldom类型对象的标签名。
dbe_xml.xml_dom_has_chil...	检查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对象。
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...	此函数用于向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类型对象。

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

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

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：不开启验证。

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),
    node_value IN VARCHAR2
)
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);

xml_dom_new_dom_document_clob

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

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.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.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类型对象。

父主题： 基础接口

上一篇：PKG_UTIL

下一篇：二次封装接口(推荐)

意见反馈

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

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

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

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

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

字符长度不能超过500

直接提交取消