WCF サービス モデルを使用してSQL Serverでスカラー関数を呼び出す

  • [アーティクル]

WCF サービス モデルを使用して.NET アプリケーションで SQL アダプターを使用して、SQL Serverのスカラー関数を呼び出すことができます。 アダプターは、スカラー関数を、SQL Serverで直接呼び出すことができるメソッドとして公開します。 アダプターがスカラー関数をサポートする方法の詳細については、「SQL アダプターを使用したSQL Serverでのスカラー関数の実行」を参照してください。

このトピックでは、WCF サービス モデルを使用したスカラー関数の呼び出しについて説明する方法

このトピックでは、SQL Server データベースでGET_EMP_ID関数を呼び出す方法について説明します。 GET_EMP_ID関数は 、Employee テーブル内の従業員の指定を受け取り、対応する従業員 ID を返します。 GET_EMP_ID関数と Employee テーブルは、サンプルで提供されている SQL スクリプトを実行して作成されます。 詳細については、「 アダプターのサンプル」を参照してください。

このトピックで使用される例について

このトピックの例では、Employee テーブルで GET_EMP_ID スカラー関数を呼び出しました。 GET_EMP_ID関数と Employee テーブルは、サンプルで提供されている SQL スクリプトを実行して作成されます。 このトピックに基づくサンプル ScalarFunction_ServiceModelは、SQL アダプターのサンプルでも提供されています。 詳細については、「 アダプターのサンプル」を参照してください。

WCF クライアント クラス

SQL アダプターを使用してSQL Serverのスカラー関数を呼び出すための WCF クライアントの名前を次の表に示します。

SQL Server データベース成果物 WCF クライアント名
スカラー関数 ScalarFunctions_[SCHEMA]クライアント

[SCHEMA] = SQL Server成果物のコレクション (dbo など)。

スカラー関数を呼び出すためのメソッド シグネチャ

次の表は、テーブルに対する基本的な操作のメソッド シグネチャを示しています。 ビューのシグネチャは同じですが、ビューの名前空間と名前がテーブルの名前に置き換えられる点が除きます。

操作 メソッド シグネチャ
スカラー関数名 public <return_type><scalar_function_name>(param1, param2, ...)

<> retrun_type= 関数定義で定義されている戻り値の型

<> scalar_function_name= スカラー関数の名前。

例として、次のコードは、 dbo スキーマのGET_EMP_IDスカラー関数用に生成された WCF クライアント クラスのメソッド シグネチャを示しています。これは、従業員の指定をパラメーターとして受け取り、従業員 ID (整数) を返します。

public partial class ScalarFunctions_dboClient : System.ServiceModel.ClientBase<ScalarFunctions_dbo>, ScalarFunctions_dbo {      
    public System.Nullable<int> GET_EMP_ID(string emp_desig);  
}

このスニペットでは、 ScalarFunctions_dboClient は、アダプター サービス参照の追加プラグインによって生成された SqlAdapterBindingClient.cs の WCF クラスの名前です。

スカラー関数を呼び出すためのパラメーター

スカラー関数を呼び出すために SQL アダプターによって公開されるメソッドのパラメーターは、SQL Serverのスカラー関数定義で定義されているパラメーターと同じです。 たとえば、GET_EMP_IDスカラー関数を呼び出すためのパラメーターはemp_desigされ、従業員の指定を受け取ります。

ここでも、スカラー関数の戻り値は、SQL Serverのスカラー関数定義で定義されている戻り値と同じです。 たとえば、GET_EMP_ID関数の戻り値は、従業員の整数型の ID です。

スカラー関数を呼び出す WCF クライアントの作成

WCF クライアントを使用してSQL Serverに対して操作を実行するために必要な一連の一般的なアクションには、「SQL アダプターを使用した WCF サービス モデルの概要」で説明されている一連のタスクが含まれます。 このセクションでは、 GET_EMP_ID スカラー関数を呼び出す WCF クライアントを作成する方法について説明します。

WCF クライアントを作成するには

  1. Visual Studio で Visual C# プロジェクトを作成します。 このトピックでは、コンソール アプリケーションを作成します。

  2. GET_EMP_ID スカラー関数の WCF クライアント クラス を 生成します。 WCF クライアント クラスの生成の詳細については、「SQL Server Artifacts の WCF クライアントまたは WCF サービス コントラクトを生成する」を参照してください。

  3. ソリューション エクスプローラーで、 と Microsoft.ServiceModel.Channelsへの参照をMicrosoft.Adapters.Sql追加します。

  4. Program.cs を開き、次のスニペットで説明するようにクライアントを作成します。

    
          ScalarFunctions_dboClient client = new ScalarFunctions_dboClient("SqlAdapterBinding_ScalarFunctions_dbo");  
client.ClientCredentials.UserName.UserName = "<Enter user name here>";  
client.ClientCredentials.UserName.Password = "<Enter password here>";

    このスニペットでは、 ScalarFunctions_dboClient は SqlAdapterBindingClient.cs で定義されている WCF クライアントです。 このファイルは、アダプター サービス参照の追加プラグインによって生成されます。 SqlAdapterBinding_ScalarFunctions_dbo はクライアント エンドポイント構成の名前であり、app.config で定義されます。このファイルは、アダプター サービス参照プラグインの追加によっても生成され、バインド プロパティとその他の構成設定が含まれています。

    Note

    このスニペットでは、構成ファイルのバインドとエンドポイント アドレスを使用します。 これらの値をコードで明示的に指定することもできます。 クライアント バインドを指定するさまざまな方法の詳細については、「 SQL アダプターのクライアント バインドを構成する」を参照してください。

  5. 次のスニペットで説明されているように、クライアントを開きます。

    try  
{  
   Console.WriteLine("Opening Client...");  
   client.Open();  
}  
catch (Exception ex)  
{  
   Console.WriteLine("Exception: " + ex.Message);  
   throw;  
}

  6. GET_EMP_ID関数を呼び出して、"Manager" という指定の従業員の ID を取得します。

    Console.WriteLine("Invoking the GET_EMP_ID function");  
string emp_designation = "Manager";  
try  
{  
      System.Nullable<int> emp_id = client.GET_EMP_ID(emp_designation);  
      Console.WriteLine("The Employee ID for the employee with 'Manager' designation is:" + emp_id);  
}  
catch (Exception e)  
{  
      Console.WriteLine("Exception: " + e.Message);  
      throw;  
}

    Note

    わかりやすくするために、 Employee テーブルには "Manager" という指定を持つ従業員が 1 人しかありません。 ターゲット テーブルの従業員数が同じ場合は、それに応じて関数を定義する必要があります。

  7. 次のスニペットで説明されているように、クライアントを閉じます。

    client.Close();  
Console.WriteLine("Press any key to exit...");  
Console.ReadLine();

  8. プロジェクトをビルドし、実行します。 アプリケーションには、"Manager" という指定の従業員の従業員 ID が表示されます。

参照

WCF サービス モデルを使用してアプリケーションを開発する