CommandText プロパティを使用した、テンプレート ファイルの実行

適用対象:SQL ServerAzure SQL Database

この例では、CommandText プロパティを使用して、SQL または XPath クエリで構成されるテンプレート ファイルを指定する方法を示します。 SQL または XPath クエリを CommandText の値として指定する代わりに、ファイル名を値として指定できます。 次の例では、CommandType プロパティを SqlXmlCommandType.TemplateFile として指定しています。

サンプル アプリケーションでは、次のテンプレートが実行されます。

<ROOT xmlns:sql="urn:schemas-microsoft-com:xml-sql">  
  <sql:query>  
    SELECT TOP 2 ContactID, FirstName, LastName   
    FROM   Person.Contact  
    FOR XML AUTO  
  </sql:query>  
</ROOT>  

これは C# サンプル アプリケーションです。 このアプリケーションをテストするには、テンプレート (TemplateFile.xml) を保存した後、アプリケーションを実行します。

注意

コードでは、接続文字列内の Microsoft SQL Server のインスタンスの名前を指定する必要があります。

using System;  
using Microsoft.Data.SqlXml;  
using System.IO;  
class Test  
{  
      static string ConnString = "Provider=SQLOLEDB;Server=(local);database=AdventureWorks;Integrated Security=SSPI";  
  
      public static int testParams()  
      {  
         //Stream strm;  
         SqlXmlCommand cmd = new SqlXmlCommand(ConnString);  
         cmd.CommandType = SqlXmlCommandType.TemplateFile;  
         cmd.CommandText = "TemplateFile.xml";  
         using (Stream strm = cmd.ExecuteStream()){  
            using (StreamReader sr = new StreamReader(strm)){  
                Console.WriteLine(sr.ReadToEnd());  
            }  
         }  
  
         return 0;        
      }  
      public static int Main(String[] args)  
      {  
         testParams();     
         return 0;  
      }  
   }  

アプリケーションをテストするには

1. コンピューターに Microsoft .NET Frameworkがインストールされていることを確認します。

2. この例で提供される XML テンプレート (TemplateFile.xml) をフォルダーに保存します。

3. この例で提供されている C# コード (DocSample.cs) を、スキーマが格納されているのと同じフォルダーに保存します。 ファイルを別のフォルダーに保存する場合は、コードを編集して、マッピング スキーマに対する適切なディレクトリ パスを指定する必要があります。

4. コードをコンパイルします。 コマンド プロンプトでコードをコンパイルするには、次を使用します。

   csc /reference:Microsoft.Data.SqlXML.dll DocSample.cs  
   

   これにより、実行可能ファイル (DocSample.exe) が作成されます。

5. コマンド プロンプトで、DocSample.exe を実行します。

テンプレートにパラメーターを渡す場合、パラメーター名は記号 (@) で始まる必要があります。たとえば、p.Name="@ContactID"。p は SqlXmlParameter オブジェクトです。

次は、1 つのパラメーターをとるように変更したテンプレートです。

<ROOT xmlns:sql="urn:schemas-microsoft-com:xml-sql">  
  <sql:header>  
     <sql:param name='ContactID'>1</sql:param>    
  </sql:header>  
  <sql:query>  
    SELECT ContactID, FirstName, LastName  
    FROM   Person.Contact  
    WHERE  ContactID=@ContactID  
    FOR XML AUTO  
  </sql:query>  
</ROOT>  

次は、テンプレートを実行するパラメーターを渡すように変更したコードです。

public static int testParams()  
{  
  
   Stream strm;  
   SqlXmlParameter p;  
  
   SqlXmlCommand cmd = new SqlXmlCommand(ConnString);  
   cmd.CommandType = SqlXmlCommandType.TemplateFile;  
   cmd.CommandText = "TemplateFile.xml";  
   p = cmd.CreateParameter();  
   p.Name="@ContactID";  
   p.Value = "1";  
   strm = cmd.ExecuteStream();  
   StreamReader sw = new StreamReader(strm);  
   Console.WriteLine(sw.ReadToEnd());  
   return 0;        
}