SQL Server 2005で1ページ分のデータを効率よく返す
4Guysへの以前の投稿『Returning Ranked Results with Microsoft SQL Server 2005』で紹介したように、SQL Server 2005では、順序付けした結果を返す新しいキーワードがいくつか導入されました。特に、ROW_NUMBER()
キーワードを指定すると、返される結果に連番の行番号が付けられます。そこで、ROW_NUMBER()
を使って、次のようなクエリを実行することで特定のページのデータを取得することができます。
SELECT ... FROM (SELECT ... ''ROW_NUMBER() OVER(ORDER BY ColumnName) as RowNum'' FROM Employees e ) as <DerivedTableName> WHERE ''RowNum BETWEEN @startRowIndex AND (@startRowIndex + @maximumRows) - 1''
ここで、@startRowIndex
は開始行のインデックスで、@maximumRows
はページあたりの表示レコードの最大数です。このクエリは、開始行のインデックスから「開始行のインデックス+ページあたりのレコード数」のインデックスまでのROW_NUMBER()
を持つレコードのサブセットを返します。
この概念を理解するために、具体的な例を紹介しましょう。ここに、5,000個のレコードから成る「Employees」テーブルがあるとします(事業が好調ですね)。次のクエリを実行します。
SELECT RowNum, EmployeeID, LastName, FirstName FROM (SELECT EmployeeID, LastName, FirstName ''ROW_NUMBER() OVER(ORDER BY EmployeeID) as RowNum'' FROM Employees e ) as EmployeeInfo
この場合は、次のような結果が返されます。
RowNum | EmployeeID | LastName | FirstName |
1 | 1000 | Smith | Frank |
2 | 1001 | Jackson | Lucy |
3 | 1011 | Lee | Sam |
4 | 1012 | Mitchell | Jisun |
5 | 1013 | Yates | Scott |
6 | 1016 | Props | Kathryn |
…… | |||
5000 | 6141 | Jordan | DJ |
EmployeeIDフィールドが連番ではなく、しかも1から始まっていない場合でも、ROW_NUMBER()
値は1つ目のレコードに対する1から始まり、連番になっていることに注意してください。そのため、ページあたりのレコード数を10個として、3ページ目を表示する場合は、31~40のレコードが必要であることが分かるので、簡単なWHERE
句でそれを実現することができます。
カスタムのページング処理に合わせてObjectDataSourceを設定する
既に説明したように、SqlDataSourceはカスタムの並べ替え機能に向いていませんが、ObjectDataSourceはこの機能をサポートするように作られています。ObjectDataSourceは、オブジェクトの提供データにアクセスするためのデータソースコントロールです。データ提供側のオブジェクトは、自身が提供するデータをさまざまな手段で取得することができます(Webサービス、データベース、ファイルシステム、XMLファイルなど、多様な方法が考えられます)。ObjectDataSourceは、オブジェクトがどのような手段でデータを取得しているかに関係なく、ただオブジェクトとそのデータを使用するデータWebコントロール(GridViewコントロールなど)との間のプロキシの役割を果たします(ObjectDataSourceの詳細については、『ObjectDataSourceコントロールの概要』を参照してください)。
データWebコントロールをObjectDataSourceにバインドする場合には[ページングを有効にする]チェックボックスをオンにします。このとき、特にカスタムのページング処理をサポートするようにObjectDataSourceを設定していないと、既定のページング処理が有効になります。カスタムのページング処理をサポートするようにObjectDataSourceを設定するには、次の機能を提供するオブジェクトを使う必要があります。
- 最後の2つの入力パラメータとして2つの整数値を取るメソッド。1つ目の整数値ではデータの取得先の開始インデックス(ゼロベース)を指定し、2つ目の整数値ではページあたりに取得するレコードの最大数を指定します。このメソッドは、要求されているデータの正しいサブセット、つまり指定されたインデックスを先頭として、指定されたレコードの合計数を超えないデータを返す必要があります。
- ページング処理の対象となるレコードの合計数を表す整数値を返すメソッド(ページ番号を表示するときや[次のページ]リンクを有効にするかどうかを指定するときにはデータの総ページ数を認識する必要があるので、ページング処理コントロールのレンダリング時にデータWebコントロールでこの情報が使用されます)。
これらの機能を提供するベースオブジェクトを用いれば、カスタムのページング処理をサポートするようにObjectDataSourceを設定することは非常に簡単です。必要なのは、次に示すObjectDataSourceのプロパティを設定することだけです。
EnablePaging
プロパティをTrueに設定する。SelectMethod
プロパティを、開始インデックスと最大行数を入力パラメータとして受け取るメソッドに設定する。StartRowIndexParameterName
プロパティを、SelectMethod
メソッドの開始インデックスを受け取る整数型入力パラメータの名前に設定する。この値を省略すると、既定でstartRowIndex
が設定される。MaximumRowsParameterName
プロパティを、SelectMethod
メソッドの最大行数を受け取るの整数型入力パラメータの名前に設定する。この値を省略すると、既定でmaximumRows
が設定される。SelectCountMethod
プロパティを、ページング処理対象のレコードの合計数を返すメソッドに設定する。
これだけです。この設定が終わると、ObjectDataSourceはカスタムのページング処理機能を使うようになります。もちろん、ここでの山場は、データの正しいサブセットを賢く取得する基となるオブジェクトの作成です。しかし、そのオブジェクトを作成してしまえば、後はいくつかのプロパティを設定するだけです。
カスタムのページング処理をサポートするオブジェクトを作成する
ObjectDataSourceをGridViewにバインドするためには、まずObjectDataSourceが使う基となるオブジェクトが必要であり、このオブジェクトには、データの特定のサブセットにアクセスしてページング処理の対象となる行数を返すメソッドが必要です。Joseph Chancellorの記事『Using Strongly-Typed Data Access in Visual Studio 2005 and ASP.NET 2.0』とBrian Noyesの記事『Build a Data Access Layer with the Visual Studio 2005 DataSet Designer』で述べられているように、Visual Studio 2005ではObjectDataSourceに接続できるオブジェクトを簡単に作成できます。まず、これらのオブジェクトのメソッドから返される厳密に型指定されたDataSet(Strongly-typed DataSet)にデータを取り込む場合に使うストアドプロシージャ(またはSQLクエリ)を定義します。
本稿のサンプルファイルには、50,000人分の社員レコード(および、追加レコードをまとめて追加できる簡単な方法)から成るサンプルデータベースが収められています。このデータベースに、カスタムのページング処理の2つのデモで使う次の3つのストアドプロシージャが含まれています。
GetEmployeesSubset(@startRowIndex int, @maximumRows int)
GetEmployeesRowCount
GetEmployeesSubsetSorted(@sortExpression nvarchar(50), @startRowIndex int, @maximumRows int)
EmployeeID
順に並べ替えて、@startRowIndex
から始まる最大@maximumRows
個のレコードを「Employees」テーブルから返します。@sortExpression
)に基づいて並べ替えられた1ページ分のデータを返します。このストアドプロシージャでは、例えば給与順に並べ替えられた1ページ分のデータを返すことができます(GetEmployeesSubset
は常にEmployeeID
順に並べ替えられたレコードを返します)。カスタムのページング処理と並べ替えを併用するGridViewを作成する場合にはこの柔軟性が必要です。 これらのストアドプロシージャを作成した後、型指定されたDataSetをプロジェクト(Employees.xsd)に追加して、基となるオブジェクトを作成しました。次に、前述の各ストアドプロシージャに対して1つずつ、合計3つのメソッドを追加しました。これで、ObjectDataSourceのプロパティに接続できるGetEmployeesSubset(startRowIndex、maximumRows)
メソッドおよびGetEmployeesRowCount()
メソッドを持つEmployeesTableAdapter
オブジェクトが出来上がりました(型指定されたDataSetの作成手順については、『Using Strongly-Typed Data Access in Visual Studio 2005 and ASP.NET 2.0』とScott Guthrieのブログの『Building a DAL using Strongly Typed TableAdapters and DataTables in VS 2005 and ASP.NET 2.0』を参照してください)。