PostgreSQL 中文参考文档
🌐 英文原版 官方 ↗

F.50. xml2 — XPath 查询与 XSLT 功能 #

F.50.1. 弃用通知
F.50.2. 函数描述
F.50.3. xpath_table
F.50.4. XSLT 函数
F.50.5. 作者

xml2 模块提供 XPath 查询与 XSLT 功能。

F.50.1. 弃用通知 #

从 PostgreSQL 8.3 开始,核心服务器中已经包含基于 SQL/XML 标准的 XML 相关功能。那些功能涵盖了 XML 语法检查与 XPath 查询(也就是本模块所做的事情),并且还支持更多功能,但其 API 完全不兼容。计划在未来的 PostgreSQL 版本中移除本模块,改用新的标准 API,因此建议你尝试转换你的应用。如果你发现本模块的某些功能在新 API 中无法以足够好的形式获得,请向 说明你的问题,以便解决该缺陷。

F.50.2. 函数描述 #

Table F.37 展示了该模块提供的函数。这些函数提供直接的 XML 解析与 XPath 查询。

Table F.37. xml2 函数

函数

描述

xml_valid ( document text ) → boolean

解析给定的文档,如果文档是格式良好的 XML 则返回真。(注意:这是标准 PostgreSQL 函数 xml_is_well_formed() 的别名。名称 xml_valid() 在技术上并不准确,因为有效性与格式良好性在 XML 中的含义并不相同。)

xpath_string ( document text, query text ) → text

在提供的文档上执行 XPath 查询,并将结果转换为 text。

xpath_number ( document text, query text ) → real

在提供的文档上执行 XPath 查询,并将结果转换为 real。

xpath_bool ( document text, query text ) → boolean

在提供的文档上执行 XPath 查询,并将结果转换为 boolean。

xpath_nodeset ( document text, query text, toptag text, itemtag text ) → text

在文档上执行查询并将结果包裹在 XML 标签中。如果结果是多值的,输出将形如:

<toptag>
<itemtag>Value 1 which could be an XML fragment</itemtag>
<itemtag>Value 2....</itemtag>
</toptag>

如果 toptag 或 itemtag 是空字符串,则省略相应的标签。

xpath_nodeset ( document text, query text, itemtag text ) → text

与 xpath_nodeset(document, query, toptag, itemtag) 类似,但结果省略 toptag。

xpath_nodeset ( document text, query text ) → text

与 xpath_nodeset(document, query, toptag, itemtag) 类似,但结果同时省略两个标签。

xpath_list ( document text, query text, separator text ) → text

在文档上执行查询并返回由指定分隔符分隔的多个值,例如当 separator 为 , 时返回 Value 1,Value 2,Value 3。

xpath_list ( document text, query text ) → text

这是上面函数的包装,使用 , 作为分隔符。


F.50.3. xpath_table #

xpath_table(text key, text document, text relation, text xpaths, text criteria) returns setof record

xpath_table 是一个表函数,它对一组文档中的每一个执行一组 XPath 查询,并将结果作为表返回。原文档表的主键字段作为结果的第一列返回,使结果集可以直接用于连接。参数见 Table F.38。

Table F.38. xpath_table 参数

参数描述
key

“键”字段的名称 — 它只是用作输出表第一列的字段,即标识每个输出行来自哪条记录(关于多个值的说明见下文)

document

包含 XML 文档的字段的名称

relation

包含这些文档的表或视图的名称

xpaths

一个或多个 XPath 表达式,以 | 分隔

criteria

WHERE 子句的内容。该参数不能省略,因此如果你想处理关系中的所有行,请使用 true 或 1=1


这些参数(XPath 字符串除外)只是被代入一个普通的 SQL SELECT 语句,因此有一定的灵活性 — 该语句是

SELECT <key>, <document> FROM <relation> WHERE <criteria>

所以这些参数可以是相应位置上任何合法的东西。这个 SELECT 的结果必须恰好返回两列(除非你试图为 key 或 document 列出多个字段,否则总会如此)。请注意,这种简单化的做法要求你校验任何用户提供的值,以避免 SQL 注入攻击。

该函数必须在 FROM 表达式中使用,并带有一个 AS 子句来指定输出列;例如

SELECT * FROM
xpath_table('article_id',
            'article_xml',
            'articles',
            '/article/author|/article/pages|/article/title',
            'date_entered > ''2003-01-01'' ')
AS t(article_id integer, author text, page_count integer, title text);

AS 子句定义输出表中列的名称与类型。第一列是“键”字段,其余各列与 XPath 查询一一对应。如果 XPath 查询多于结果列,多余的查询会被忽略;如果结果列多于 XPath 查询,多余的列将为 NULL。

注意,该示例将 page_count 结果列定义为整数。该函数内部处理的是字符串表示,因此当你声明想要整数输出时,它会获取 XPath 结果的字符串表示,并使用 PostgreSQL 的输入函数将其转换为整数(或 AS 子句请求的任何类型)。如果无法完成转换(例如结果为空),就会产生错误;因此如果你认为数据可能有问题,可以简单地坚持使用 text 作为列类型。

调用方的 SELECT 语句不一定要写成 SELECT * — 它可以按名称引用输出列,或将它们与其他表连接。该函数产生一个虚拟表,你可以对它执行任何操作(例如聚集、连接、排序等)。因此还可以这样写:

SELECT t.title, p.fullname, p.email
FROM xpath_table('article_id', 'article_xml', 'articles',
                 '/article/title|/article/author/@id',
                 'xpath_string(article_xml,''/article/@date'') > ''2003-03-20'' ')
       AS t(article_id integer, title text, author_id integer),
     tblPeopleInfo AS p
WHERE t.author_id = p.person_id;

这是一个更复杂的例子。当然,为了方便,你可以把所有这些包装在一个视图中。

F.50.3.1. 多值结果 #

xpath_table 函数假定每个 XPath 查询的结果可能是多值的,因此该函数返回的行数可能与输入文档数不同。返回的第一行包含每个查询的第一个结果,第二行包含每个查询的第二个结果。如果某个查询的值比其他查询少,则以空值填充。

在某些情况下,用户知道给定的 XPath 查询只会返回单个结果(也许是唯一的文档标识符)— 如果它与一个返回多个结果的 XPath 查询一起使用,单值结果只会出现在结果的第一行。解决办法是将键字段用于与更简单的 XPath 查询的连接。例如:

CREATE TABLE test (
    id int PRIMARY KEY,
    xml text
);

INSERT INTO test VALUES (1, '<doc num="C1">
<line num="L1"><a>1</a><b>2</b><c>3</c></line>
<line num="L2"><a>11</a><b>22</b><c>33</c></line>
</doc>');

INSERT INTO test VALUES (2, '<doc num="C2">
<line num="L1"><a>111</a><b>222</b><c>333</c></line>
<line num="L2"><a>111</a><b>222</b><c>333</c></line>
</doc>');

SELECT * FROM
  xpath_table('id','xml','test',
              '/doc/@num|/doc/line/@num|/doc/line/a|/doc/line/b|/doc/line/c',
              'true')
  AS t(id int, doc_num varchar(10), line_num varchar(10), val1 int, val2 int, val3 int)
WHERE id = 1 ORDER BY doc_num, line_num

 id | doc_num | line_num | val1 | val2 | val3
----+---------+----------+------+------+------
  1 | C1      | L1       |    1 |    2 |    3
  1 |         | L2       |   11 |   22 |   33

要让每一行都有 doc_num,解决办法是调用两次 xpath_table 并连接结果:

SELECT t.*,i.doc_num FROM
  xpath_table('id', 'xml', 'test',
              '/doc/line/@num|/doc/line/a|/doc/line/b|/doc/line/c',
              'true')
    AS t(id int, line_num varchar(10), val1 int, val2 int, val3 int),
  xpath_table('id', 'xml', 'test', '/doc/@num', 'true')
    AS i(id int, doc_num varchar(10))
WHERE i.id=t.id AND i.id=1
ORDER BY doc_num, line_num;

 id | line_num | val1 | val2 | val3 | doc_num
----+----------+------+------+------+---------
  1 | L1       |    1 |    2 |    3 | C1
  1 | L2       |   11 |   22 |   33 | C1
(2 rows)

F.50.4. XSLT 函数 #

如果安装了 libxslt,则可以使用以下函数:

F.50.4.1. xslt_process #

xslt_process(text document, text stylesheet, text paramlist) returns text

该函数将 XSL 样式表应用于文档并返回转换结果。paramlist 是转换中要使用的参数赋值列表,形如 a=1,b=2。注意,参数解析非常简单:参数值不能包含逗号!

xslt_process 还有一个双参数版本,不向转换传递任何参数。

F.50.5. 作者 #

John Gray

本模块的开发由 Torchbox Ltd. (www.torchbox.com) 赞助。它与 PostgreSQL 一样采用 BSD 许可证。