Updated on 2024-05-07 GMT+08:00

DBE_XML

Table 1 lists all interfaces supported by the DBE_XML interface.
Table 1 DBE_XML parameters

Interface

Description

dbe_xml.xml_free_parser

Frees a parser.

dbe_xml.xml_parser_get_doc

Obtains the parsed document node.

dbe_xml.xml_get_validation_mode

Obtains the validation attribute.

dbe_xml.xml_new_parser

Creates a parser instance.

dbe_xml.xml_parse_buffer

Parses the VARCHAR string.

dbe_xml.xml_parse_clob

Parses the CLOB string.

dbe_xml.xml_set_validation_mode

Sets the validation attribute.

dbe_xml.xml_dom_append_child

Adds the newchild node to the end of the parent(n) node and returns the newly added node.

dbe_xml.xml_dom_create_element

Returns the DOMElement object with the specified name.

dbe_xml.xml_dom_create_element_ns

Returns the DOMElement object with the specified name and namespace.

dbe_xml.xml_dom_create_text_node

Creates and returns a DOMText object.

dbe_xml.xml_dom_free_document

Frees a specified XML DOM object.

dbe_xml.xml_dom_free_element

Frees a specified XML DOM object.

dbe_xml.xml_dom_free_node

Frees a DOMNode node.

dbe_xml.xml_dom_free_nod...

Frees a DOMNodeList node.

dbe_xml.xml_dom_get_attribute

Obtains the attributes of a specified XML DOM object.

dbe_xml.xml_dom_get_attributes

Returns the attribute values of a DOMNode node as a map.

dbe_xml.xml_dom_get_child_nodes

Converts several subnodes under a node into a node list.

dbe_xml.xml_dom_get_children_by_tagname

Obtains the list of specified subnodes of a specified XML DOM object.

dbe_xml.xml_dom_get_children_by_tagname_ns

Obtains the list of subnodes in the specified namespace of a specified XML DOM object.

dbe_xml.xml_dom_get_document_element

Returns the first subnode of the specified document.

dbe_xml.xml_dom_get_first_child

Returns the first subnode of a node.

dbe_xml.xml_dom_get_last_child

Returns the last subnode of a node.

dbe_xml.xml_dom_get_leng...

Returns the number of nodes based on the content in the node of the specified type.

dbe_xml.xml_dom_get_loca...

Returns the local name of the given object.

dbe_xml.xml_dom_get_named_item

Returns the node specified by name.

dbe_xml.xml_dom_get_named_item_ns

Returns the node specified by name and namespace.

dbe_xml.xml_dom_get_next_sibling

Returns the next node of the specified node.

dbe_xml.xml_dom_get_node_name

Returns the name of a node.

dbe_xml.xml_dom_get_node_type

Returns the type of a node.

dbe_xml.xml_dom_get_node_value

Returns the value of a DOMNode node.

dbe_xml.xml_dom_get_pare...

Returns the parent node of the given DOMNode node.

dbe_xml.xml_dom_get_tagname

Obtains the tag name of a specified XML DOM object.

dbe_xml.xml_dom_has_chil...

Checks whether the DOMNode object has any subnode.

dbe_xml.xml_dom_import_node

Copies a node to another node and mounts the copied node to a specified document.

dbe_xml.xml_dom_is_null

Checks whether the given object is null.

dbe_xml.xml_dom_item

Returns the element corresponding to the index in a list or map based on the index.

dbe_xml.xml_dom_make_element

Returns the DOMElement object after conversion.

dbe_xml.xml_dom_makenode

Converts the given object to the DOMNode type.

dbe_xml.xml_dom_new_dom_document_empty

Returns a new DOMDocument object.

xml_dom_new_dom_document_clob

Returns a new DOMDocument instance object created from the specified CLOB type.

dbe_xml.xml_dom_new_document_xmltype

Returns a new DOMDocument instance object created from the specified XMLType type.

dbe_xml.xml_dom_set_attribute

Sets the attributes of a specified XML DOM object.

dbe_xml.xml_dom_set_charset

Sets the character set for a DOMDocument object.

dbe_xml.xml_dom_set_doctype

Sets the external DTD of a DOMDocument object.

dbe_xml.xml_dom_set_node...

Sets the value of a node in the DOMNode object.

dbe_xml.xml_dom_write_to_buffer_doc

Writes the given DOMDocument object to the buffer.

dbe_xml.xml_dom_write_to_buffer_node

Writes the given DOMNode object to the buffer.

dbe_xml.xml_dom_write_to_clob_doc

Writes the given DOMDocument object to a CLOB.

dbe_xml.xml_dom_write_to_clob_node

Writes the given DOMNode object to a CLOB.

dbe_xml.xml_dom_write_to_file_doc

Writes an XML node to a specified file using the database character set.

dbe_xml.xml_dom_write_to_file_node

Writes an XML node to a specified file using the database character set.

dbe_xml.xml_dom_get_session_tree_num

Displays the number of DOM trees of all types in the current session.

dbe_xml.xml_dom_get_doc_trees_info

Displays statistics such as the memory usage and number of nodes of the DOM tree of the document type.

dbe_xml.xml_dom_get_detail_doc_tree_info

Displays the number of nodes of each type for a specific document variable.

  • dbe_xml.xml_free_parser

    Frees a given parser object.

    The stored procedure prototype of dbe_xml.xml_free_parser is as follows:

    1
    2
    3
    dbe_xml.xml_free_parser(
    id IN raw(13))
    returns void;
    
    Table 2 dbe_xml.xml_free_parser parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    Parser object

  • dbe_xml.xml_parser_get_doc

    Returns the root node of the DOM tree document constructed by the parser.

    The prototype of the dbe_xml.xml_parser_get_doc function is as follows:

    1
    2
    3
    dbe_xml.xml_parser_get_doc(
    id IN raw(13))
    returns raw(13);
    
    Table 3 dbe_xml.xml_parser_get_doc parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    Parser object

    • If the GETDOCUMENT function is empty, null is returned.
    • If the parser input by the GETDOCUMENT function has not parsed any document, null is returned.
  • dbe_xml.xml_get_validation_mode

    Obtains the parsing validation mode of a specified parser. If DTD validation is enabled, TRUE is returned. Otherwise, FALSE is returned.

    The prototype of the dbe_xml.xml_get_validation_mode function is as follows:

    1
    2
    3
    dbe_xml.xml_get_validation_mode(
    id raw(13))
    returns bool;
    
    Table 4 dbe_xml.xml_get_validation_mode parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    Parser object

  • dbe_xml.xml_new_parser

    Creates a parser object and returns a new parser instance.

    The prototype of the dbe_xml.xml_new_parser function is as follows:

    1
    2
    dbe_xml.xml_new_parser()
    RETURNS RAW(13);
    
  • dbe_xml.xml_parse_buffer

    Parses XML documents stored in strings.

    The stored procedure prototype of dbe_xml.xml_parse_buffer is as follows:

    1
    2
    3
    4
    dbe_xml.xml_parse_buffer(
    id RAW(13),
    xmlstr VARCHAR2)
    RETURNS void;
    
    Table 5 dbe_xml.xml_parse_buffer parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    Parser object

    xmlstr

    VARCHAR2

    IN

    No

    A string that stores XML documents

    • The maximum length of a character string that can be parsed by the xml_parse_buffer function is 32767. If the length exceeds the maximum, an error is reported.
    • Different from the ORA database, this database supports only UTF-8 in terms of character encoding, and version can only be set to 1.0. If versions 1.0 to 1.9 are parsed, a warning appears but the execution is normal. For versions later than 1.9, an error is reported.
    • DTD validation differences:
      • !ATTLIST to type (CHECK|check|Check) "Ch..." reports an error because the default value "Ch..." is not an enumerated value in the brackets. However, the ORA database does not report this error.
      • <!ENTITY baidu "www.baidu.com">...... &Baidu;&writer reports an error because the letters are case sensitive. Baidu cannot correspond to baidu. However, the ORA database does not report this error.
    • Namespace validation difference: Undeclared namespace tags are parsed. However, the ORA database reports an error.
    • Difference in parsing XML predefined entities: &apos; and &quot; are parsed and translated into ' and ". However, predefined entities in database ORA are not translated into characters.
  • dbe_xml.xml_parse_clob

    Parses XML documents stored in a CLOB.

    The stored procedure prototype of dbe_xml.xml_parse_clob is as follows:
    1
    2
    3
    4
    dbe_xml.xml_parse_clob(
    id IN raw(13),
    doc IN CLOB)
    returns void;
    
    Table 6 dbe_xml.xml_parse_clob parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    Parser object

    doc

    CLOB

    IN

    No

    A string that stores XML documents

    • xml_parse_clob cannot parse CLOBs larger than 1 GB.
    • Different from the ORA database, this database supports only UTF-8 in terms of character encoding, and version can only be set to 1.0. If versions 1.0 to 1.9 are parsed, a warning appears but the execution is normal. For versions later than 1.9, an error is reported.
    • DTD validation differences:
      • !ATTLIST to type (CHECK|check|Check) "Ch..." reports an error because the default value "Ch..." is not an enumerated value in the brackets. However, the ORA database does not report this error.
      • <!ENTITY baidu "www.baidu.com">...... &Baidu;&writer reports an error because the letters are case sensitive. Baidu cannot correspond to baidu. However, the ORA database does not report this error.
    • Namespace validation difference: Undeclared namespace tags are parsed. However, the ORA database reports an error.
    • Difference in parsing XML predefined entities: &apos; and &quot; are parsed and translated into ' and ". However, predefined entities in database ORA are not translated into characters.
  • dbe_xml.xml_set_validation_mode

    Sets the parsing validation mode of a specified parser.

    The stored procedure prototype of dbe_xml.xml_set_validation_mode is as follows:

    1
    2
    3
    4
    dbe_xml.xml_set_validation_mode(
    id raw(13), 
    validate boolean)
    returns void;
    
    Table 7 dbe_xml.xml_set_validation_mode parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    Parser object

    validate

    boolean

    IN

    Yes

    Mode to be set:
    • TRUE: DTD validation is enabled.
    • FALSE: DTD validation is disabled.
    • If the input parameter validate of the xml_set_validation_mode function is null, the parsing validation mode of the parser is not changed.
    • By default, the DTD validation is enabled during parser initialization.
  • dbe_xml.xml_dom_append_child

    Adds the newchild node to the end of the parent(n) node and returns the newly added node.

    The stored procedure prototype of dbe_xml.xml_dom_append_child is as follows:

    1
    2
    3
    4
    5
    dbe_xml.xml_dom_append_child(
        parentId IN RAW(13),
        childId IN RAW(13)
    )
    RETURNS RAW(13);
    
    Table 8 dbe_xml.xml_dom_append_child parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    parentId

    raw(13)

    IN

    No

    XML DOM object

    childId

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_create_element

    Returns the DOMElement object with the specified name.

    The prototype of the dbe_xml.xml_dom_create_element function is as follows:

    1
    2
    3
    4
    5
    dbe_xml.xml_dom_create_element(
        id IN RAW(13),
        tagname IN VARCHAR2
    )
    RETURNS RAW(13);
    
    Table 9 dbe_xml.xml_dom_create_element parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

    tagname

    VARCHAR2

    IN

    No

    Name of the new DOMElement object

  • dbe_xml.xml_dom_create_element_ns

    Returns the DOMElement object with the specified name and namespace.

    The prototype of the dbe_xml.xml_dom_create_element_ns function is as follows:

    1
    2
    3
    4
    5
    6
    dbe_xml.xml_dom_create_element_ns(
        id IN RAW(13),
        tagname IN VARCHAR2,
        ns IN VARCHAR2
    )
    RETURNS RAW(13);
    
    Table 10 dbe_xml.xml_dom_create_element_ns parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

    tagname

    VARCHAR2

    IN

    No

    Name of the new DOMElement object

    ns

    VARCHAR2

    IN

    No

    Namespace

  • dbe_xml.xml_dom_create_text_node

    Creates and returns a DOMText object.

    The prototype of the dbe_xml.xml_dom_create_text_node function is as follows:

    1
    2
    3
    4
    5
    dbe_xml.xml_dom_create_text_node(
        id IN RAW(13),
        data IN VARCHAR2
    )
    RETURNS RAW(13);
    
    Table 11 dbe_xml.xml_dom_create_text_node parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

    data

    VARCHAR2

    IN

    No

    Content of the new DOMText node

  • dbe_xml.xml_dom_free_document

    Frees a specified XML DOM object.

    The stored procedure prototype of dbe_xml.xml_dom_free_document is as follows:
    1
    2
    3
    4
    dbe_xml.xml_dom_free_document(
        id RAW(13)
    )
    RETURNS void;
    
    Table 12 dbe_xml.xml_dom_free_document parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_free_element

    Frees a specified XML DOM object.

    The stored procedure prototype of dbe_xml.xml_dom_free_element is as follows:

    dbe_xml.xml_dom_free_element (
        id RAW(13)
    )
    RETURNS void;
    Table 13 dbe_xml.xml_dom_free_element parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_free_node

    Frees a DOMNode node.

    The prototype of the dbe_xml.xml_dom_free_node function is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_free_node (
        id RAW(13)
    )
    RETURNS void;
    
    Table 14 dbe_xml.xml_dom_free_node parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_free_nodelist

    Frees a DOMNodeList node.

    The stored procedure prototype of dbe_xml.xml_dom_free_nodelist is as follows:

    1
    2
    3
    4
    5
    dbe_xml.xml_dom_free_nodelist(
        id IN RAW(13),
        node_value IN VARCHAR2
    )
    RETURNS VOID
    
    Table 15 dbe_xml.xml_dom_free_nodelist parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_get_attribute

    Obtains the attributes of a specified XML DOM object.

    The stored procedure prototype of dbe_xml.xml_dom_get_attribute is as follows:

    1
    2
    3
    4
    5
    dbe_xml.xml_dom_get_attribute (
        docid   IN  RAW(13),
        name    IN  VARCHAR2
    )
    RETURNS VARCHAR2;
    
    Table 16 dbe_xml.xml_dom_get_attribute parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    docid

    raw(13)

    IN

    No

    XML DOM object

    name

    VARCHAR2

    IN

    No

    String

  • dbe_xml.xml_dom_get_attributes

    Returns the attribute values of a DOMNode node as a map.

    The prototype of the dbe_xml.xml_dom_get_attributes function is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_get_attributes (
        id RAW(13)
    )
    RETURNS RAW(13);
    
    Table 17 dbe_xml.xml_dom_get_attributes parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_get_child_nodes

    Converts several subnodes under a node into a node list.

    The prototype of the dbe_xml.xml_dom_get_child_nodes function is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_get_child_nodes(
        id IN RAW(13)
    )
    RETURNS RAW(13);
    
    Table 18 dbe_xml.xml_dom_get_child_nodes parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_get_children_by_tagname

    Obtains the list of specified subnodes of a specified XML DOM object.

    The stored procedure prototype of dbe_xml.xml_dom_get_children_by_tagname is as follows:

    1
    2
    3
    4
    5
    dbe_xml.xml_dom_get_children_by_tagname (
        docid   IN  RAW(13),
        name    IN  VARCHAR2
    )
    RETURNS RAW(13);
    
    Table 19 dbe_xml.xml_dom_get_children_by_tagname parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    docid

    raw(13)

    IN

    No

    XML DOM object

    name

    VARCHAR2

    IN

    No

    String

  • dbe_xml.xml_dom_get_children_by_tagname_ns

    Obtains the list of subnodes in the specified namespace of a specified XML DOM object.

    The stored procedure prototype of dbe_xml.xml_dom_get_children_by_tagname_ns is as follows:

    1
    2
    3
    4
    5
    6
    dbe_xml.xml_dom_get_children_by_tagname_ns (
        docid   IN  RAW(13),
        name    IN  VARCHAR2,
        ns      IN  VARCHAR2
    )
    RETURNS RAW(13);
    
    Table 20 dbe_xml.xml_dom_get_children_by_tagname_ns parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    docid

    raw(13)

    IN

    No

    XML DOM object

    name

    VARCHAR2

    IN

    No

    String

    ns

    VARCHAR2

    IN

    Yes

    String

  • dbe_xml.xml_dom_get_document_element

    Returns the first subnode of the specified document.

    The stored procedure prototype of dbe_xml.xml_dom_get_document_element is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_get_document_element(
        id  RAW(13)
    )
    RETURNS RAW(13);
    
    Table 21 dbe_xml.xml_dom_get_document_element parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_get_first_child

    Returns the first subnode of a node.

    The prototype of the dbe_xml.xml_dom_get_first_child function is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_get_first_child(
        id IN RAW(13)
    )
    RETURNS RAW(13);
    
    Table 22 dbe_xml.xml_dom_get_first_child parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_get_last_child

    Returns the last subnode of a node.

    The prototype of the dbe_xml.xml_dom_get_last_child function is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_get_last_child(
        id IN RAW(13)
    )
    RETURNS RAW(13);
    
    Table 23 dbe_xml.xml_dom_get_last_child parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_get_length

    Returns the number of nodes based on the content in the node of the specified type.

    The stored procedure prototype of dbe_xml.xml_dom_get_length is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_get_length(
        id RAW(13)
    )
    RETURNS VOID;
    
    Table 24 dbe_xml.xml_dom_get_length parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    XML DOM object

  • dbe_xml.xml_dom_get_localname

    Returns the local name of the given object.

    The stored procedure prototype of dbe_xml.xml_dom_get_localname is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_get_localname (
        id  RAW(13)
    )
    RETURNS VARCHAR2;
    
    Table 25 dbe_xml.xml_dom_get_localname parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    XML DOM object

  • dbe_xml.xml_dom_get_named_item

    Returns the node specified by name.

    The prototype of the dbe_xml.xml_dom_get_named_item function is as follows:

    1
    2
    3
    4
    5
    dbe_xml.xml_dom_get_named_item(
        id IN RAW(13),
        nodeName IN VARCHAR2
    )
    RETURNS RAW(13);
    
    Table 26 dbe_xml.xml_dom_get_named_item parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

    nodeName

    VARCHAR2

    IN

    No

    Name of the element to be retrieved

  • dbe_xml.xml_dom_get_named_item_ns

    Returns the node specified by name and namespace.

    The prototype of the dbe_xml.xml_dom_get_named_item_ns function is as follows:

    1
    2
    3
    4
    5
    6
    dbe_xml.xml_dom_get_named_item_ns(
        id  RAW(13),
        nodeName IN VARCHAR2,
        ns IN VARCHAR2
    )
    RETURNS RAW(13);
    
    Table 27 dbe_xml.xml_dom_get_named_item_ns parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

    nodeName

    VARCHAR2

    IN

    No

    Name of the element to be retrieved

    ns

    VARCHAR2

    IN

    Yes

    Namespace

  • dbe_xml.xml_dom_get_next_sibling

    Returns the next node of the specified node.

    The prototype of the dbe_xml.xml_dom_get_next_sibling function is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_get_next_sibling(
        id IN RAW(13)
    )
    RETURNS RAW(13);
    
    Table 28 dbe_xml.xml_dom_get_next_sibling parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_get_node_name

    Returns the name of a node.

    The prototype of the dbe_xml.xml_dom_get_node_name function is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_get_node_name(
        id IN RAW(13)
    )
    RETURNS VARCHAR2;
    
    Table 29 dbe_xml.xml_dom_get_node_name parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_get_node_type

    Returns the type of a node.

    The prototype of the dbe_xml.xml_dom_get_node_type function is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_get_node_type(
        id IN RAW(13)
    )
    RETURNS INTEGER;
    
    Table 30 dbe_xml.xml_dom_get_node_type parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_get_node_value

    Returns the value of a DOMNode node.

    The stored procedure prototype of dbe_xml.xml_dom_get_node_value is as follows:

    1
    2
    3
    dbe_xml.xml_dom_get_node_value(
    id IN RAW(13))
    RETURNS VARCHAR2;
    
    Table 31 dbe_xml.xml_dom_get_node_value parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    XML DOM object

  • dbe_xml.xml_dom_get_parent_node

    Returns the parent node of the given DOMNode node.

    The stored procedure prototype of dbe_xml.xml_dom_get_parent_node is as follows:

    1
    2
    3
    dbe_xml.xml_dom_get_parent_node(
    id IN RAW(13))
    RETURNS RAW(13);
    
    Table 32 dbe_xml.xml_dom_get_parent_node parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    XML DOM object

  • dbe_xml.xml_dom_get_tagname

    Obtains the tag name of a specified XML DOM object.

    The stored procedure prototype of dbe_xml.xml_dom_get_tagname is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_get_tagname (
        docid RAW(13)
    )
    RETURNS VARCHAR2;
    
    Table 33 dbe_xml.xml_dom_get_tagname parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    docid

    raw(13)

    IN

    Yes

    XML DOM object

  • dbe_xml.xml_dom_has_child_nodes

    Checks whether the DOMNode object has any subnode.

    The stored procedure prototype of dbe_xml.xml_dom_has_child_nodes is as follows:

    1
    2
    3
    dbe_xml.xml_dom_has_child_nodes(
    id IN RAW(13))
    RETURNS BOOLEAN
    
    Table 34 dbe_xml.xml_dom_has_child_nodes parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    XML DOM object

  • dbe_xml.xml_dom_import_node

    Copies a node to another node and mounts the copied node to a specified document. If the type of the copied node does not belong to the 12 types specified by constants of XML DOM, an exception indicating that the type is not supported is thrown.

    The prototype of the dbe_xml.xml_dom_import_node function is as follows:

    1
    2
    3
    4
    5
    6
    dbe_xml.xml_dom_import_node(
        doc_id IN RAW(13),
        node_id IN RAW(13),
        deep IN BOOLEAN
    )
    RETURNS RAW(13);
    
    Table 35 dbe_xml.xml_dom_import_node parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    doc_id

    raw(13)

    IN

    No

    Document to which the node is mounted

    node_id

    raw(13)

    IN

    No

    Node to be imported

    deep

    BOOLEAN

    IN

    No

    Specifies whether to perform recursive import.
    • If the value is TRUE, the node and all its subnodes are imported.
    • If the value is FALSE, the node itself is imported.
  • dbe_xml.xml_dom_is_null

    Checks whether the given object is null. If yes, TRUE is returned. Otherwise, FALSE is returned.

    The prototype of the dbe_xml.xml_dom_is_null function is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_is_null (
        id  RAW(13)
    )
    RETURNS boolean;
    
    Table 36 dbe_xml.xml_dom_is_null parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    XML DOM object

  • dbe_xml.xml_dom_item

    Returns the element corresponding to the index in a list or map based on the index.

    The prototype of the dbe_xml.xml_dom_item function is as follows:

    1
    2
    3
    4
    5
    dbe_xml.xml_dom_item (
        id IN RAW(13),
        index IN INTEGER
    )
    RETURNS RAW(13);
    
    Table 37 dbe_xml.xml_dom_item parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

    index

    INTEGER

    IN

    No

    Index of the element to be retrieved

  • dbe_xml.xml_dom_make_element

    Returns the DOMElement object after conversion.

    The stored procedure prototype of dbe_xml.xml_dom_make_element is as follows:

    1
    2
    3
    dbe_xml.xml_dom_make_element(
    id IN RAW(13))
    RETURNS RAW(13)
    
    Table 38 dbe_xml.xml_dom_make_element parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

  • dbe_xml.xml_dom_makenode

    Converts the given object to the DOMNode type.

    The stored procedure prototype of dbe_xml.xml_dom_makenode is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_makenode(
       id    RAW(13)
    )
    RETURNS DOMNODE;
    
    Table 39 dbe_xml.xml_dom_makenode parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    XML DOM object

  • dbe_xml.xml_dom_new_dom_document_empty

    Returns a new DOMDocument object.

    The prototype of the dbe_xml.xml_dom_new_dom_document_empty function is as follows:

    1
    2
    dbe_xml.xml_dom_new_dom_document_empty()
    RETURNS RAW(13);
    
  • xml_dom_new_dom_document_clob

    Returns a new DOMDocument instance object created from the specified CLOB type.

    The prototype of the xml_dom_new_dom_document_clob function is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_new_dom_document_clob(
        content IN  clob
    )
    RETURNS RAW(13);
    
    Table 40 xml_dom_new_dom_document_clob parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    content

    clob

    IN

    No

    Specified CLOB type

  • dbe_xml.xml_dom_new_document_xmltype

    Returns a new DOMDocument instance object created from the specified XMLType type.

    The prototype of the dbe_xml.xml_dom_new_document_xmltype function is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_new_document_xmltype(
        content IN  clob
    )
    RETURNS RAW(13);
    
    Table 41 dbe_xml.xml_dom_new_document_xmltype parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    content

    clob

    IN

    No

    Specified CLOB type

  • dbe_xml.xml_dom_set_attribute

    Sets the attributes of a specified XML DOM object.

    The stored procedure prototype of dbe_xml.xml_dom_set_attribute is as follows:

    1
    2
    3
    4
    5
    6
    dbe_xml.xml_dom_set_attribute(
        docid   IN  RAW(13),
        name    IN  VARCHAR2,
        value   IN  VARCHAR2
    )
    RETURNS void;
    
    Table 42 dbe_xml.xml_dom_set_attribute parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

    name

    VARCHAR2

    IN

    No

    String

    value

    VARCHAR2

    IN

    No

    String

  • dbe_xml.xml_dom_set_charset

    Sets the character set for a DOMDocument object.

    The prototype of the dbe_xml.xml_dom_set_charset function is as follows:

    1
    2
    3
    4
    5
    dbe_xml.xml_dom_set_charset(
        id      IN RAW(13),
        charset IN VARCHAR2
    )
    RETURNS void;
    
    Table 43 dbe_xml.xml_dom_set_charset parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

    charset

    VARCHAR2

    IN

    No

    Character set

  • dbe_xml.xml_dom_set_doctype

    Sets the external DTD of a DOMDocument object.

    The prototype of the dbe_xml.xml_dom_set_doctype function is as follows:

    1
    2
    3
    4
    5
    6
    7
    dbe_xml.xml_dom_set_doctype(
        id          IN  RAW(13),
        dtd_name    IN  VARCHAR2,
        system_id   IN  VARCHAR2,
        public_id   IN  VARCHAR2
    )
    RETURNS void;
    
    Table 44 dbe_xml.xml_dom_set_doctype parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

    dtd_name

    VARCHAR2

    IN

    No

    Name of the DOCType to be initialized

    system_id

    VARCHAR2

    IN

    No

    ID of the system whose DOCType needs to be initialized

    public_id

    VARCHAR2

    IN

    No

    Public ID of the DOCType to be initialized

  • dbe_xml.xml_dom_set_node_value

    Sets the value of a node in the DOMNode object.

    The stored procedure prototype of dbe_xml.xml_dom_set_node_value is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_set_node_value(
    id IN RAW(13),
    node_value IN VARCHAR2)
    RETURNS VOID
    
    Table 45 dbe_xml.xml_dom_set_node_value parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

    node_value

    VARCHAR2

    IN

    No

    String to be set in the DOMNode object

  • dbe_xml.xml_dom_write_to_buffer_doc

    Writes the given DOMDocument object to the buffer.

    The stored procedure prototype of dbe_xml.xml_dom_write_to_buffer_doc is as follows:

    1
    2
    3
    dbe_xml.dbe_xml.xml_dom_write_to_buffer_doc(
    id IN RAW(13))
    RETURNS VARCHAR2;
    
    Table 46 dbe_xml.xml_dom_write_to_buffer_doc parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    XML DOM object

  • dbe_xml.xml_dom_write_to_buffer_node

    Writes the given DOMNode object to the buffer.

    The stored procedure prototype of dbe_xml.xml_dom_write_to_buffer_node is as follows:

    1
    2
    3
    dbe_xml.dbe_xml.xml_dom_write_to_buffer_node(
    id IN RAW(13))
    RETURNS VARCHAR2;
    
    Table 47 dbe_xml.xml_dom_write_to_buffer_node parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    XML DOM object

  • dbe_xml.xml_dom_write_to_clob_doc

    Writes the given DOMDocument object to a CLOB.

    The stored procedure prototype of dbe_xml.xml_dom_write_to_clob_doc is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_write_to_clob_doc(
        id IN RAW(13)
    )
    RETURNS VARCHAR2;
    
    Table 48 dbe_xml.xml_dom_write_to_clob_doc parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    XML DOM object

  • dbe_xml.xml_dom_write_to_clob_node

    Writes the given DOMNode object to a CLOB.

    The stored procedure prototype of dbe_xml.xml_dom_write_to_clob_node is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_write_to_clob_node(
        id          IN  RAW(13)
    )
    RETURNS clob;
    
    Table 49 dbe_xml.xml_dom_write_to_clob_node parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    XML DOM object

  • dbe_xml.xml_dom_write_to_file_doc

    Writes an XML node to a specified file using the database character set.

    The stored procedure prototype of dbe_xml.xml_dom_write_to_file_doc is as follows:

     1
     2
     3
     4
     5
     6
     7
     8
     9
    10
    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
    
    Table 50 dbe_xml.xml_dom_write_to_file_doc parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    Yes

    XML DOM object

    file_dir

    VARCHAR2

    IN

    No

    File to be written

    charset

    VARCHAR2

    IN

    No

    Specified character set

  • dbe_xml.xml_dom_write_to_file_node

    Writes an XML node to a specified file using the database character set.

    The stored procedure prototype of dbe_xml.xml_dom_write_to_file_node is as follows:

    1
    2
    3
    4
    dbe_xml.xml_dom_write_to_file_node(
    id IN  RAW(13),
    filename IN  VARCHAR2)
    RETURNS void
    
    Table 51 dbe_xml.xml_dom_write_to_file_node parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object

    filename

    VARCHAR2

    IN

    No

    Specified file address

  • dbe_xml.xml_dom_get_session_tree_num

    Queries the number of DOM trees of all types in the current session.

    The prototype of the dbe_xml.xml_dom_get_session_tree_num function is as follows:

    1
    2
    dbe_xml.xml_dom_get_session_tree_num()
    RETURNS INTEGER
    
  • dbe_xml.xml_dom_get_doc_trees_info

    Queries the DOM tree information of the document type in the current session, such as the memory usage.

    The prototype of the dbe_xml.xml_dom_get_doc_trees_info function is as follows:

    1
    2
    dbe_xml.xml_dom_get_doc_trees_info()
    RETURNS VARCHAR2
    
  • dbe_xml.xml_dom_get_detail_doc_tree_info

    Queries the number of subnodes of each type in the transferred document.

    The prototype of the dbe_xml.xml_dom_get_detail_doc_tree_info function is as follows:

    1
    2
    3
    dbe_xml.xml_dom_get_detail_doc_tree_info(
    id IN  RAW(13))
    RETURNS VARCHAR2
    
    Table 52 dbe_xml.xml_dom_get_detail_doc_tree_info parameters

    Parameter

    Type

    Input/Output Parameter

    Can Be Empty

    Description

    id

    raw(13)

    IN

    No

    XML DOM object