SqlDataSource Web サーバーコントロールの概要

[アーティクル]
10/22/2014

更新 : 2007 年 11 月

SqlDataSource コントロールでは、Web サーバーコントロールを使用して、リレーショナルデータベースにあるデータにアクセスできます。これには、Microsoft SQL Server データベースや Oracle データベースに加え、OLE DB データソースや ODBC データソースも含まれます。SqlDataSource コントロールは、GridView、FormView、DetailsView の各コントロールなどのデータバインドコントロールと共に使用し、コードをほとんど、またはまったく使用せずに ASP.NET Web ページのデータを表示して操作できます。

このトピックの内容は次のとおりです。

背景
コード例
クラスリファレンス

背景

SqlDataSource コントロールは、ADO.NET クラスを使用して、ADO.NET でサポートされるすべてのデータベースと対話します。これらのデータベースには、Microsoft SQL Server (System.Data.SqlClient プロバイダを使用)、System.Data.OleDb、System.Data.Odbc、および Oracle (System.Data.OracleClient プロバイダを使用) があります。SqlDataSource コントロールを使用すると、ADO.NET のクラスを直接使用せずに ASP.NET ページのデータにアクセスして操作できます。データベースに接続するための接続文字列を指定し、データの操作に使用する SQL ステートメントまたはストアドプロシージャを定義します。SqlDataSource コントロールは実行時にデータベース接続を自動的に開き、SQL ステートメントまたはストアドプロシージャを実行し、選択されたデータがある場合はそれを返してから接続を閉じます。

データソースへの SqlDataSource コントロールの接続

SqlDataSource コントロールを構成する場合、ProviderName プロパティをデータベースの種類に設定し (既定値は System.Data.SqlClient)、ConnectionString プロパティをデータベースに接続するために必要な情報を含む接続文字列に設定します。接続文字列の内容は、データソースコントロールがアクセスするデータベースの種類によって異なります。たとえば、SqlDataSource コントロールには、サーバー名、データベース名 (カタログ名)、および SQL Server に接続する際にユーザーを認証する方法に関する情報が必要です。有効な接続文字列については、SqlConnection、OracleConnection、OleDbConnection、および OdbcConnection の各クラスの ConnectionString プロパティのトピックを参照してください。

接続文字列は、SqlDataSource コントロールのプロパティの設定としてデザイン時に設定する代わりに、connectionStrings 構成要素を使用して、アプリケーションの構成設定の一部として中央の場所に格納することもできます。この方法では、ASP.NET のコードから独立して接続文字列を管理でき、プロテクト構成を使用して暗号化することもできます。MyNorthwind という connectionStrings 構成要素に格納されている接続文字列を使用して SQL Server の Northwind サンプルデータベースに接続するコード例を次に示します。

<%@ Page language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <asp:SqlDataSource
          id="SqlDataSource1"
          runat="server"
          DataSourceMode="DataReader"
          ConnectionString="<%$ ConnectionStrings:MyNorthwind%>"
          SelectCommand="SELECT LastName FROM Employees">
      </asp:SqlDataSource>

      <asp:ListBox
          id="ListBox1"
          runat="server"
          DataTextField="LastName"
          DataSourceID="SqlDataSource1">
      </asp:ListBox>

    </form>
  </body>
</html>

<%@ Page language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <asp:SqlDataSource
          id="SqlDataSource1"
          runat="server"
          DataSourceMode="DataReader"
          ConnectionString="<%$ ConnectionStrings:MyNorthwind%>"
          SelectCommand="SELECT LastName FROM Employees">
      </asp:SqlDataSource>

      <asp:ListBox
          id="ListBox1"
          runat="server"
          DataTextField="LastName"
          DataSourceID="SqlDataSource1">
      </asp:ListBox>

    </form>
  </body>
</html>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">
      <asp:SqlDataSource
          id="SqlDataSource1"
          runat="server"
          DataSourceMode="DataReader"
          ConnectionString="Data Source=localhost;Integrated Security=SSPI;Initial Catalog=Northwind;"
          SelectCommand="SELECT LastName FROM Employees">
      </asp:SqlDataSource>

      <asp:ListBox
          id="ListBox1"
          runat="server"
          DataTextField="LastName"
          DataSourceID="SqlDataSource1">
      </asp:ListBox>

    </form>
  </body>
</html>

SqlDataSource コントロールによるデータコマンドの発行

SqlDataSource コマンドには、SelectCommand、UpdateCommand、DeleteCommand、および InsertCommand の中から 4 つまでのコマンド (SQL クエリ) を指定できます。各コマンドは、データソースコントロールの個別のプロパティです。各コマンドプロパティに対して、データソースコントロールが実行する SQL ステートメントを指定します。ストアドプロシージャをサポートするデータベースに接続する場合、データソースコントロールには SQL ステートメントの代わりにストアドプロシージャの名前を指定できます。

実行時に値を提供するためのプレースホルダを含むパラメータ化されたコマンドを作成できます。パラメータ化された SQL Select コマンドの一般的な例を次に示します。

Select CustomerID, CompanyName From Customers Where City = @city

実行時にコマンドがパラメータ値を取得する場所 (別のコントロール、クエリ文字列など) を指定するパラメータオブジェクトを作成できます。プログラムによってパラメータ値を指定することもできます。詳細については、「SqlDataSource コントロールにおけるパラメータの使用」を参照してください。

データソースコントロールは、対応する Select、Update、Delete、または Insert の各メソッドが呼び出されたときにコマンドを実行します。ページの、またはデータソースコントロールに連結されたコントロールの DataBind メソッドを呼び出すと、Select メソッドが自動的に呼び出されます。4 つのメソッドのいずれかを明示的に呼び出して、必要なときにデータソースコントロールにコマンドを実行させることもできます。GridView コントロールなどの一部のコントロールでは、このようなメソッドを自動的に呼び出すことができます。その場合、そのメソッドを呼び出したり、DataBind メソッドを明示的に呼び出す必要はありません。詳細については、「SqlDataSource コントロールによるデータの選択」および「SqlDataSource コントロールによるデータの変更」を参照してください。

DataSet オブジェクトまたは DataReader オブジェクトを返す

SqlDataSource コントロールは、DataSet オブジェクトまたは ADO.NET データリーダーの 2 つの形式でデータを返すことができます。データソースコントロールの DataSourceMode プロパティを設定して、返す形式を指定できます。DataSet オブジェクトにはサーバーのメモリのすべてのデータが含まれるので、取得した後にさまざまな方法でデータを操作できます。データリーダーには、個々のレコードをフェッチするための読み取り専用のカーソルがあります。一般に、データの取得後にデータのフィルタ、並べ替え、またはページングを行う場合、またはキャッシュを維持する場合は、データセットを返します。一方、ページのコントロールを使用して返されたデータを表示するだけの場合は、データリーダーを使用します。データリーダーは、返されたデータを ListBox、DropDownList、または GridView の各コントロールに読み取り専用のリストとして表示する場合などに最適です。

SqlDataSource コントロールによるキャッシュ

SqlDataSource コントロールは取得したデータをキャッシュできるので、負荷の大きいクエリの実行を回避して、アプリケーションのパフォーマンスを向上できます。データの揮発性が比較的低く、キャッシュされた結果がシステムメモリを大量に占有しない場合、キャッシュはほとんどすべての状況で有効です。

既定では、キャッシュは無効になっています。キャッシュを有効にするには、EnableCaching を true に設定します。キャッシュ機構は時間に基づきます。CacheDuration プロパティにデータをキャッシュする秒数を設定できます。データソースコントロールは、接続、select コマンド、select のパラメータ、およびキャッシュの設定の組み合わせに対して個別のキャッシュエントリを維持します。

SqlDataSource コントロールは、SQL Server のキャッシュ依存関係の機能を使用できます (使用している SQL Server のバージョンで利用可能な場合)。この機能によって、SQL Server が指定されたテーブルの変更を報告するまでキャッシュ内のデータを維持するように指定できます。このようなキャッシュでは、データの取得を更新されたデータを取得する必要がある場合のみに抑えることができるので、Web アプリケーションのデータアクセスのパフォーマンスを向上できます。

詳細については、「SqlDataSource コントロールによるデータのキャッシュ」を参照してください。

SqlDataSource コントロールによるフィルタ処理

SqlDataSource コントロールのキャッシュを有効にし、データセットの形式を Select クエリが返すデータの形式に指定している場合、クエリを再実行せずにデータをフィルタ処理することもできます。SqlDataSource コントロールは FilterExpression プロパティをサポートするので、データソースコントロールが維持するデータに選択基準を指定できます。実行時にフィルタ式に値を提供する特別な FilterParameters オブジェクトを作成することにより、フィルタ式をパラメータ化することもできます。