Redrock Postgres 搜索 英文
版本: 9.3 / 9.4 / 9.5 / 9.6 / 10 / 11 / 12 / 13 / 14 / 15 / 16 / 17

F.48. xml2 — XPath 查询和 XSLT 功能 #

F.48.1. 弃用通告
F.48.2. 函数描述
F.48.3. xpath_table
F.48.4. XSLT 函数
F.48.5. 作者

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

F.48.1. 弃用通知 #

PostgreSQL 8.3 开始,核心服务器中基于 SQL/XML 标准的 XML 相关功能。该功能涵盖 XML 语法检查和 XPath 查询,即该模块的作用,但 API 完全不兼容。计划在未来版本的 PostgreSQL 中删除该模块,取而代之的是更新的标准 API,因此您需要尝试将应用程序进行转换。如果您发现该模块的某些功能不能通过较新的 API 以足够的形式提供,请向 说明您的问题,以便解决该缺陷。

F.48.2. 函数说明 #

表 F.35 显示了该模块提供的函数。这些函数提供直接的 XML 解析和 XPath 查询。

表 F.35. xml2 函数

函数

说明

xml_valid ( document text ) → boolean

解析给定的文档,如果文档是格式良好的 XML,则返回 true。(注:这是标准 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>

如果 toptagitemtag 为空字符串,则会省略相关的标签。

xpath_nodeset ( document 文本, query 文本, itemtag 文本 ) → 文本

类似于 xpath_nodeset(document, query, toptag, itemtag),但结果中会省略 toptag

xpath_nodeset ( document 文本, query 文本 ) → 文本

类似于 xpath_nodeset(document, query, toptag, itemtag),但结果中会省略两个标签。

xpath_list ( document 文本, query 文本, separator 文本 ) → 文本

验证文档中的查询并返回使用指定分隔符分隔的多个值,例如,如果 separator,,则返回 值 1、值 2、值 3

xpath_list ( document 文本, query 文本 ) → 文本

这是将 , 用作分隔符以上述函数作为包装的函数。


F.48.3. xpath_table #

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

xpath_table 是表函数,它对一组文档中的每一组 XPath 查询进行验证,并以表的格式返回这些结果。原始文档表中的主键字段作为结果的第一列返回,以便可随时在联接中使用该结果集。参数在 表 F.36 中进行了说明。

表 F.36. xpath_table 参数

参数 说明
key

key 字段的名称 — 即用作输出表第一列的字段,也就是说,它标识了来自每个输出行的记录(请参阅下列有关多值的注释)

document

包含 XML 文档的字段的名称

relation

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

xpaths

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

criteria

WHERE 子句的内容。该项不能为空,因此如果您想处理关系中的所有行,请使用 true1=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 子句定义输出表中列的名称和类型。第一列为 key 字段,其余列与 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.48.3.1. 多值结果 #

xpath_table 函数认为每个 XPath 查询的结果可能是多值的,因此该函数返回的行数可能与输入文档数不同。返回的第一行包含每个查询的第一个结果,第二行包含每个查询的第二个结果。如果其中一个查询的值比其他查询少,则将返回 null 值。

在某些情况下,用户知道给定的 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.48.4。XSLT 函数 #

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

F.48.4.1。xslt_process #

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

此函数向文档应用 XSL 样式表并返回转换后的结果。paramlist 是在转换中要使用的参数分配的列表,指定为 a=1,b=2 形式。请注意,参数解析非常简单:参数值不能包含逗号!

还有 xslt_process 的两参数版本,该版本不会将任何参数传递给转换。

F.48.5。作者 #

John Gray <>

此模块的开发受 Torchbox Ltd. (www.torchbox.com) 赞助。它拥有与 PostgreSQL 相同的 BSD 许可证。