使用 sql:hide 隐藏元素和属性

针对 XSD 架构执行 XPath 查询时,生成的 XML 文档具有在架构中指定的元素和属性。可以使用 sql:hide 批注来指定隐藏架构中的某些元素和属性。当查询的选择条件需要架构中的特定元素或属性,但是不希望在生成的 XML 文档中返回这些元素或属性时,该批注很有用。

sql:hide 批注采用布尔值(0 = FALSE,1 = TRUE)。可接受的值为 0、1、true 和 false。

示例

若要创建使用以下示例的工作示例,必须满足一些要求。有关详细信息,请参阅运行 SQLXML 示例的要求

A. 对属性指定 sql:hide

本例中的 XSD 架构由具有 ContactIDFirstNameLastName 属性的 <Person.Contact> 元素构成。

<Person.Contact> 元素属于复杂类型,因而将映射到具有相同名称的表(默认映射)。<Person.Contact> 元素的所有属性均属于简单类型,映射到 AdventureWorks 数据库的 Person.Contact 表中具有相同名称的列。在此架构中,对 ContactID 属性指定 sql:hide 批注。在针对此架构指定 XPath 查询时,XML 文档中将不会返回 ContactID

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" 
            xmlns:sql="urn:schemas-microsoft-com:mapping-schema">
  <xsd:element name="Person.Contact" >
     <xsd:complexType>
       <xsd:attribute name="ContactID"  sql:hide="true" /> 
       <xsd:attribute name="FirstName"   type="xsd:string" /> 
       <xsd:attribute name="LastName"    type="xsd:string" /> 
     </xsd:complexType>
  </xsd:element>
</xsd:schema>

针对该架构测试示例 XPath 查询

  1. 复制上面的架构代码,并将它粘贴到文本文件中。将文件另存为 Hide.xml。

  2. 复制以下模板,并将它粘贴到文本文件中。在保存 Hide.xml 的相同目录中将该文件另存为 HideT.xml。

    <ROOT xmlns:sql="urn:schemas-microsoft-com:xml-sql">
        <sql:xpath-query mapping-schema="Hide.xml">
            /Person.Contact[@ContactID="1"]
        </sql:xpath-query>
    </ROOT>
    

    为映射架构 (Hide.xml) 指定的目录路径是保存模板目录的相对路径。也可以指定绝对路径,例如:

    mapping-schema="C:\MyDir\Hide.xml"
    
  3. 创建并使用 SQLXML 4.0 测试脚本 (Sqlxml4test.vbs) 执行该模板。

    有关详细信息,请参阅使用 ADO 执行 SQLXML 4.0 查询

下面是结果集:

 <ROOT xmlns:sql="urn:schemas-microsoft-com:xml-sql">
    <Person.Contact FirstName="Gustavo" LastName="Achong" /> 
 </ROOT>

如果对元素指定 sql:hide,则该元素及其属性或子元素都不会出现在生成的 XML 文档中。以下是另一个 XSD 架构,在此架构中对 <OD> 元素指定了 sql:hide:

<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
            xmlns:dt="urn:schemas-microsoft-com:datatypes"
            xmlns:sql="urn:schemas-microsoft-com:mapping-schema">

  <xsd:annotation>
    <xsd:documentation>
      Sales.Customer-Sales.SalesOrderHeader-Sales.SalesOrderDetail Schema
      Copyright 2004 Microsoft. All rights reserved.
    </xsd:documentation>
    <xsd:appinfo>
      <sql:relationship name="CustomerOrder"
         parent="Sales.Customer"
                  parent-key="CustomerID"
                  child-key="CustomerID"
                  child="Sales.SalesOrderHeader" />
       <sql:relationship name="OrderOrderDetails"
                  parent="Sales.SalesOrderHeader"
                  parent-key="SalesOrderID"
                  child-key="SalesOrderID"
                  child="Sales.SalesOrderDetail"/>
    </xsd:appinfo>
  </xsd:annotation>

  <xsd:element name="Customers" sql:relation="Sales.Customer">
    <xsd:complexType>
      <xsd:sequence>
        <xsd:element name="Order" sql:relation="Sales.SalesOrderHeader" 
                     maxOccurs="unbounded" 
                     sql:relationship="CustomerOrder">
          <xsd:complexType>
            <xsd:sequence>
               <xsd:element name="OD" sql:relation="Sales.SalesOrderDetail"                                       maxOccurs="unbounded"                                       sql:relationship="OrderOrderDetails"                                       sql:hide="1">
                  <xsd:complexType>
                    <xsd:attribute name="SalesOrderID" type="xsd:string"/>
                    <xsd:attribute name="ProductID" type="xsd:string"/>
                  </xsd:complexType>
               </xsd:element>
            </xsd:sequence>
          <xsd:attribute name="CustomerID" type="xsd:string"/>
          <xsd:attribute name="OID" sql:field="SalesOrderID" 
                                    type="xsd:string"/>
          <xsd:attribute name="OrderDate" type="xsd:date"/> 
        </xsd:complexType>
      </xsd:element>
    </xsd:sequence>
    <xsd:attribute name="CID" sql:field="CustomerID" 
                                type="xsd:string"/>
    </xsd:complexType>
  </xsd:element>
</xsd:schema>

针对此架构执行 XPath 查询(如 /Customers[@CID="1"])时,生成的 XML 文档不包含 <OD> 元素及其子元素,如以下部分结果所示:

<ROOT xmlns:sql="urn:schemas-microsoft-com:xml-sql">
  <Customers CID="1">
    <Order CustomerID="1" OID="43860" OrderDate="2001-08-01" /> 
    <Order CustomerID="1" OID="44501" OrderDate="2001-11-01" /> 
    <Order CustomerID="1" OID="45283" OrderDate="2002-02-01" /> 
    <Order CustomerID="1" OID="46042" OrderDate="2002-05-01" /> 
  </Customers>
</ROOT>