VastbaseG100

基于openGauss内核开发的企业级关系型数据库。

Menu

sp_xml_preparedocument

功能描述

sp_xml_preparedocument用于初始化XML文本数据到XML类型数据。其读取输入的XML文本,在内存中对XML文本进行分析,并返回XML结构句柄;该句柄可用于访问 XML 文档的新创建的内部表示形式。

  • 此句柄在会话期间有效,或直到通过执行 sp_xml_removedocument将句柄失效为止。
  • 返回的句柄是递增的,最多同时存在10000个。

经由sp_xml_preparedocument处理后的结果可被OPENXML运算符解析得到结果集。

注意事项

  • 该功能仅在数据库兼容模式为SQL Server时支持(即数据库实例初始化时指定DBCOMPATIBILITY='MSSQL')。

  • 在调用函数对XML进行处理时,如需将XML文本赋值给@变量使用,则必须设置参数enable_set_variable_mssql_format为on,表示允许数据库在SQL Server兼容模式下使用自定义用户变量的功能。

  • sp_xml_preparedocument 将一次可以打开的元素数限制为 256。

语法格式

sp_xml_preparedocument hdoc OUTPUT
    [ , xmltext ]
    [ , xpath_namespaces ]
[ ; ]

参数说明

  • hdoc

    新创建的XML文档的句柄,整型。

  • [ xmltext ]

    原始XML文档。

    xmltext是一个文本参数,默认值为 NULL,在此情况下将创建一个空XML文档的内部表示形式。

  • [ xpath_namespaces ]

    指定生成的XML结构命名空间声明。

    xpath_namespaces 是一个文本参数,默认值为<root xmlns:mp="urn:schemas-microsoft-com:xml-metaprop">

    xpath_namespaces 提供OPENXML中XPath 表达式中使用的前缀的命名空间 URI,以及格式正确的 XML 文档。

返回值

  • 0:成功

  • > 0:失败

示例

参考OPENXML的示例

参考链接

openxmlsp_xml_removedocument