sql:hide による要素と属性の非表示
XSD スキーマに対して XPath クエリを実行すると、結果の XML ドキュメントにはスキーマで指定された要素と属性が含められます。sql:hide 注釈を使用すると、スキーマでいくつかの要素と属性を非表示にするよう指定できます。この機能は、クエリの選択条件としてはスキーマ内の特定の要素または属性が必要でも、生成される XML ドキュメントではこれらを返したくない場合に便利です。
sql:hide 注釈はブール値 (0 = false、1=true) をとります。指定できる値は 0、1、true、false です。
例
次の例を使用した実際のサンプルを作成するには、特定の条件を満たす必要があります。詳細については、「SQLXML のサンプル実行のための必要条件」を参照してください。
A. 属性に sql:hide を指定する
この例の XSD スキーマは、BusinessEntityID、FirstName、LastName 属性が指定された <Person.Person> 要素で構成されています。
<Person.Person> 要素は複合型であり、同じ名前のテーブルにマップされます (既定のマッピング)。<Person.Person> 要素のすべての属性は単純型であり、AdventureWorks2008R2 データベースの Person.Person テーブル内の同じ名前の列にマップされます。スキーマでは、BusinessEntityID 属性に sql:hide 注釈が指定されています。このスキーマに対して XPath クエリを指定した場合、XML ドキュメント内に BusinessEntityID は返されません。
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:sql="urn:schemas-microsoft-com:mapping-schema">
<xsd:element name="Person.Person" >
<xsd:complexType>
<xsd:attribute name="BusinessEntityID" sql:hide="true" />
<xsd:attribute name="FirstName" type="xsd:string" />
<xsd:attribute name="LastName" type="xsd:string" />
</xsd:complexType>
</xsd:element>
</xsd:schema>
スキーマに対してサンプル XPath クエリをテストするには
上のスキーマのコードをコピーして、テキスト ファイルに貼り付け、Hide.xml として保存します。
次のテンプレートをコピーして、テキスト ファイルに貼り付け、Hide.xml を保存したディレクトリに HideT.xml として保存します。
<ROOT xmlns:sql="urn:schemas-microsoft-com:xml-sql"> <sql:xpath-query mapping-schema="Hide.xml"> /Person.Person[@BusinessEntityID="1"] </sql:xpath-query> </ROOT>
マッピング スキーマ (Hide.xml) に指定するディレクトリ パスは、テンプレートを保存するディレクトリに対する相対パスです。次のように、絶対パスを指定することもできます。
mapping-schema="C:\MyDir\Hide.xml"
SQLXML 4.0 テスト スクリプト (sqlxml4test.vbs) を作成し、それを使用してテンプレートを実行します。
詳細については、「ADO を使用した、SQLXML 4.0 クエリの実行」を参照してください。
次に結果セットを示します。
<ROOT xmlns:sql="urn:schemas-microsoft-com:xml-sql">
<Person.Person FirstName="Gustavo" LastName="Achong" />
</ROOT>
要素に sql:hide を指定した場合、その要素とその属性または子要素は、生成される XML ドキュメント内に表示されません。次に、<OD> 要素に sql:hide を指定した別の XSD スキーマを示します。
<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="2005-08-01" />
<Order CustomerID="1" OID="44501" OrderDate="2005-11-01" />
<Order CustomerID="1" OID="45283" OrderDate="2006-02-01" />
<Order CustomerID="1" OID="46042" OrderDate="2006-05-01" />
</Customers>
</ROOT>