9.14. XML 函数

9.14.1.1. xmlcomment

xmlcomment(text)

xmlcomment函数创建一个包含XML注释的特定文本内容的值。 文本中不能包含"--"或以"-" 的结束，这样的文本是有效的XML注释。如果参数是空，结果是空。

例子：

SELECT xmlcomment('hello');

  xmlcomment
--------------
 <!--hello-->

9.14.1.2. xmlconcat

xmlconcat(xml[, ...])

函数xmlconcat连接一个独立的XML值列表来创建一个包含XML内容片段的单值。 忽略空值；只有当参数都为空时结果是空。

例子：

SELECT xmlconcat('<abc/>', '<bar>foo</bar>');

      xmlconcat
----------------------
 <abc/><bar>foo</bar>

XML声明，如果存在，结合如下。如果所有参数使用相同的XML版本声明，则在结果中使用版本。 否则不用版本。如果所有的参数值有独立的声明值"yes"， 然后这个值在结果里使用。如果所有的参数值有独立的声明，并且至少有一个是"no"， 然后这个值在结果里使用。否则结果将没有独立声明。如果结果决定需要一个独立的声明， 但没有声明版本，将使用一个带有版本1.0的版本声明，因为XML需要一个XML声明包含版本声明。 忽略并且在所有情况下删除编码声明。

例子：

SELECT xmlconcat('<?xml version="1.1"?><foo/>', '<?xml version="1.1" standalone="no"?><bar/>');

             xmlconcat
-----------------------------------
 <?xml version="1.1"?><foo/><bar/>

9.14.1.3. xmlelement

xmlelement(name name [, xmlattributes(value [AS attname] [, ... ])] [, content, ...])

xmlelement表达式生成一个带有给定名称，属性和内容的XML元素。

例子：

SELECT xmlelement(name foo);

 xmlelement
------------
 <foo/>

SELECT xmlelement(name foo, xmlattributes('xyz' as bar));

    xmlelement
------------------
 <foo bar="xyz"/>

SELECT xmlelement(name foo, xmlattributes(current_date as bar), 'cont', 'ent');

             xmlelement
-------------------------------------
 <foo bar="2007-01-26">content</foo>

不是有效的XML元素和属性名的名称由序列_xHHHH_ 替换有问题的字符转义，这里的HHHH 是字符的16进制形式的Unicode代码点。例如：

SELECT xmlelement(name "foo$bar", xmlattributes('xyz' as "a&b"));

            xmlelement
----------------------------------
 <foo_x0024_bar a_x0026_b="xyz"/>

如果属性值是一个列引用则不用指定明确的属性名称，在这种情况下，列的名称将默认为属性名。 在其它情况下，属性必须给予一个明确的名称。因此，这个例子是有效的：

CREATE TABLE test (a xml, b xml);
SELECT xmlelement(name test, xmlattributes(a, b)) FROM test;

但是这些不是:

SELECT xmlelement(name test, xmlattributes('constant'), a, b) FROM test;
SELECT xmlelement(name test, xmlattributes(func(a, b))) FROM test;

如果指定了元素内容，将根据它的数据类型格式化。如果内容自身是xml类型， 可以构造复杂的xml文档。例如：

SELECT xmlelement(name foo, xmlattributes('xyz' as bar),
                            xmlelement(name abc),
                            xmlcomment('test'),
                            xmlelement(name xyz));

                  xmlelement
----------------------------------------------
 <foo bar="xyz"><abc/><!--test--><xyz/></foo>

将其它类型的内容格式化为有效的xml字符串数据。这意味着特殊的字符<, >, 和&将转化为实体。二进制数据（bytea数据类型） 将用base64或16进制编码表示，取决于配置参数xmlbinary的设置。 单个数据类型的特定行为预计将发展为了使SQL和PostgreSQL数据类型和XML架构规范一致， 到时将出现更准确描述。

9.14.1.4. xmlforest

xmlforest(content [AS name] [, ...])

xmlforest表达式生成一个使用指定的名称和内容的XML 森林（序列）元素。

示例:

SELECT xmlforest('abc' AS foo, 123 AS bar);

          xmlforest
------------------------------
 <foo>abc</foo><bar>123</bar>


SELECT xmlforest(table_name, column_name)
FROM information_schema.columns
WHERE table_schema = 'pg_catalog';

                                         xmlforest
-------------------------------------------------------------------------------------------
 <table_name>pg_authid</table_name><column_name>rolname</column_name>
 <table_name>pg_authid</table_name><column_name>rolsuper</column_name>
 ...

在第二个例子可以看出，如果内容值为列引用，元素名称可以省略。在这种情况下， 默认使用列名。否则，必须指定名称。

非法XML名的元素名称，像上面的xmlelement转义处理。 类似的，内容数据转义生成有效的XML内容， 除非它已经是xml类型的。

请注意，如果包含一个以上的元素，XML的森林不是有效的XML文档， 所以在xmlelement里面封装xmlforest表达式可能是有用的。

9.14.1.5. xmlpi

xmlpi(name target [, content])

xmlpi表达式创建一条XML处理指令。 如果存在，内容必须不能包含字符序列?>。

示例：

SELECT xmlpi(name php, 'echo "hello world";');

            xmlpi
-----------------------------
 <?php echo "hello world";?>

9.14.1.6. xmlroot

xmlroot(xml, version text | no value [, standalone yes|no|no value])

xmlroot更改XML值的根节点属性。如果指定一个版本， 它替换根节点的版本声明值;如果指定一个standalone设置，它替换根节点的standalone声明值。

SELECT xmlroot(xmlparse(document '<?xml version="1.1"?><content>abc</content>'),
               version '1.0', standalone yes);

                xmlroot
----------------------------------------
 <?xml version="1.0" standalone="yes"?>
 <content>abc</content>

9.14.1.7. xmlagg

xmlagg(xml)

不像这里描述的其它函数，函数xmlagg是一个聚集函数。 它连接聚集函数调用的输入值，很像xmlconcat， 除了连接发生在多行而不是发生在多个单行的表达式。 请参阅第 9.20 节获取关于聚集函数的更多信息。

示例：

CREATE TABLE test (y int, x xml);
INSERT INTO test VALUES (1, '<foo>abc</foo>');
INSERT INTO test VALUES (2, '<bar/>');
SELECT xmlagg(x) FROM test;
        xmlagg
----------------------
 <foo>abc</foo><bar/>

为了确定连接顺序，要添加一个ORDER BY子句到聚合调用， 描述在第 4.2.7 节。示例：

SELECT xmlagg(x ORDER BY y DESC) FROM test;
        xmlagg
----------------------
 <bar/><foo>abc</foo>

建议在之前的版本中使用下面非标准的方法，在特例中可能仍然有用:

SELECT xmlagg(x) FROM (SELECT * FROM test ORDER BY y DESC) AS tab;
        xmlagg
----------------------
 <bar/><foo>abc</foo>

9.14.2.1. IS DOCUMENT

xml IS DOCUMENT

如果参数XML值是一个合法的XML文档，表达式IS DOCUMENT返回真。 否则返回假（例如，内容片段）或如果参数为空则返回空。请参阅第 8.13 节 获取关于文档和内容片段之间的不同。

9.14.2.2. XMLEXISTS

XMLEXISTS(text PASSING [BY REF] xml [BY REF])

如果第一个参数中的XPath表达式返回任何节点，那么函数xmlexists返回真， 否则返回假。（如果其他参数是null，结果是null。）

示例：

SELECT xmlexists('//town[text() = ''Toronto'']' PASSING BY REF '<towns><town>Toronto</town><town>Ottawa</town></towns>');

 xmlexists
------------
 t
(1 row)

在PostgreSQL中，BY REF子句没有影响， 但是为了与SQL的一致性和其他实现的兼容性是允许的。SQL标准中， 第一个BY REF是必须的，第二个BY REF是可选的。 也请注意，SQL标准声明xmlexists构造接受XQuery表达式作为第一个参数， 但是PostgreSQL目前只接受XQuery的一个子集XPath。

9.14.2.3. xml_is_well_formed

xml_is_well_formed(text)
xml_is_well_formed_document(text)
xml_is_well_formed_content(text)

这些函数检查text字符串是不是格式良好的XML，返回布尔结果。 xml_is_well_formed_document检查格式良好的文档， xml_is_well_formed_content检查格式良好的内容。 xml_is_well_formed如果xmloption参数设置为 DOCUMENT则检查文档，如果设置为CONTENT则检查内容。 这意味着xml_is_well_formed有助于看到一个简单到类型xml 的转换是否会成功，而另外两个函数有助于看到相应的XMLPARSE变体是否会成功。

示例：

SET xmloption TO DOCUMENT;
SELECT xml_is_well_formed('<>');
 xml_is_well_formed 
--------------------
 f
(1 row)

SELECT xml_is_well_formed('<abc/>');
 xml_is_well_formed 
--------------------
 t
(1 row)

SET xmloption TO CONTENT;
SELECT xml_is_well_formed('abc');
 xml_is_well_formed 
--------------------
 t
(1 row)

SELECT xml_is_well_formed_document('<pg:foo xmlns:pg="https://postgresql.org/stuff">bar</pg:foo>');
 xml_is_well_formed_document 
-----------------------------
 t
(1 row)

SELECT xml_is_well_formed_document('<pg:foo xmlns:pg="https://postgresql.org/stuff">bar</my:foo>');
 xml_is_well_formed_document 
-----------------------------
 f
(1 row)

最后一个示例显示了检查包括命名空间是否正确匹配。