データベースのデータとやり取りする場合は、LinqDataSource コントロールをデータベースに直接接続しません。代わりに、データベースおよびそのテーブルを表すエンティティ クラスとやり取りします。エンティティ クラスを生成するには、オブジェクト リレーショナル デザイナ を使用するか、SqlMetal.exe ユーティリティを実行します。詳細については、「オブジェクト リレーショナル デザイナ (O/R デザイナ)」または「コード生成ツール (SqlMetal.exe)」を参照してください。作成したエンティティ クラスは、通常、Web アプリケーションの App_Code フォルダに格納されます。O/R デザイナ または SqlMetal.exe ユーティリティは、データベースを表すクラスを 1 つと、データベースのテーブルを表すクラスをテーブルごとに 1 つ生成します。

データベースを表すクラスは、データ ソースの値の取得と設定を行います。LinqDataSource コントロールは、データ テーブルを表すクラスのプロパティの読み込みと設定を行います。更新、挿入、および削除の各操作をサポートするには、データベース クラスが DataContext クラスから派生し、テーブル クラスが Table<(Of <(TEntity>)>) クラスを参照している必要があります。

LinqDataSource コントロールをデータベース クラスに接続するには、ContextTypeName プロパティを、データベースを表すクラスの名前に設定します。LinqDataSource コントロールを特定のテーブルに接続するには、TableName プロパティを、そのデータ テーブルを表すクラスの名前に設定します。たとえば、AdventureWorks データベースの Contacts テーブルに接続するには、ContextTypeName プロパティを AdventureWorksDataContext (または、このデータベース オブジェクトに対して指定した名前) に設定します。TableName プロパティは Contacts に設定します。AdventureWorks データベースに接続する LinqDataSource コントロールのマークアップの例を次に示します。

<asp:LinqDataSource 
    ContextTypeName="AdventureWorksDataContext" 
    TableName="Contacts" 
    ID="LinqDataSource1" 
    runat="server">
</asp:LinqDataSource>

この例では、O/R デザイナによって生成されたクラスは示していません。生成されたコードが、このトピックで扱うには長すぎるためです。ただし、この例が機能するには、この生成されたコードが必要です。詳細については、「LINQ to SQL でのコード生成」を参照してください。

配列などのメモリ内データ コレクションに接続する場合は、ContextTypeName プロパティを、このコレクションを表すクラスの名前に設定します。TableName プロパティは、コレクション自体の名前に設定します。

文字列値の配列が格納されたクラスの例を次に示します。

Public Class MovieLibrary
    Dim _availableGenres() As String = {"Comedy", "Drama", "Romance"}

    Public ReadOnly Property AvailableGenres() As String()
        Get
            Return _availableGenres
        End Get
    End Property

End Class

public class MovieLibrary
{
    string[] _availableGenres = { "Comedy", "Drama", "Romance" };

    public MovieLibrary()
    {
    }

    public string[] AvailableGenres
    {
        get
        {
            return _availableGenres;
        }
    }
}

上の例のクラスから動画ジャンルの一覧を読み込む LinqDataSource コントロールの例を次に示します。ジャンルの配列を取得するには、ContextTypeName プロパティを MovieLibrary に設定し、TableName プロパティを AvailableGenres に設定します。

<asp:LinqDataSource 
    ContextTypeName="MovieLibrary" 
    TableName="AvailableGenres" 
    ID="LinqDataSource1" 
    runat="server">
</asp:LinqDataSource>

LinqDataSource コントロールのデータを表示するために、データ バインド コントロールを LinqDataSource コントロールにバインドできます。たとえば、DetailsView コントロール、GridView コントロール、または ListView コントロールを LinqDataSource コントロールにバインドします。これを行うには、データ バインド コントロールの DataSourceID プロパティを、LinqDataSource コントロールの ID に設定します。LinqDataSource コントロールのすべてのデータを表示する GridView コントロールの例を次に示します。

<asp:LinqDataSource 
    runat="server"
    ContextTypeName="AdventureWorksDataContext" 
    TableName="Contacts" 
    ID="LinqDataSource1">
</asp:LinqDataSource>
<asp:GridView 
    ID="GridView1" 
    runat="server"
    DataSourceID="LinqDataSource1" >
</asp:GridView>

データ バインド コントロールによってユーザー インターフェイスが自動的に作成され、LinqDataSource コントロールのデータが表示されます。データの並べ替えとページングのためのインターフェイスを表示することもできます。データ変更が許可されている場合は、レコードの更新、挿入、および削除のためのインターフェイスが表示されます。

どのデータ (プロパティ) を表示するかを制限するには、データ コントロールのフィールドが自動生成されないようにデータ バインド コントロールを構成します。こうすると、これらのフィールドをデータ バインド コントロールで明示的に定義できます。LinqDataSource コントロールの場合はすべてのデータが取得されますが、データ バインド コントロールの場合は指定したプロパティのみが表示されます。AdventureWorks データベースの Products テーブルの Name プロパティと StandardCost プロパティのみを表示する GridView コントロールの例を次に示します。AutoGenerateColumns プロパティが false に設定されています。

<asp:LinqDataSource 
    ContextTypeName="AdventureWorksDataContext" 
    TableName="Products" 
    ID="LinqDataSource1" 
    runat="server">
</asp:LinqDataSource>
<asp:GridView 
    DataSourceID="LinqDataSource1" 
    AutoGenerateColumns="false"
    ID="GridView1" 
    runat="server">
    <Columns>
        <asp:BoundField DataField="Name" />
        <asp:BoundField DataField="StandardCost" />
    </Columns>
</asp:GridView>

クエリで返されるプロパティの種類を制限する必要がある場合、これらのプロパティを定義するには、LinqDataSource コントロールの Select プロパティを設定します。

LinqDataSource コントロールを使用すると、SqlDataSource コントロールまたは ObjectDataSource コントロールを使用する場合と比べて、データ操作を実行するために記述するコードが少なくて済みます。LinqDataSource コントロールは、接続先のデータ ソースに関する情報を推論し、データの選択、更新、挿入、および削除のためのコマンドを動的に作成できます。また、LinqDataSource コントロールを使用する場合、1 つのプログラミング モデルを習得するだけで、さまざまな種類のデータ ソースとやり取りできます。

SqlDataSource コントロールとの比較

ObjectDataSource コントロールとの比較

LinqDataSource コントロールの Select プロパティの値を指定しなかった場合、データ ソース クラスのすべてのプロパティが取得されます。たとえば、LinqDataSource コントロールは、データベース テーブルの各列の値を返します。

データ ソースから取得するプロパティの種類を制限するには、Select プロパティを、取得するプロパティの名前に設定します。1 つのプロパティのみを取得する場合は、Select プロパティをそのプロパティの名前に設定します。たとえば、データベース テーブルの City 列の値のみを取得するには、Select プロパティを City に設定します。LinqDataSource コントロールは、このプロパティから、適切に型指定された項目が格納された List<(Of <(T>)>) コレクションを返します。City プロパティがテキスト (文字列) として型指定されている場合、City プロパティを選択すると、文字列値の List<(Of <(T>)>) コレクションが返されます。

データ クラスの一部のプロパティのみを取得するには、Select プロパティで new 関数を使用し、取得する列を指定します。指定したプロパティのみを含むクラスを動的に作成することになるので、new 関数を使用する必要があります。たとえば、詳細な住所が格納されたデータ ソースから City プロパティと PostalCode プロパティのみを取得する場合は、Select プロパティを new(City, PostalCode) に設定します。LinqDataSource コントロールは、これらのプロパティを含むクラスのインスタンスが格納された List<(Of <(T>)>) コレクションを返します。

1 つのプロパティのみを選択する場合、返されるオブジェクトはそのプロパティの値の単純なコレクションであるため、new 関数を使用する必要はありません。一方、複数のプロパティを指定する場合、LinqDataSource コントロールで、それらのプロパティを含む新しいクラスを作成する必要があります。

Select 句による値の計算

<asp:LinqDataSource 
    ContextTypeName="ExampleDataContext" 
    TableName="OrderDetails" 
    Select="new(SalesOrderDetailID As DetailID, 
      OrderQty * UnitPrice As LineItemTotal, 
      DateCreated As SaleDate)"
    ID="LinqDataSource1" 
    runat="server">
</asp:LinqDataSource>

返されたデータをフィルタ処理して、特定の条件を満たすレコードのみを取得できます。これを行うには、Where プロパティを、返されるデータに含まれるためにレコードが満たす必要がある条件に設定します。Where プロパティの値を指定しなかった場合、データ ソースのすべてのレコードが取得されます。フィルタ処理するには、フィルタ式を作成します。フィルタ式では、比較を使用して、レコードを含めるかどうかを判定します。比較は、静的な値に対して行うことも、パラメータ プレースホルダで指定する変数値に対して行うこともできます。

静的な値を使用した Where 句の作成

<asp:LinqDataSource
  ContextTypeName="ExampleDataContext"
  TableName="Product"
  Where='Category = "Sports" && Weight < 10'
  ID="LinqDataSource1"
  runat="server"
</asp:LinqDataSource>

パラメータ化された Where 句の作成

<asp:DropDownList AutoPostBack="true" ID="DropDownList1" runat="server">
  <asp:ListItem Value="Sports">Sports</asp:ListItem>
  <asp:ListItem Value="Garden">Garden</asp:ListItem>
  <asp:ListItem Value="Auto">Auto</asp:ListItem>
</asp:DropDownList>
<asp:LinqDataSource 
    ContextTypeName="ExampleDataContext" 
    TableName="Products" 
    AutoGenerateWhereClause="true"
    ID="LinqDataSource1" 
    runat="server">
  <WhereParameters>
    <asp:ControlParameter 
      Name="Category" 
      ControlID="DropDownList1" 
      Type="String" />
  </WhereParameters>
</asp:LinqDataSource>
<asp:GridView 
    DataSourceID="LinqDataSource1"
    ID="GridView1" 
    runat="server">
</asp:GridView>

<asp:DropDownList 
    AutoPostBack="true" 
    ID="DropDownList1" 
    runat="server">
  <asp:ListItem Value="0">0</asp:ListItem>
  <asp:ListItem Value="25">25</asp:ListItem>
  <asp:ListItem Value="100">100</asp:ListItem>
  <asp:ListItem Value="400">400</asp:ListItem>
</asp:DropDownList>
<asp:LinqDataSource 
    ContextTypeName="ExampleDataContext" 
    TableName="Products" 
    Where="Price > @UserPrice"
    ID="LinqDataSource1" 
    runat="server">
  <WhereParameters>
    <asp:ControlParameter 
      Name="UserPrice" 
      DefaultValue="0" 
      ControlID="DropDownList1" 
      Type="Int32" />
  </WhereParameters>
</asp:LinqDataSource>
<asp:GridView 
    DataSourceID="LinqDataSource1"
    ID="GridView1" 
    runat="server">
</asp:GridView>

1 つ以上の列に共通の値を持つレコードのデータを統合するために、データをグループ化できます。これを行うには、GroupBy プロパティを、データの統合に使用するプロパティの名前に変更します。たとえば、住所情報が格納されたテーブルから同じ市区町村の値を持つレコードをグループ化するには、GroupBy を City に設定します。

GroupBy プロパティを集計関数と組み合わせて使用すると、グループ化されたデータの値を計算して、プロパティの平均や合計を取得できます。グループ化に使用された値を取得するには、Key オブジェクトを参照します。

ProductCategory という名前のプロパティでデータをグループ化する方法の例を次に示します。グループ化された値は、Select プロパティに Key を指定することによって取得します。Select プロパティには、Average 集計メソッドと Count 集計メソッドも指定しています。

<asp:LinqDataSource 
  ContextTypeName="ExampleDataContext" 
  TableName="Products" 
  GroupBy="ProductCategory"
  Select="new(Key, 
    Average(ListPrice) As AverageListPrice, 
    Average(Cost) As AverageCost, 
    Count() As RecordCount)"
  ID="LinqDataSource1" 
  runat="server">
</asp:LinqDataSource>

グループに含まれる個々のレコードを取得するには、It キーワードを使用します。詳細については、「方法 : LinqDataSource コントロールを使用してデータをグループ化および集計する」を参照してください。

集計メソッド

データの更新、挿入、および削除を行うためのコマンドを自動的に作成するように、LinqDataSource コントロールを構成できます。データの自動更新を有効にするには、EnableUpdate プロパティ、EnableInsert プロパティ、または EnableDelete プロパティを true に設定します。

メモ :
LinqDataSource コントロールで更新コマンドが自動的に生成されるようにする場合は、Select プロパティを設定することはできません。Select プロパティが設定された場合、LinqDataSource コントロールは動的クラスのインスタンスであるオブジェクトを返します。これは、データベース テーブルを表すクラスのインスタンスではありません。したがって、動的クラスでは、データベース テーブルの値を更新する方法を推論できません。

値が更新されるようにプログラムによって設定する必要がある場合は、Updating、Inserting、または Deleting の各イベントに対するイベント ハンドラを作成できます。このハンドラでは、データ操作の開始前に値を設定できます。詳細については、「方法 : LinqDataSource コントロールを使用してデータを更新、挿入、および削除する」を参照してください。

LinqDataSource オブジェクトでは、クエリから返されたデータを 2 とおりの方法で並べ替えることができます。Web ページを開発する場合は、静的な値でデータを並べ替えることができます。また、実行時にユーザーが動的にデータを並べ替えることができるようにすることもできます。

静的なデータに従ってデータを並べ替えるには、プロパティの名前を OrderBy プロパティに割り当てます。実行時にユーザーがデータを並べ替えることができるようにするには、AutoSort プロパティを true (既定値) に設定します。次に、並べ替え式を LinqDataSource コントロールに渡します。GridView コントロールなどのデータ バインド コントロールは、AllowSorting プロパティが true に設定されている場合のみ、並べ替え式を渡します。

OrderBy プロパティに複数の列名を指定するには、列名をコンマで区切ります。たとえば、"LastName, FirstName" と指定した場合、最初に LastName を基準にレコードが並べ替えられ、LastName フィールドに一致する値を持つレコードが FirstName を基準に並べ替えられます。

最初に特定の順序でデータを返し、次にユーザーがその順序を変更できるようにする場合は、両方の並べ替え方法を使用できます。その場合は、AutoSort プロパティを true に設定し、OrderBy プロパティをプロパティの名前に設定します。

最初に LastName を基準にレコード並べ替え、次に FirstName を基準に並べ替え、最後に MiddleName を基準に並べ替える LinqDataSource コントロールの例を次に示します。また、LinqDataSource コントロールは、ユーザーが動的に行を並べ替えることができるように構成されています。GridView コントロールなどのデータ コントロールを LinqDataSource コントロールにバインドすると、データを表示し、ユーザーが並べ替え順序を指定できるように構成できます。

<asp:LinqDataSource
  ContextTypeName="ExampleDataContext"
  TableName="Contact"
  OrderBy="LastName, FirstName, MiddleName"
  AutoSort="true"
  ID="LinqDataSource1"
  runat="server"
</asp:LinqDataSource>

LinqDataSource コントロールを使用する場合は、パラメータを使用して、実行時に解釈または変換される値を指定します。他のデータ ソース コントロールを使用する場合と異なり、更新、挿入、または削除の各操作の一部である各値を指定する必要はありません。LinqDataSource コントロールは、これらの値を自動的に設定し、LINQ to SQL を使用して SQL コマンドを生成します。パラメータを指定するのは、既定値を指定する場合、または空の値を変換する場合だけです。また、WhereParameters パラメータ コレクションまたは OrderByParameters パラメータ コレクションを使用して、実行時の値に基づいてデータの並べ替えまたはフィルタ処理を行うこともできます。LINQ to SQL の詳細については、「LINQ to SQL」を参照してください。

LinqDataSource コントロールには、次のパラメータ コレクションがあります。

• DeleteParameters

• GroupByParameters

• InsertParameters

• OrderByParameters

• SelectParameters

• UpdateParameters

• WhereParameters.

WhereParameters コレクションを使用して、LinqDataSource コントロールから返されたレコードをユーザーが動的にフィルタ処理できるようにする方法の例については、このトピックの前半の「Where 句によるデータのフィルタ処理」を参照してください。

ユーザーによるデータの更新または削除を許可する場合、別のプロセスによってデータ ソース内のデータが変更されていないことを確認したうえで、更新または削除の操作を続行する必要があります。値が変更されたかどうかを確認しないと、別のプロセスによって設定された値を誤って上書きして、データが矛盾した状態のままになる可能性があります。

LinqDataSource コントロールを使用すると、データが変更されたかどうかを判定できます。このコントロールは、元の値を Web ページのビューステートに格納します。Web ページがポストバックされると、元の値と更新後の値の両方がページに格納されます。LinqDataSource コントロールでは、LINQ to SQL を使用して、元の値とデータ ソース内の現在の値が比較されます。これらの値が同じ場合はデータが変更されていないことを意味し、LINQ to SQL によってデータが更新または削除されます。データが変更されていた場合、LINQ to SQL は例外を発生させます。

どの列の値を確認するかを手動で指定するには、エンティティ クラスで列の UpdateCheck プロパティを設定します。O/R デザイナ によってデータベース テーブルのコードが生成されるときに、データベースで管理されている列について UpdateCheck プロパティが Never に設定されます。その他の列の値は、常に同時実行チェックに含まれることを意味する Always に設定されます。列が同時実行チェックに含まれないようにするには、UpdateCheck プロパティを Never に設定します。このプロパティを Never に設定すると、その列の値がビューステートに格納されることもなくなります。ユーザーが値を変更した場合のみ、データ ソースと照合して値をチェックするには、UpdateCheck プロパティを WhenChanged に設定します。

重要情報をビューステートに格納する必要がある場合は、ビューステートを暗号化することをお勧めします。詳細については、「Encrypt ViewState in ASP.NET 2.0」を参照してください。

メモ :
ビューステートを暗号化すると、Web ページのパフォーマンスに影響を及ぼす可能性があります。

SQL Server データの同時実行チェックの最適化

LinqDataSource コントロールを使用してストアド プロシージャからデータを取得するには、Selecting イベントのハンドラを作成します。このイベント ハンドラでは、ストアド プロシージャを表すデータコンテキスト クラスのメソッドを呼び出します。次に、ストアド プロシージャの結果を LinqDataSourceSelectEventArgs オブジェクトの Result プロパティに設定します。自動的な更新、挿入、および削除の操作を有効にするには、メソッドから返される型が、TableName プロパティで指定される型と一致する必要があります。

Result プロパティを、ストアド プロシージャを表すメソッドから返されるオブジェクトに割り当てる方法を次の例に示します。

Protected Sub LinqDataSource_Selecting(ByVal sender As Object, _
        ByVal e As LinqDataSourceSelectEventArgs)
    Dim exampleContext As ExampleDataContext = New ExampleDataContext()
    e.Result = exampleContext.GetRegisteredCustomers()
End Sub

protected void LinqDataSource_Selecting(object sender, 
        LinqDataSourceSelectEventArgs e)
{
    ExampleDataContext exampleContext = new ExampleDataContext();
    e.Result = exampleContext.GetRegisteredCustomers();
}

データ コンテキスト メソッドの作成の詳細については、「方法 : ストアド プロシージャや関数にマップされる DataContext メソッドを作成する (O/R デザイナ)」を参照してください。

データ レコードを修正する前に、値を検証する必要があります。通常は、Web ページではなくデータ クラスに検証チェックを含めます。データ クラスに検証チェックを集中化することで、データ クラスの使用方法にかかわらず検証チェックが使用されることを確認できます。クラスに検証を追加する方法の詳細については、「方法 : エンティティ クラスに検証を追加する」および「チュートリアル : エンティティ クラスへの検証の追加」を参照してください。

検証の例外は、データの更新、挿入、または削除の前にスローされます。検証の例外を取得するために、Inserting、Updating、および Deleting の各イベントのハンドラを作成します。詳細については、LinqDataSourceUpdateEventArgs、LinqDataSourceInsertEventArgs、および LinqDataSourceDeleteEventArgs の各クラスを参照してください。

LinqDataSource コントロールは、データの選択、挿入、更新、または削除の方法をカスタマイズできるように、処理の間の特定の時点でイベントを発生させます。

データの選択時、LinqDataSource コントロールでは、次のイベントが (この順序で) 発生します。

1. Selecting

2. ContextCreating (必要な場合)

3. ContextCreated (必要な場合)

4. Selected

5. ContextDisposing

Selecting イベントでコンテキスト オブジェクトをプログラムによって作成した場合、元の値をビューステートに格納する必要がないときは、ContextCreating イベントおよび ContextCreated イベントはスキップされます。

データの更新、挿入、または削除時、LinqDataSource コントロールでは、次のイベントが (この順序で) 発生します。

1. ContextCreating

2. ContextCreated

3. Inserting、Updating、または Deleting

4. Inserted、Updated、または Deleted

5. ContextDisposing

更新、削除、および挿入の各操作のイベントの順序は、選択操作の場合と異なります。これは、LinqDataSource コントロールがデータ オブジェクトのインスタンスを取得し、このインスタンスを Inserting、Updating、または Deleting の各イベントに渡す必要があるためです。

Selecting、Inserting、Updating、および Deleting の各イベントは、データ操作が実行される前に発生します。操作の前に値を検証して変更するか、または操作を取り消すには、これらのイベントに対するイベント ハンドラを作成します。たとえば、最後にレコードを変更したユーザーの名前を格納する列が設定されているデータベースの場合は、Updating イベントを使用すると、ユーザー名の値をプログラムによって設定できます。

Selected、Inserted、Updated、および Deleted の各イベントは、操作完了後に発生します。例外をキャッチするか、または操作から返された値を調べるには、これらのイベントに対するイベント ハンドラを作成します。

LinqDataSource コントロールは、ContextTypeName プロパティに指定された種類を作成する前に ContextCreating イベントを発生させます。プログラムによってコンテキストの種類を作成する場合は、このイベントを処理します。これを行うのは、たとえば、コンテキストの種類のコンストラクタ メソッドでパラメータが必要な場合です。ContextCreated イベントは、ContextTypeName プロパティに指定された種類が作成された後で発生します。例外をキャッチするか、または作成されたコンテキストのオブジェクトを調べるには、このイベントを処理します。ContextDisposing イベントは、ContextTypeName プロパティに指定された種類を LinqDataSource コントロールが破棄する前に発生します。作成時の負荷が大きい (作成に時間がかかる、リソースの消費が激しいなど) オブジェクトの破棄を取り消すには、このイベントを処理します。オブジェクトが破棄される前に、そのオブジェクトに固有のクリーンアップ操作を実行する場合も、このイベントを使用できます。

ページのトップへ