方法 : 単一の値を返すストアド プロシージャを実行する
更新 : 2007 年 11 月
単一の値を返すストアド プロシージャを実行するには、ストアド プロシージャを実行するように設定されている TableAdapter クエリ (CustomersTableAdapter.CustomerCount() など) を実行できます。
アプリケーションで TableAdapter を使用していない場合は、コマンド オブジェクトの ExecuteScalar メソッドを呼び出し、そのメソッドの CommandType プロパティを StoredProcedure に設定します ("コマンド オブジェクト" は、アプリケーションで使用している .NET Framework データ プロバイダに固有のコマンドを表します。たとえば、アプリケーションで .NET Framework SQL Server 用データ プロバイダを使用している場合、コマンド オブジェクトは SqlCommand です)。
次の例では、TableAdapter またはコマンド オブジェクトのいずれかを使用してデータベースから単一の値を返すストアド プロシージャを実行する方法を示します。TableAdapter やコマンドを使用してクエリを実行する方法の詳細については、「データセットへの読み込みとデータのクエリの概要」を参照してください。
.gif "メモ") メモ : |
|---|
使用している設定またはエディションによっては、表示されるダイアログ ボックスやメニュー コマンドがヘルプに記載されている内容と異なる場合があります。設定を変更するには、[ツール] メニューの [設定のインポートとエクスポート] をクリックします。詳細については、「Visual Studio の設定」を参照してください。 |
TableAdapter を使用して単一の値を返すストアド プロシージャの実行
この例では TableAdapter クエリの構成ウィザードを使用して TableAdapter クエリを作成する方法を示した後、TableAdapter のインスタンスを宣言してクエリを実行する方法について説明します。
TableAdapter を使用して単一の値を返すストアド プロシージャを実行するには
データセット デザイナでデータセットを開きます。詳細については、「方法 : データセット デザイナでデータセットを開く」を参照してください。
TableAdapter がない場合は、TableAdapter を作成します。TableAdapter の作成方法の詳細については、「方法 : TableAdapter を作成する」を参照してください。
ストアド プロシージャを使用して単一の値を返すクエリが TableAdapter に既にある場合は、これ以降の手順をスキップし、「TableAdapter のインスタンスを宣言してクエリを実行するには」に進んでください。このクエリがない場合は、手順 4 から継続し、単一の値を返す新しいクエリを作成します。
目的の TableAdapter を右クリックし、ショートカット メニューを使用してクエリを追加します。
TableAdapter クエリの構成ウィザードが開きます。
[既存のストアド プロシージャを使用] を選択し、[次へ] をクリックします。
ドロップダウン リストからストアド プロシージャを選択し、[次へ] をクリックします。
[単一値] を返すオプションを選択し、[次へ] をクリックします。
クエリの名前を入力します。
[次へ] または [完了] をクリックして、ウィザードを完了します。クエリが TableAdapter に追加されます。
プロジェクトをビルドします。
TableAdapter のインスタンスを宣言してクエリを実行するには
実行するクエリが含まれた TableAdapter のインスタンスを宣言します。
デザイン時ツールを使用してインスタンスを作成するには、ツールボックスから目的の TableAdapter をドラッグします (プロジェクト内のコンポーネントは、ツールボックス内のプロジェクト名と同じ見出しの下に表示されています)。ツールボックスに TableAdapter が表示されない場合は、プロジェクトのビルドが必要になる場合があります。
または
コードでインスタンスを作成するには、次のコードを DataSet の名前と TableAdapter の名前に置き換えます。
Dim tableAdapter As New DataSetTableAdapters.TableAdapter
メモ :TableAdapter は、実際には関連するデータセット クラスの中に存在しません。各データセットは、対応する TableAdapter のコレクションを独自の名前空間内に保有しています。たとえば、SalesDataSet という名前のデータセットがある場合、その TableAdapter が格納された SalesDataSetTableAdapters 名前空間が存在します。
コード内の他のメソッドを呼び出すのと同じようにクエリを呼び出します。このクエリは、TableAdapter のメソッドです。次のコードを TableAdapter とクエリの名前に置き換えます。クエリに必要なすべてのパラメータも渡す必要があります。クエリにパラメータが必要かどうか不明な場合、または必要なパラメータが不明な場合は、IntelliSense でクエリに必要なシグネチャを確認します。クエリでパラメータを使用するかどうかに応じて、コードは次の例のいずれかのようになります。
TableAdapter.Query()
TableAdapter.Query(Parameters)
TableAdapter のインスタンスを宣言してクエリを実行する完全なコードは、次のようになります。
Dim tableAdapter As New NorthwindDataSetTableAdapters.CustomersTableAdapter() Dim returnValue As Integer returnValue = CType(tableAdapter.GetCustomerCount(), Integer)NorthwindDataSetTableAdapters.CustomersTableAdapter tableAdapter = new NorthwindDataSetTableAdapters.CustomersTableAdapter(); int returnValue = (int)tableAdapter.GetCustomerCount();
コマンド オブジェクトを使用して単一の値を返すストアド プロシージャの実行
次の例では、コマンドを作成し、単一の値を返すストアド プロシージャを実行する方法を示します。コマンドにパラメータ値を設定および取得する方法については、「方法 : コマンド オブジェクトのパラメータを設定および取得する」を参照してください。
この例では SqlCommand オブジェクトを使用します。次の要素が必要です。
System、System.Data、および System.Xml の各名前空間への参照。
SqlConnection1 という名前のデータ接続。
SqlConnection1 の接続先となるデータ ソースの Customers という名前のテーブル (これがない場合は、データ ソース用の有効な SQL ステートメントが必要です)。
DataCommand を使用して単一の値を返すストアド プロシージャを実行するには
コードを実行するメソッドに次のコードを追加します。このコマンド (たとえば、ExecuteScalar) の ExecuteScalar メソッドを呼び出すと、単一の値が返されます。データは、object に返されます。
Dim sqlConnection1 As New SqlConnection("Your Connection String") Dim cmd As New SqlCommand Dim returnValue As Object cmd.CommandText = "StoredProcedureName" cmd.CommandType = CommandType.StoredProcedure cmd.Connection = sqlConnection1 sqlConnection1.Open() returnValue = cmd.ExecuteScalar() sqlConnection1.Close()SqlConnection sqlConnection1 = new SqlConnection("Your Connection String"); SqlCommand cmd = new SqlCommand(); Object returnValue; cmd.CommandText = "StoredProcedureName"; cmd.CommandType = CommandType. StoredProcedure; cmd.Connection = sqlConnection1; sqlConnection1.Open(); returnValue = cmd.ExecuteScalar(); sqlConnection1.Close();
参照
処理手順
方法 : コマンド オブジェクトのパラメータを設定および取得する