Ocultando elementos e atributos usando sql:hide

Quando uma consulta XPath é executada em um esquema XSD, o documento XML resultante tem elementos e atributos especificados no esquema. É possível especificar que alguns elementos e atributos permaneçam ocultos no esquema usando a anotação sql:hide. Isso é útil quando os critérios de seleção da consulta exigem a presença de elementos ou atributos específicos no esquema, mas você não deseja que eles retornem no documento XML gerado.

A anotação sql:hide usa um valor booleano (0 = falso, 1 = verdadeiro). Os valores aceitáveis são 0, 1, true e false.

Exemplos

Para criar exemplos de funcionamento usando os exemplos a seguir, é necessário atender a determinados requisitos. Para obter mais informações, consulte Requisitos para executar exemplos do SQLXML.

A. Especificando sql:hide em um atributo

O esquema XSD deste exemplo consiste em um elemento <Person.Contact> com atributos ContactID, FirstNamee LastName.

O elemento <Person.Contact> é do tipo complexo e, por isso, é mapeado para a tabela com o mesmo nome (mapeamento padrão). Todos os atributos do elemento <Person.Contact> são do tipo simples e mapeados para colunas com nomes iguais na tabela Person.Contactdo banco de dados AdventureWorks. No esquema, a anotação sql:hide é especificada no atributo ContactID. Quando uma consulta XPath é especificada nesse esquema, ContactID não é retornado no documento XML.

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

Para testar um exemplo de consulta XPath no esquema

1. Copie o código de esquema acima e cole-o em um arquivo de texto. Salve o arquivo como Hide.xml.

2. Copie o modelo a seguir e cole-o em um arquivo de texto. Salve o arquivo como HideT.xml no mesmo diretório onde você salvou Hide.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>
   

   O caminho de diretório especificado para o esquema de mapeamento (Hide.xml) é relativo ao diretório onde o modelo está salvo. Também é possível especificar um caminho absoluto, por exemplo:

   mapping-schema="C:\MyDir\Hide.xml"
   

3. Crie e use o Script de Teste SQLXML 4.0 (Sqlxml4test.vbs) para executar o modelo.

   Para obter mais informações, consulte Usando o ADO para executar consultas do SQLXML 4.0.

A seguir está o conjunto de resultados:

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

Quando sql:hide é especificado em um elemento, este e seus atributos ou elementos filho não são exibidos no documento XML gerado. Eis outro esquema XSD em que sql:hide é especificado no elemento <OD>:

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

Quando uma consulta XPath (por exemplo, /Customers[@CID="1"]) é especificada nesse esquema, o documento XML gerado não inclui o elemento <OD> e seus filhos, como mostrado neste resultado parcial:

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