将 EXPLICIT 模式与 FOR XML 配合使用

  • 项目

适用于：SQL ServerAzure SQL 数据库Azure SQL 托管实例

如使用 FOR XML 构造 XML 一文所述，使用 RAW 和 AUTO 模式不能很好地控制从查询结果生成的 XML 的形状。 但是，对于要从查询结果生成 XML，EXPLICIT 模式会提供非常好的灵活性。

必须以特定的方式编写 EXPLICIT 模式查询，以便将有关所需的 XML 的附加信息（如 XML 中的所需嵌套）显式指定为查询的一部分。 根据所请求的 XML，编写 EXPLICIT 模式查询可能会很烦琐。 您会发现 使用 PATH 模式 （具有嵌套）相对编写 EXPLICIT 模式查询而言更加简单。

因为将所需的 XML 描述为 EXPLICIT 模式查询的一部分，所以必须确保生成的 XML 格式正确且有效。

EXPLICIT 模式下的行集处理

EXPLICIT 模式会将由查询执行生成的行集转换为 XML 文档。 为使 EXPLICIT 模式生成 XML 文档，行集必须具有特定的格式。 这需要您编写 SELECT 查询以生成具有特定格式的行集（通用表 ），以便处理逻辑随后可以生成所需的 XML。

首先，查询必须生成下列两个元数据列：

  • 第一列必须提供当前元素的标记号（整数类型），并且列名必须是 Tag。 查询必须为从行集构造的每个元素提供唯一标记号。

  • 第二列必须提供父元素的标记号，并且此列的列名必须是 Parent。 这样，Tag 和 Parent 列将提供层次结构信息。

这些元数据列值与列名中的信息一起都用于生成所需的 XML。 查询必须以特定的方式提供列名。 同时请注意， Parent 列中的 0 或 NULL 表明相应的元素没有父级。 该元素将作为顶级元素添加到 XML。

为了了解如何将查询生成的通用表处理为生成 XML 结果，假定您已经编写了一个生成此通用表的查询：

Sample universal table.

注意有关此通用表的以下事项：

  • 前两列是 Tag 和 Parent ，它们是元数据列。 这些值确定层次结构。

  • 列名是以特定的方式指定的，本文后面部分将进行介绍。

  • 从此通用表生成 XML 的过程中，此表中的数据被垂直分区到列组中。 分组是根据 Tag 值和列名确定的。 在构造 XML 的过程中，处理逻辑为每行选择一组列，然后构造一个元素。 在此示例中，将应用以下规则：

    • 对于第一行中的 Tag 列值 1，名称中包括此相同标记号的列（ Customer!1!cid 和 Customer!1!name）形成一组。 这些列用于处理行，您可能已经注意到所生成元素的形式为 <Customer id=... name=...>。 列名格式在本文后面部分进行介绍。

    • 对于 Tag 列值为 2 的行，列 Order!2!id 和 Order!2!date 形成一组，然后该组用于构造元素 <Order id=... date=... />。

    • 对于 Tag 列值为 3 的行，列 OrderDetail!3!id!id 和 OrderDetail!3!pid!idref 形成一组。 其中每一行都从这些列生成元素 <OrderDetail id=... pid=...>。

  • 在生成 XML 层次结构的过程中，按顺序处理行。 XML 层次结构确定如下：

    • 第一行指定 Tag 值为 1， Parent 值为 NULL。 因此，相应的元素（即 <Customer> 元素）将作为顶级元素添加在 XML 中。

      <Customer cid="C1" name="Janine">

    • 第二行指定 Tag 值为 2， Parent 值为 1。 因此，将添加 <Order> 元素作为 <Customer> 元素的子元素。

      <Customer cid="C1" name="Janine">
   <Order id="O1" date="1/20/1996">

    • 接下来的两行指定 Tag 值为 3， Parent 值为 2。 因此，将添加两个 <OrderDetail> 元素作为 <Order> 元素的子元素。

      <Customer cid="C1" name="Janine">
   <Order id="O1" date="1/20/1996">
      <OrderDetail id="OD1" pid="P1"/>
      <OrderDetail id="OD2" pid="P2"/>

    • 最后一行确定 Tag 号为 2， Parent 标记号为 1。 因此，另一个 <Order> 元素将添加到 <Customer> 父元素。

      <Customer cid="C1" name="Janine">
   <Order id="O1" date="1/20/1996">
      <OrderDetail id="OD1" pid="P1"/>
      <OrderDetail id="OD2" pid="P2"/>
   </Order>
   <Order id="O2" date="3/29/1997">
</Customer>

简言之，使用 EXPLICIT 模式时， Tag 和 Parent 元数据列中的值、列名中提供的信息以及正确的行顺序将生成所需的 XML。

通用表行排序

在构造 XML 过程中，通用表中的行是按顺序处理的。 因此，若要检索到与其父级关联的正确的子级实例，必须对行集中的行进行排序，以便每个父节点后紧跟着其子节点。

指定通用表中的列名

在编写 EXPLICIT 模式查询时，必须使用以下格式指定所得到的行集中的列名。 它们提供转换信息（包括元素名称和属性名称）以及用指令指定的其他附加信息。

常用格式如下：

ElementName!TagNumber!AttributeName!Directive

下面是对格式各部分的说明。

  • ElementName

    所生成元素的通用标识符。 例如，如果将 Customers 指定为 ElementName，将生成 <Customers> 元素。

  • TagNumber

    分配给元素的唯一标记值。 在两个元数据列（ Tag 和 Parent）的帮助下，此值将确定所得到的 XML 中的元素的嵌套。

  • AttributeName

    提供要在指定的 ElementName中构造的属性的名称。 如果没有指定 Directive ，将发生这种行为。

    如果指定了 Directive 并且它是 xml、 cdata或 element，则此值用于构造 ElementName的子元素，并且此列值将添加到该子元素。

    如果指定了 Directive，则 AttributeName 可以为空。 例如 ElementName!TagNumber!!Directive。 在这种情况下，列值直接由 ElementName包含。

  • Directive

    Directive 是可选的，可以使用它来提供有关 XML 构造的其他信息。 Directive 有两种用途。

    • 一种用途是将值编码为 ID、IDREF 和 IDREFS。 可以将 ID、 IDREF和 IDREFS 关键字指定为 Directives。 这些指令将覆盖属性类型。 这使您能够创建文档内链接。

    • 同时，可以使用 Directive 来指示如何将字符串数据映射到 XML。 可以将 hide、 element、elementxsinil、 xml、 xmltext和 cdata 关键字用作 Directive。 hide 指令会隐藏节点。 如果仅出于排序目的检索值，但不希望在生成的 XML 中使用这些值，此指令非常有用。

    element 指令生成的结果中包含元素而不是属性。 包含的数据被编码为实体。 例如， < 字符变成 <。 对于 NULL 列值，不会生成任何元素。 如果要为 NULL 列值生成元素，可以指定 elementxsinil 指令。 这将生成具有属性 xsi:nil=TRUE 的元素。

    除不发生实体编码外， xml 指令与 element 指令相同。 可以将 element 指令与 ID、IDREF 或 IDREFS 结合使用，然而不允许 xml 指令与除 hide 指令之外的任何其他指令结合使用。

    cdata 指令通过将数据与 CDATA 部分包装在一起来包含数据。 不对内容进行实体编码。 原始数据类型必须是文本类型（如 varchar、 nvarchar、 text或 ntext）。 此指令只适用于 hide。 当使用此指令时，不能指定 AttributeName。

    大多数情况下，允许在这两个组之间组合指令，但不允许在它们自身当中组合指令。

如果未指定 Directive 和 AttributeName（例如 Customer!1），则暗含一个 element 指令（如 Customer!1!!element），并且列数据包含在 ElementName 中。

如果指定了 xmltext 指令，则列内容包装在与文档的其余部分集成在一起的单个标记中。 在提取由 OPENXML 存储在列中的溢出（未用完的）XML 数据时，此指令很有用。 有关详细信息，请参阅 OPENXML (SQL Server)。

如果指定了 AttributeName ，将由指定的名称替换标记名。 否则，将通过把内容置于包容的起始位置（不经过实体编码）将属性追加到闭合元素属性的当前列表中。 包含此指令的列必须是文本类型（如 varchar、 nvarchar、 char、 nchar、 text或 ntext）。 此指令只适用于 hide。 在提取列中存储的溢出数据时，此指令很有用。 如果内容的 XML 格式不正确，则未定义该行为。

后续步骤

下列示例说明了 EXPLICIT 模式的用法。

另请参阅