Manual

# XML类型函数以下函数兼容Postgres 9.2。 - xmlparse ( { DOCUMENT \| CONTENT } value \[wellformed\]) 描述：使用函数xmlparse，从字符数据产生XML类型的值。参数：数据类型为text。返回值类型：XML 示例： ``` gaussdb=# SELECT XMLPARSE (DOCUMENT 'Manual...'); xmlparse ---------------------------------------------------------- Manual... (1 row) gaussdb=# SELECT XMLPARSE (CONTENT 'abcbarfoo'); xmlparse --------------------------------- abcbarfoo (1 row) gaussdb=# SELECT XMLPARSE (CONTENT 'abcbarbarbad' as text); xmlserialize ------------------ bad (1 row) ``` ![](https://support.huaweicloud.com/centralized-devg-v3-gaussdb/public_sys-resources/note_3.0-zh-cn.png) 当一个字符串值在没有通过XMLPARSE或XMLSERIALIZE的情况下，与xml类型进行转换时，具体选择DOCUMENT或CONTENT由"XML option" 会话配置参数决定，这个配置参数可以由标准命令来设置： ``` SET XML OPTION { DOCUMENT | CONTENT }; ``` 或使用类似的语法来设置： ``` SET xmloption TO { DOCUMENT | CONTENT }; ``` - xmlcomment(text) 描述：创建一个XML值，并且它包含一个用指定文本作为内容的XML注释。该文本不包含"--"字符且结尾不存在"-"字符、符合XML注释的格式要求。且当参数为空时、结果也为空。参数：数据类型为text。返回值类型：XML 示例： ``` gaussdb=# SELECT xmlcomment('hello'); xmlcomment -------------- ``` - xmlconcat(xml\[, ...\]) 描述：将由单个XML值组成的列表串接成一个单独的值，该值包含一个XML的内容片段。其中空值会被忽略，并且只有当所有参数都为空时结果才为空。在兼容A数据库模式下，设置a_format_version值为10c和a_format_dev_version值为s2，增加了校验输入片段是否为非良构xml文本。参数：数据类型为XML。返回值类型：XML 示例1： ``` gaussdb=# set xmloption=content; SET gaussdb=# select XMLCONCAT(('foo'),('foo')) ; xmlconcat ------------------------------------------------------------------- foofoo (1 row) gaussdb=# select XMLCONCAT('abc>'); xmlconcat ----------- abc> (1 row) ``` 示例2：兼容A数据库的语法示例。 ``` gaussdb=# set a_format_version='10c'; SET gaussdb=# set a_format_dev_version=s2; SET gaussdb=# set xmloption=content; SET gaussdb=# select XMLCONCAT(('foo'),('foo')) ; xmlconcat ------------------------------------------------------------------- foofoo (1 row) gaussdb=# select XMLCONCAT('abc>'); ERROR: invalid XML document DETAIL: line 1: Start tag expected, '<' not found abc> ^ CONTEXT: referenced column: xmlconcat ``` - xmlelement( \[ ENTITYESCAPING \| NOENTITYESCAPING \] { \[ NAME \] element_name \| EVALNAME element_name } \[ , xmlattributes( \[ ENTITYESCAPING \| NOENTITYESCAPING \] value \[ \[ AS \] attname \| AS EVALNAME attname \] \[ , ... \] ) \] \[ , content \[ \[ AS \] alias \] \[ , ... \] \] ) 描述：使用给定的名称、属性和内容产生一个XML元素。返回值类型：XML 示例： ``` gaussdb=# SELECT xmlelement(name foo); xmlelement ------------ 在A兼容模式下： gaussdb=# set a_format_version='10c'; SET gaussdb=# set a_format_dev_version=s2; SET 1.xmlelement中默认不设置或者设置ENTITYESCAPING关键字时，xmlelement的内容中的保留字符将被转义： gaussdb=# SELECT xmlelement("entityescaping<>", 'a$><&"b'); xmlelement ------------------------------------------------------------- >a$><&"b> (1 row) gaussdb=# SELECT xmlelement(entityescaping "entityescaping<>", 'a$><&"b'); xmlelement ------------------------------------------------------------- >a$><&"b> (1 row) 2.xmlelement中设置NOENTITYESCAPING关键字时，xmlelement的内容中的保留字符将不会被转义： gaussdb=# SELECT xmlelement(noentityescaping "entityescaping<>", 'a$><&"b'); xmlelement ---------------------------------------------- >a$><&"b> (1 row) 3.xmlelement中对内容使用[as] alias声明别名时，内容值类型必须为xml类型： gaussdb=# SELECT xmlelement("entityescaping<>", '' b); ERROR: argument of XMLELEMENT must be type xml, not type unknown LINE 1: SELECT xmlelement("entityescaping<>", '' b); ^ CONTEXT: referenced column: xmlelement gaussdb=# SELECT xmlelement("entityescaping<>", '' as b); ERROR: argument of XMLELEMENT must be type xml, not type unknown LINE 1: SELECT xmlelement("entityescaping<>", '' as b); ^ CONTEXT: referenced column: xmlelement gaussdb=# SELECT xmlelement("entityescaping<>", xml('') b); xmlelement --------------------------------------------- >> (1 row) gaussdb=# SELECT xmlelement("entityescaping<>", xml('') as b); xmlelement --------------------------------------------- >> (1 row) 4.xmlattributes中默认不设置或者设置ENTITYESCAPING关键字时，xmlattributes的内容中的保留字符将被转义： gaussdb=# SELECT xmlelement("entityescaping<>", xmlattributes('entityescaping<>' "entityescaping<>")); xmlelement --------------------------------------------------------------- entityescaping<>="entityescaping<>"/> (1 row) gaussdb=# SELECT xmlelement(name "entityescaping<>", xmlattributes(entityescaping 'entityescaping<>' "entityescaping<>")); xmlelement --------------------------------------------------------------- entityescaping<>="entityescaping<>"/> (1 row) 5.xmlattributes中设置NOENTITYESCAPING关键字时，xmlattributes的内容中的保留字符将不会被转义： gaussdb=# SELECT xmlelement("entityescaping<>", xmlattributes(noentityescaping 'entityescaping<>' "entityescaping<>")); xmlelement --------------------------------------------------------- entityescaping<>="entityescaping<>"/> (1 row) ``` ![](https://support.huaweicloud.com/centralized-devg-v3-gaussdb/public_sys-resources/note_3.0-zh-cn.png) 1. xmlelement和xmlattributes的name字段赋NULL时，行为与A数据库不一致。xmlelement的name字段赋NULL时，结果显示name信息为空，且不显示属性信息。xmlattributes的name字段赋NULL时，不显示属性信息。 2. 设置如下两个参数后，xmlelement的内容转义规则为A兼容，未设置时xmlelement的内容转义规则为PG兼容。 ``` set a_format_version='10c'; set a_format_dev_version=s2; ``` - xmlforest(content \[AS name\] \[, ...\]) 描述：使用给定名称和内容产生一个元素的XML序列。返回值类型：XML 示例： ``` gaussdb=# SELECT xmlforest('abc' AS foo, 123 AS bar); xmlforest ------------------------------ abc123 ``` - xmlpi(name target \[, content\]) 描述：创建一个XML处理指令。若内容不为空，则内容不能包含字符序列。返回值类型：XML 示例： ``` gaussdb=# SELECT xmlpi(name php, 'echo "hello world";'); xmlpi ----------------------------- ``` - xmlroot(xml, version text \| no value \[, standalone yes\|no\|no value\]) 描述：修改一个XML值的根节点的属性。如果指定了一个版本，它会替换根节点的版本声明中的值，如果指定了一个独立设置，它会替换根节点的独立声明中的值。示例： ``` gaussdb=# SELECT xmlroot('abc',version '1.0', standalone yes); xmlroot -------------------------------------------------------------- abc (1 row) ``` - xmlagg(xml \[order_by_clause\]) 描述：该函数是一个聚集函数、它将聚集函数调用的输入值串接起来，且支持跨行串接，order_by_clause详见[SELECT](https://support.huaweicloud.com/centralized-devg-v3-gaussdb/gaussdb-42-0649.html#ZH-CN_TOPIC_0000002200419502)。在兼容A数据库模式下，设置a_format_version值为10c和a_format_dev_version值为s2，数据库xmloption参数默认为content，当xmloption设置为document时，使用换行符串接多行xml。若xml声明中encoding属性值不为默认编码UTF-8时，聚集结果有xml声明。参数：XML 返回值类型：XML 示例1： ``` gaussdb=# CREATE TABLE xmltest ( id int, data xml ); gaussdb=# INSERT INTO xmltest VALUES (1, 'one'); INSERT 0 1 gaussdb=# INSERT INTO xmltest VALUES (2, 'two'); INSERT 0 1 gaussdb=# SELECT xmlagg(data) FROM xmltest; xmlagg -------------------------------------- onetwo (1 row) ``` 示例2：兼容A数据库的语法示例。 ``` gaussdb=# set xmloption=document; SET gaussdb=# SELECT xmlagg(data) FROM xmltest; xmlagg -------------------- one+ two (1 row) gaussdb=# DELETE FROM XMLTEST; DELETE 2 gaussdb=# INSERT INTO xmltest VALUES (1, 'one'); INSERT 0 1 gaussdb=# INSERT INTO xmltest VALUES (2, 'two'); INSERT 0 1 gaussdb=# SELECT xmlagg(data) FROM xmltest; xmlagg -------------------------------------------------------- one+ two (1 row) gaussdb=# SELECT xmlagg(data order by id desc) FROM xmltest; xmlagg -------------------------------------------------------- two+ one (1 row) gaussdb=# DROP TABLE xmltest; ``` - xmlexists(text passing \[BY REF\] xml \[BY REF\]) 描述：评价一个XPath 1.0表达式(第一个参数)，以传递的XML值作为其上下文项。如果评价的结果产生一个空节点集，该函数返回false，如果产生任何其他值，则返回true。如果任何参数为空，则函数返回null。作为上下文项传递的非空值必须是一个XML文档，而不是内容片段或任何非XML值。参数：XML 返回值类型：BOOLEAN 示例： ``` gaussdb=# SELECT xmlexists('//town[text() = ''Toronto'']' PASSING BY REF 'TorontoOttawa'); xmlexists ------------ t (1 row) ``` - xml_is_well_formed(text) 描述：检查text是不是正确的XML类型格式、返回值为布尔类型。参数：text 返回值类型：BOOLEAN 示例： ``` gaussdb=# SELECT xml_is_well_formed('<>'); xml_is_well_formed -------------------- f (1 row) ``` - xml_is_well_formed_document(text) 描述：检查text是不是正确的XML类型格式、返回值为布尔类型。参数：text 返回值类型：BOOLEAN 示例： ``` gaussdb=# SELECT xml_is_well_formed_document('bar'); xml_is_well_formed_document ----------------------------- t (1 row) ``` - xml_is_well_formed_content(text) 描述：检查text是不是正确的XML类型格式、返回值为布尔类型。参数：text 返回值类型：BOOLEAN 示例： ``` gaussdb=# select xml_is_well_formed_content('k'); xml_is_well_formed_content ---------------------------- t (1 row) ``` - xpath(xpath, xml \[, nsarray\]) 描述：在XML类型的数据xml上计算XPath 1.0表达式如：xpath (a text value)。它返回一个XML值的数组，该数组对应于该XPath表达式产生的节点集合。如果该XPath表达式返回一个标量值而不是一个节点集合，将会返回一个单一元素的数组。第二个参数必须是一个良构的XML文档。注意，它必须有一个单一根节点元素。该函数可选的第三个参数是一个名字空间映射的数组。这个数组应该是一个二维text数组，其第二轴长度等于2（即它应该是一个数组的数组，其中每一个都刚好由2个元素组成）。每个数组项的第一个元素是名字空间的名称（别名），第二个元素是名字空间的URI。并不要求在这个数组中提供的别名和在XML文档本身中使用的那些名字空间相同（换句话说，在XML文档中和在xpath函数环境中，别名都是本地的）。返回值类型：XML 示例： ``` gaussdb=# SELECT xpath('/my:a/text()', 'test',ARRAY[ARRAY['my', 'http://example.com']]); xpath -------- {test} (1 row) ``` - xpath_exists(xpath, xml \[, nsarray\]) 描述：该函数是xpath函数的一种特殊形式。这个函数不是返回满足XPath 1.0表达式的单一XML值，它返回一个布尔值表示查询是否被满足(具体来说，它是否产生了空节点集以外的任何值)。这个函数等价于标准的XMLEXISTS谓词，不过它还提供了对一个名字空间映射参数的支持。返回值类型：BOOLEAN 示例： ``` gaussdb=# SELECT xpath_exists('/my:a/text()', 'test',ARRAY[ARRAY['my', 'http://example.com']]); xpath_exists -------------- t (1 row) ``` ![](https://support.huaweicloud.com/centralized-devg-v3-gaussdb/public_sys-resources/note_3.0-zh-cn.png) 以下XML类型函数示例中，需进行前置数据准备，如下所示： ``` gaussdb=# CREATE SCHEMA testxmlschema; CREATE SCHEMA gaussdb=# CREATE TABLE testxmlschema.test1 (a int, b text); CREATE TABLE gaussdb=# INSERT INTO testxmlschema.test1 VALUES (1, 'one'), (2, 'two'), (-1, null); INSERT 0 3 gaussdb=# CREATE DATABASE test; CREATE DATABASE --示例执行结束后，可使用如下命令删除上述前置数据： gaussdb=# DROP DATABASE test; DROP DATABASE gaussdb=# DROP TABLE testxmlschema.test1; DROP TABLE gaussdb=# DROP SCHEMA testxmlschema; DROP SCHEMA ``` - query_to_xml(query text, nulls boolean, tableforest boolean, targetns text) 描述：该函数会将query查询的内容映射成XML模式文档。返回值类型：XML 示例： ``` gaussdb=# SELECT query_to_xml('SELECT * FROM testxmlschema.test1', false, false, ''); query_to_xml --------------------------------------------------------------- + + + 1 + one + + + + 2 + two + + + + -1 + + +

+ (1 row) ``` - query_to_xmlschema(query text, nulls boolean, tableforest boolean, targetns text) 描述：该函数会将query查询的内容映射成XML文档和XML模式文档，并把两个文档连接在一起。返回值类型：XML 示例： ``` gaussdb=# SELECT query_to_xmlschema('SELECT * FROM testxmlschema.test1', false, false, ''); query_to_xmlschema ---------------------------------------------------------------------------------------------- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + (1 row) ``` - query_to_xml_and_xmlschema(query text, nulls boolean, tableforest boolean, targetns text) 描述：该函数会将query查询的内容映射成XML文档和XML模式文档，并把两个文档连接在一起。返回值类型：XML 示例： ``` gaussdb=# SELECT query_to_xml_and_xmlschema('SELECT * FROM testxmlschema.test1', true, true, ''); query_to_xml_and_xmlschema ------------------------------------------------------------------------------------------------ + + + + + + + + + + + + + + + + + + + + + + + + + + + 1 + one + + + + + 2 + two + + + + + -1 + + + + (1 row) ``` - cursor_to_xml(cursor refcursor, count int, nulls boolean,tableforest boolean, targetns text) 描述：该函数会将游标查询的内容映射成XML文档。返回值类型：XML 示例： ``` gaussdb=#CURSOR xc WITH HOLD FOR SELECT * FROM testxmlschema.test1 ORDER BY 1, 2; DECLARE CURSOR gaussdb=# SELECT cursor_to_xml('xc'::refcursor, 5, false, true, ''); cursor_to_xml ------------------------------------------------------------- + + -1 + + + + + 1 + one + + + + + 2 + two + + + (1 row) ``` - cursor_to_xmlschema(cursor refcursor, nulls boolean, tableforest boolean, targetns text) 描述：该函数会将游标查询的内容映射成XML模式文档。返回值类型：XML 示例： ``` gaussdb=# SELECT cursor_to_xmlschema('xc'::refcursor, true, false, ''); cursor_to_xmlschema ------------------------------------------------------------------------------------------------ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + (1 row) ``` - schema_to_xml(schema name, nulls boolean, tableforest boolean, targetns text) 描述：该函数会将整个模式的内容映射成XML文档。返回值类型：XML 示例： ``` gaussdb=# SELECT schema_to_xml('testxmlschema', false, true, ''); schema_to_xml ----------------------------------------------------------------------- + + + + 1 + one + + + + + 2 + two + + + + + -1 + + + + + (1 row) ``` - schema_to_xmlschema(schema name, nulls boolean, tableforest boolean, targetns text) 描述：该函数会将整个模式的内容映射成XML模式文档。返回值类型：XML 示例： ``` gaussdb=# SELECT schema_to_xmlschema('testxmlschema', false, true, ''); schema_to_xmlschema ----------------------------------------------------------------------------------------------------------- + + + + + + + + + + + + + + + + + + + + + + (1 row) ``` - schema_to_xml_and_xmlschema(schema name, nulls boolean, tableforest boolean, targetns text) 描述：该函数会将整个模式的内容映射成XML文档和XML模式文档，并把两个文档连接在一起。返回值类型：XML 示例： ``` gaussdb=# SELECT schema_to_xml_and_xmlschema('testxmlschema', true, true, 'foo'); schema_to_xml_and_xmlschema -------------------------------------------------------------------------------------------------------------- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1 + one + + + + + 2 + two + + + + + -1 + + + + + + (1 row) ``` - database_to_xml(nulls boolean, tableforest boolean, targetns text) 描述：该函数会将整个数据库的内容映射成XML文档。返回值类型：XML 示例： ``` gaussdb=# SELECT database_to_xml(true, true, 'test'); database_to_xml --------------------------------------------------------------------------- + + + + + + + + + + + + + + + + + + + (1 row) ``` - database_to_xmlschema(nulls boolean, tableforest boolean, targetns text) 描述：该函数会将整个数据库的内容映射成XML模式文档。返回值类型：XML 示例： ``` gaussdb=# SELECT database_to_xmlschema(true, true, 'test'); database_to_xmlschema ------------------------------------------------------------------------------------------ + + + + + + + + + + + + + (1 row) ``` - database_to_xml_and_xmlschema(nulls boolean, tableforest boolean, targetns text) 描述：该函数会将整个模式的内容映射成XML文档和XML模式文档，并把两个文档连接在一起。返回值类型：XML 示例： ``` gaussdb=# SELECT database_to_xml_and_xmlschema(true, true, 'test'); database_to_xml_and_xmlschema ------------------------------------------------------------------------------------------------------- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + (1 row) ``` - table_to_xml(tbl regclass, nulls boolean, tableforest boolean, targetns text) 描述：该函数会将关系表的内容映射成XML文档。返回值类型：XML 示例： ``` gaussdb=# SELECT table_to_xml('testxmlschema.test1', false, false, ''); table_to_xml --------------------------------------------------------------- + + + 1 + one + + + + 2 + two + + + + -1 + + + + (1 row) ``` - table_to_xmlschema(tbl regclass, nulls boolean, tableforest boolean, targetns text) 描述：该函数会将关系表的内容映射成XML模式文档。返回值类型：XML 示例： ``` gaussdb=# SELECT table_to_xmlschema('testxmlschema.test1', false, false, ''); table_to_xmlschema ----------------------------------------------------------------------------------------------------------------- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + (1 row) ``` - table_to_xml_and_xmlschema(tbl regclass, nulls boolean, tableforest boolean, targetns text) 描述：该函数会将关系表的内容映射成XML文档和XML模式文档，并把两个文档连接在一起。返回值类型：XML 示例： ``` gaussdb=# SELECT table_to_xml_and_xmlschema('testxmlschema.test1', false, false, ''); table_to_xml_and_xmlschema ----------------------------------------------------------------------------------------------------------------- + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1 + one + + + + 2 + two + + + + -1 + + + + (1 row) ``` ![](https://support.huaweicloud.com/centralized-devg-v3-gaussdb/public_sys-resources/note_3.0-zh-cn.png) - xpath相关函数仅支持xpath() 和xpath_exists()，由于其使用xpath语言查询XML文档，而这些函数都依赖于libxml2 库，且这个库仅在Xpath1.0提供，所以对XPath的限制为1.0。 - 不支持xquery、xml extension、xslt功能。