xmltext ( text ) → xml

函数 xmltext 返回一个 XML 值，该值具有一个包含输入参数作为其内容的单个文本节点。预定义的实体（如与号 (&)）、左右尖括号 (< >) 和引号 ("")）会被转义。

示例

SELECT xmltext('< foo & bar >');
         xmltext
-------------------------
 &lt; foo &amp; bar &gt;

xmlcomment ( text ) → xml

函数 xmlcomment 创建一个 XML 值，其中包含一个 XML 注释，该注释以指定的文本作为内容。文本不能包含 “--” 或以 “-” 结尾，否则生成的结构将不是有效的 XML 注释。如果参数为 null，则结果为 null。

示例

SELECT xmlcomment('hello');

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

xmlconcat ( xml [, ...] ) → xml

函数 xmlconcat 连接一系列单独的 XML 值，以创建一个包含 XML 内容片段的单个值。Null 值被省略；只有当没有非 null 参数时，结果才为 null。

示例

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/>

xmlelement ( NAME name [, XMLATTRIBUTES ( attvalue [ AS attname ] [, ...] ) ] [, content [, ...]] ) → xml

xmlelement 表达式生成一个 XML 元素，其中包含给定的名称、属性和内容。语法中显示的 name 和 attname 项是简单标识符，而不是值。attvalue 和 content 项是表达式，可以生成任何 PostgreSQL 数据类型。XMLATTRIBUTES 中的参数生成 XML 元素的属性；content 值被连接起来形成其内容。

示例

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 是字符的 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 或十六进制编码表示，具体取决于配置参数 xmlbinary 的设置。为了使 PostgreSQL 映射与 SQL:2006 及更高版本中指定的映射保持一致，预计单个数据类型的特定行为将会发展，如第 D.3.1.3 节中所述。

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

xmlforest 表达式使用给定的名称和内容生成元素的 XML 森林（序列）。与 xmlelement 一样，每个 name 都必须是简单的标识符，而 content 表达式可以具有任何数据类型。

示例

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 文档，因此将 xmlforest 表达式包装在 xmlelement 中可能很有用。

xmlpi ( NAME name [, content ] ) → xml

xmlpi 表达式创建 XML 处理指令。与 xmlelement 一样，name 必须是简单的标识符，而 content 表达式可以具有任何数据类型。如果存在 content，则它不能包含字符序列 ?>。

示例

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

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

xmlroot ( xml, VERSION {text|NO VALUE} [, STANDALONE {YES|NO|NO VALUE} ] ) → xml

xmlroot 表达式会更改 XML 值根节点的属性。如果指定了版本，它将替换根节点版本声明中的值；如果指定了独立设置，它将替换根节点独立声明中的值。

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>

xmlagg ( xml ) → xml

函数 xmlagg 与此处描述的其他函数不同，它是一个聚合函数。它将输入值连接到聚合函数调用，类似于 xmlconcat 的工作方式，只是连接发生在行之间，而不是在单行中的表达式之间。有关聚合函数的更多信息，请参阅第 9.21 节。

示例

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>

xml IS DOCUMENT → boolean

如果参数 XML 值是正确的 XML 文档，则表达式 IS DOCUMENT 返回 true；如果不是（即，它是内容片段），则返回 false；如果参数为 null，则返回 null。有关文档和内容片段之间的差异，请参阅 第 8.13 节。

xml IS NOT DOCUMENT → boolean

如果参数 XML 值是正确的 XML 文档，表达式 IS NOT DOCUMENT 返回 false；如果不是（即，它是内容片段），则返回 true；如果参数为 null，则返回 null。

XMLEXISTS ( text PASSING [BY {REF|VALUE}] xml [BY {REF|VALUE}] ) → boolean

函数 xmlexists 使用传入的 XML 值作为其上下文项，评估 XPath 1.0 表达式（第一个参数）。如果该评估的结果产生一个空的节点集，则该函数返回 false；如果产生任何其他值，则返回 true。如果任何参数为 null，则函数返回 null。作为上下文项传递的非空值必须是 XML 文档，而不是内容片段或任何非 XML 值。

示例

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

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

在 PostgreSQL 中接受 BY REF 和 BY VALUE 子句，但会忽略它们，如 第 D.3.2 节中所讨论的那样。

在 SQL 标准中，xmlexists 函数使用 XML 查询语言评估表达式，但如 第 D.3.1 节中所讨论的那样，PostgreSQL 仅允许 XPath 1.0 表达式。

xml_is_well_formed ( text ) → boolean
xml_is_well_formed_document ( text ) → boolean
xml_is_well_formed_content ( text ) → boolean

这些函数检查 text 字符串是否表示格式良好的 XML，并返回布尔结果。xml_is_well_formed_document 检查是否为格式良好的文档，而 xml_is_well_formed_content 检查是否为格式良好的内容。如果 xmloption 配置参数设置为 DOCUMENT，则 xml_is_well_formed 执行前者；如果设置为 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://postgres.ac.cn/stuff">bar</pg:foo>');
 xml_is_well_formed_document
-----------------------------
 t
(1 row)

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

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

xpath ( xpath text, xml xml [, nsarray text[] ] ) → xml[]

函数 xpath 针对 XML 值 xml 评估 XPath 1.0 表达式 xpath（以文本形式给出）。它返回一个 XML 值数组，该数组对应于 XPath 表达式产生的节点集。如果 XPath 表达式返回标量值而不是节点集，则返回单元素数组。

第二个参数必须是格式良好的 XML 文档。特别地，它必须具有单个根节点元素。

该函数的可选第三个参数是命名空间映射数组。该数组应为二维 text 数组，第二个轴的长度等于 2（即，它应为数组的数组，每个数组恰好由 2 个元素组成）。每个数组条目的第一个元素是命名空间名称（别名），第二个元素是命名空间 URI。此数组中提供的别名不必与 XML 文档本身中使用的别名相同（换句话说，在 XML 文档和 xpath 函数上下文中，别名都是本地的）。

示例

SELECT xpath('/my:a/text()', '<my:a xmlns:my="http://example.com">test</my:a>',
             ARRAY[ARRAY['my', 'http://example.com']]);

 xpath
--------
 {test}
(1 row)

要处理默认（匿名）命名空间，请执行以下操作

SELECT xpath('//mydefns:b/text()', '<a xmlns="http://example.com"><b>test</b></a>',
             ARRAY[ARRAY['mydefns', 'http://example.com']]);

 xpath
--------
 {test}
(1 row)

xpath_exists ( xpath text, xml xml [, nsarray text[] ] ) → boolean

函数 xpath_exists 是 xpath 函数的专门形式。此函数不返回满足 XPath 1.0 表达式的单个 XML 值，而是返回一个布尔值，指示查询是否被满足（具体而言，它是否产生除空节点集之外的任何值）。此函数等效于 XMLEXISTS 谓词，但它还为命名空间映射参数提供支持。

示例

SELECT xpath_exists('/my:a/text()', '<my:a xmlns:my="http://example.com">test</my:a>',
                     ARRAY[ARRAY['my', 'http://example.com']]);

 xpath_exists
--------------
 t
(1 row)

XMLTABLE (
    [ XMLNAMESPACES ( namespace_uri AS namespace_name [, ...] ), ]
    row_expression PASSING [BY {REF|VALUE}] document_expression [BY {REF|VALUE}]
    COLUMNS name { type [PATH column_expression] [DEFAULT default_expression] [NOT NULL | NULL]
                  | FOR ORDINALITY }
            [, ...]
) → setof record

xmltable 表达式基于 XML 值、用于提取行的 XPath 筛选器以及一组列定义来生成表。尽管它在语法上类似于函数，但它只能作为查询的 FROM 子句中的表出现。

可选的 XMLNAMESPACES 子句给出一个以逗号分隔的命名空间定义列表，其中每个 namespace_uri 都是一个 text 表达式，每个 namespace_name 都是一个简单的标识符。它指定文档中使用的 XML 命名空间及其别名。当前不支持默认命名空间规范。

必需的 row_expression 参数是一个 XPath 1.0 表达式（以 text 形式给出），该表达式将被评估，并传递 XML 值 document_expression 作为其上下文项，以获取一组 XML 节点。这些节点是 xmltable 转换为输出行的内容。如果 document_expression 为 null，或者如果 row_expression 产生一个空的节点集或除节点集之外的任何值，则不会生成任何行。

document_expression 为 row_expression 提供上下文项。它必须是格式良好的 XML 文档；不接受片段/森林。BY REF 和 BY VALUE 子句被接受但会被忽略，如 第 D.3.2 节中所讨论的那样。

在 SQL 标准中，xmltable 函数使用 XML 查询语言评估表达式，但如 第 D.3.1 节中所讨论的那样，PostgreSQL 仅允许 XPath 1.0 表达式。

必需的 COLUMNS 子句指定输出表中将生成的列。有关格式，请参见上面的语法摘要。每个列都需要名称以及数据类型（除非指定 FOR ORDINALITY，在这种情况下，类型 integer 是隐式的）。路径、默认值和可空性子句是可选的。

标记为 FOR ORDINALITY 的列将使用行号填充，从 1 开始，顺序是从 row_expression 的结果节点集中检索节点的顺序。最多只能有一个列标记为 FOR ORDINALITY。

列的 column_expression 是一个 XPath 1.0 表达式，该表达式针对每一行进行评估，并将来自 row_expression 结果的当前节点作为其上下文项，以查找列的值。如果没有给出 column_expression，则将列名称用作隐式路径。

如果列的 XPath 表达式返回非 XML 值（在 XPath 1.0 中仅限于字符串、布尔值或双精度值），并且该列具有除 xml 之外的 PostgreSQL 类型，则该列将被设置为好像将该值的字符串表示形式分配给 PostgreSQL 类型。（如果该值为布尔值，则如果输出列的类型类别为数值，则其字符串表示形式被视为 1 或 0，否则为 true 或 false。）

如果列的 XPath 表达式返回非空的 XML 节点集，并且该列的 PostgreSQL 类型为 xml，则如果其为文档或内容形式，则将精确分配该列的表达式结果。^[8]

分配给 xml 输出列的非 XML 结果会生成内容，即带有结果字符串值的单个文本节点。分配给任何其他类型的列的 XML 结果可能没有多个节点，否则会引发错误。如果只有一个节点，则该列将被设置为好像将节点的字符串值（如为 XPath 1.0 string 函数定义的那样）分配给 PostgreSQL 类型。

XML 元素的字符串值是该元素及其后代中包含的所有文本节点按照文档顺序的串联。没有后代文本节点的元素的字符串值为空字符串（不是 NULL）。将忽略任何 xsi:nil 属性。请注意，两个非文本元素之间的仅包含空格的 text() 节点将被保留，并且 text() 节点上的前导空格不会被展平。可以参考 XPath 1.0 string 函数，以了解定义其他 XML 节点类型和非 XML 值的字符串值的规则。

此处介绍的转换规则与 SQL 标准的规则并不完全相同，如 第 D.3.1.3 节中所讨论的那样。

如果路径表达式对于给定行返回一个空的节点集（通常在不匹配时），则该列将被设置为 NULL，除非指定了 default_expression；然后，将使用评估该表达式产生的值。

default_expression 不是在调用 xmltable 时立即评估，而是在每次需要该列的默认值时进行评估。如果该表达式符合稳定或不可变的条件，则可以跳过重复评估。这意味着你可以在 default_expression 中有效地使用 nextval 等易失性函数。

列可以标记为 NOT NULL。如果 NOT NULL 列的 column_expression 不匹配任何内容，并且没有 DEFAULT 或 default_expression 也评估为 null，则会报告错误。

示例

CREATE TABLE xmldata AS SELECT
xml $$
<ROWS>
  <ROW id="1">
    <COUNTRY_ID>AU</COUNTRY_ID>
    <COUNTRY_NAME>Australia</COUNTRY_NAME>
  </ROW>
  <ROW id="5">
    <COUNTRY_ID>JP</COUNTRY_ID>
    <COUNTRY_NAME>Japan</COUNTRY_NAME>
    <PREMIER_NAME>Shinzo Abe</PREMIER_NAME>
    <SIZE unit="sq_mi">145935</SIZE>
  </ROW>
  <ROW id="6">
    <COUNTRY_ID>SG</COUNTRY_ID>
    <COUNTRY_NAME>Singapore</COUNTRY_NAME>
    <SIZE unit="sq_km">697</SIZE>
  </ROW>
</ROWS>
$$ AS data;

SELECT xmltable.*
  FROM xmldata,
       XMLTABLE('//ROWS/ROW'
                PASSING data
                COLUMNS id int PATH '@id',
                        ordinality FOR ORDINALITY,
                        "COUNTRY_NAME" text,
                        country_id text PATH 'COUNTRY_ID',
                        size_sq_km float PATH 'SIZE[@unit = "sq_km"]',
                        size_other text PATH
                             'concat(SIZE[@unit!="sq_km"], " ", SIZE[@unit!="sq_km"]/@unit)',
                        premier_name text PATH 'PREMIER_NAME' DEFAULT 'not specified');

 id | ordinality | COUNTRY_NAME | country_id | size_sq_km |  size_other  | premier_name
----+------------+--------------+------------+------------+--------------+---------------
  1 |          1 | Australia    | AU         |            |              | not specified
  5 |          2 | Japan        | JP         |            | 145935 sq_mi | Shinzo Abe
  6 |          3 | Singapore    | SG         |        697 |              | not specified

以下示例显示了多个 text() 节点的串联，将列名用作 XPath 筛选器，以及对空格、XML 注释和处理指令的处理

CREATE TABLE xmlelements AS SELECT
xml $$
  <root>
   <element>  Hello<!-- xyxxz -->2a2<?aaaaa?> <!--x-->  bbb<x>xxx</x>CC  </element>
  </root>
$$ AS data;

SELECT xmltable.*
  FROM xmlelements, XMLTABLE('/root' PASSING data COLUMNS element text);
         element
-------------------------
   Hello2a2   bbbxxxCC

以下示例说明了如何使用 XMLNAMESPACES 子句来指定 XML 文档以及 XPath 表达式中使用的一系列命名空间。

WITH xmldata(data) AS (VALUES ('
<example xmlns="http://example.com/myns" xmlns:B="http://example.com/b">
 <item foo="1" B:bar="2"/>
 <item foo="3" B:bar="4"/>
 <item foo="4" B:bar="5"/>
</example>'::xml)
)
SELECT xmltable.*
  FROM XMLTABLE(XMLNAMESPACES('http://example.com/myns' AS x,
                              'http://example.com/b' AS "B"),
             '/x:example/x:item'
                PASSING (SELECT data FROM xmldata)
                COLUMNS foo int PATH '@foo',
                  bar int PATH '@B:bar');
 foo | bar
-----+-----
   1 |   2
   3 |   4
   4 |   5
(3 rows)