WCF サービスモデルを使用して、厳密に型指定されたポーリングベースのデータ変更メッセージをSQL Serverから受信する

[アーティクル]
07/21/2023

SQL Serverから厳密に型指定されたポーリングメッセージを受信するように SQL アダプターを構成できます。データベースをポーリングするためにアダプターが実行するポーリングステートメントを指定できます。ポーリングステートメントには、結果セットを返す SELECT ステートメントまたはストアドプロシージャを指定できます。厳密に型指定された結果セットを受け取るシナリオでは、厳密に型指定されたポーリングを使用する必要があります。アダプターが厳密に型指定されたポーリングをサポートする方法の詳細については、「ポーリングを使用した受信呼び出しのサポート」を参照してください。

重要

1 つのアプリケーションで複数のポーリング操作を行う場合は、接続 URI の一部として InboundID 接続プロパティを指定して一意にする必要があります。指定した受信 ID が操作名前空間に追加され、一意になります。

このトピックでポーリングを示す方法

このトピックでは、SQL アダプターが厳密に型指定されたデータ変更メッセージの受信をサポートする方法を示すために、.NET アプリケーションを作成し、 TypedPolling 操作の WCF サービスコントラクトを生成します。 WCF サービスコントラクトの生成中に、次を指定してください。

接続 URI の一部として InboundID を指定する必要があります。
PollingStatement バインドプロパティのポーリングステートメントを指定する必要があります。

さらに、プロキシクラスの生成中に他のポーリング関連のバインドプロパティを指定する場合は、 PolledDataAvailableStatement を次のように指定します。

SELECT COUNT(*) FROM Employee

PolledDataAvailableStatement は、正の値を含む最初のセルを含む結果セットを返す必要があります。最初のセルに正の値が含まれていない場合、アダプターはポーリングステートメントを実行しません。

ポーリングステートメントの一部として、次の操作を実行します。

Employee テーブルからすべての行を選択します。
ストアドプロシージャ (MOVE_EMP_DATA) を実行して、すべてのレコードを Employee テーブルから EmployeeHistory テーブルに移動します。
ストアドプロシージャ (ADD_EMP_DETAILS) を実行して、Employee テーブルに新しいレコードを追加します。この手順では、従業員名、指定、給与をパラメーターとして受け取ります。

これらの操作を実行するには、WCF サービスコントラクトとヘルパークラスの生成時に 、PollingStatement バインディングプロパティに次を指定する必要があります。

SELECT * FROM Employee;EXEC MOVE_EMP_DATA;EXEC ADD_EMP_DETAILS John, Tester, 100000

ポーリングステートメントが実行されると、Employee テーブルのすべてのレコードが選択され、SQL Serverからのメッセージが受信されます。 MOVE_EMP_DATA ストアドプロシージャがアダプターによって実行されると、すべてのレコードが EmployeeHistory テーブルに移動されます。次に、ADD_EMP_DETAILS ストアドプロシージャが実行され、Employee テーブルに新しいレコードが追加されます。次のポーリング実行では、1 つのレコードのみが返されます。このサイクルは、サービスホストを閉じるまで続行されます。

SQL アダプターバインドプロパティを使用した型指定ポーリングの構成

次の表は、データ変更メッセージを受信するようにアダプターを構成するために使用する SQL アダプターバインドプロパティをまとめたものです。 PollingStatement バインドプロパティ以外に、このセクションに記載されている他のすべてのバインドプロパティは、.NET アプリケーションの実行中に必要です。 WCF サービスコントラクト TypedPolling 操作を生成する前に、PollingStatement バインドプロパティを指定する必要があります。

Binding プロパティ	説明
InboundOperationType	ポーリング、TypedPolling、または通知の受信操作を実行するかどうかを指定します。既定値はポーリングです。厳密に型指定されたポーリングメッセージを受信するには、これを TypedPolling に設定します。
PolledDataAvailableStatement	ポーリングに使用できるデータがあるかどうかを判断するためにアダプターが実行する SQL ステートメントを指定します。 SQL ステートメントは、行と列で構成される結果セットを返す必要があります。行が使用可能な場合にのみ、 PollingStatement バインドプロパティに指定された SQL ステートメントが実行されます。
PollingIntervalInSeconds	SQL アダプターが PolledDataAvailableStatement バインディングプロパティに指定されたステートメントを実行する間隔を秒単位で指定します。既定値は 30 秒です。ポーリング間隔は、連続するポーリング間の時間間隔を決定します。ステートメントが指定された期間内に実行された場合、アダプターはその間隔の残りの時間を待機します。
PollingStatement	SQL Server データベーステーブルをポーリングする SQL ステートメントを指定します。ポーリングステートメントには、単純な SELECT ステートメントまたはストアドプロシージャを指定できます。既定値は null です。ポーリングを有効にするには、 PollingStatement の値を指定する必要があります。ポーリングステートメントは、ポーリングに使用できるデータがある場合にのみ実行されます。これは、 PolledDataAvailableStatement バインドプロパティによって決定されます。セミコロンで区切られた任意の数の SQL ステートメントを指定できます。大事な：TypedPolling では、メタデータを生成する前に、このバインドプロパティを指定する必要があります。
PollWhileDataFound	ポーリング対象のテーブルでデータが使用可能な場合に、SQL アダプターがポーリング間隔を無視し、 PolledDataAvailableStatement バインディングプロパティに指定された SQL ステートメントを継続的に実行するかどうかを指定します。テーブルに使用可能なデータがない場合、アダプターは、指定されたポーリング間隔で SQL ステートメントを実行するように戻します。既定値は falseです。

これらのプロパティの詳細については、「BizTalk Adapter for SQL Server アダプターバインドプロパティ」を参照してください。 SQL アダプターを使用してSQL Serverをポーリングする方法の詳細については、詳細を参照してください。

WCF サービスモデルで厳密に型指定されたポーリングを構成する

WCF サービスモデルを使用するときに ポーリング 操作を受信するには、次の操作を行う必要があります。

アダプターによって公開されるメタデータから 、TypedPolling 操作の WCF サービスコントラクト (インターフェイス) を生成します。これを行うには、アダプターサービス参照 Visual Studio プラグインの追加を使用できます。この例の WCF サービスコントラクトを生成するときに、次のことを確認します。
- InboundID は Employee として指定します。
- PollingStatement バインドプロパティのポーリングステートメントを指定します。この例では、ポーリングステートメントを次のように指定します。
```
SELECT * FROM Employee;EXEC MOVE_EMP_DATA;EXEC ADD_EMP_DETAILS John, Tester, 100000
```
このインターフェイスから WCF サービスを実装します。
サービスホスト (System.ServiceModel.ServiceHost) を使用して、この WCF サービスをホストします。

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

このトピックの例では、Employee テーブルをポーリングします。この例では、MOVE_EMP_DATA ストアドプロシージャとストアドプロシージャADD_EMP_DETAILSも使用します。これらの成果物を生成するスクリプトは、サンプルと共に提供されます。サンプルの詳細については、「 SQL アダプターのサンプル」を参照してください。このトピックに基づくサンプル TypedPolling_ServiceModelは、SQL アダプターのサンプルでも提供されています。

WCF サービスコントラクトとクラス

アダプターサービス参照の追加プラグインを使用して、WCF サービスコントラクト (インターフェイス) と TypedPolling 操作のサポートクラスを作成できます。 WCF サービスコントラクトの生成の詳細については、「SQL Server Artifacts の WCF クライアントまたは WCF サービスコントラクトを生成する」を参照してください。

WCF サービスコントラクト (インターフェイス)

次のコードは、 TypedPolling 操作用に生成された WCF サービスコントラクト (インターフェイス) を示しています。

[System.CodeDom.Compiler.GeneratedCodeAttribute("System.ServiceModel", "3.0.0.0")]
[System.ServiceModel.ServiceContractAttribute(Namespace="http://schemas.microsoft.com/Sql/2008/05/", ConfigurationName="TypedPolling_Employee")]
public interface TypedPolling_Employee {

    // CODEGEN: Generating message contract since the wrapper namespace (https://schemas.microsoft.com/Sql/2008/05/TypedPolling/Employee) of message TypedPolling
    // does not match the default value (https://schemas.microsoft.com/Sql/2008/05/)
    [System.ServiceModel.OperationContractAttribute(IsOneWay=true, Action="TypedPolling")]
    void TypedPolling(TypedPolling request);
}

メッセージコントラクト

メッセージコントラクト名前空間は、接続 URI の InboundID パラメーター (指定されている場合) によって変更されます。この例では、受信 ID を Employee として指定しました。要求メッセージは、厳密に型指定された結果セットを返します。

[System.Diagnostics.DebuggerStepThroughAttribute()]
[System.CodeDom.Compiler.GeneratedCodeAttribute("System.ServiceModel", "3.0.0.0")]
[System.ServiceModel.MessageContractAttribute(WrapperName="TypedPolling", WrapperNamespace="http://schemas.microsoft.com/Sql/2008/05/TypedPolling/Employee", IsWrapped=true)]
public partial class TypedPolling {

[System.ServiceModel.MessageBodyMemberAttribute(Namespace="http://schemas.microsoft.com/Sql/2008/05/TypedPolling/Employee", Order=0)]
    public schemas.microsoft.com.Sql._2008._05.TypedPolling.Employee.TypedPollingResultSet0[] TypedPollingResultSet0;

[System.ServiceModel.MessageBodyMemberAttribute(Namespace="http://schemas.microsoft.com/Sql/2008/05/TypedPolling/Employee", Order=1)]
    public schemas.microsoft.com.Sql._2008._05.TypedPolling.Employee.TypedPollingResultSet1[] TypedPollingResultSet1;

    public TypedPolling() {
    }

    public TypedPolling(schemas.microsoft.com.Sql._2008._05.TypedPolling.Employee.TypedPollingResultSet0[] TypedPollingResultSet0, schemas.microsoft.com.Sql._2008._05.TypedPolling.Employee.TypedPollingResultSet1[] TypedPollingResultSet1) {
        this.TypedPollingResultSet0 = TypedPollingResultSet0;
        this.TypedPollingResultSet1 = TypedPollingResultSet1;
    }
}

WCF サービスクラス

アダプターサービス参照の追加プラグインは、サービスコントラクト (インターフェイス) から実装された WCF サービスクラスのスタブを持つファイルも生成します。ファイルの名前は SqlAdapterBindingService.cs です。 TypedPolling 操作を処理するロジックをこのクラスに直接挿入できます。次のコードは、アダプターサービス参照プラグインの追加によって生成される WCF サービスクラスを示しています。

namespace SqlAdapterBindingNamespace {

    public class SqlAdapterBindingService : TypedPolling_Employee {

        // CODEGEN: Generating message contract since the wrapper namespace (https://schemas.microsoft.com/Sql/2008/05/TypedPolling/Employee) of message TypedPolling
        // does not match the default value (https://schemas.microsoft.com/Sql/2008/05/)
        public virtual void TypedPolling(TypedPolling request) {
            throw new System.NotImplementedException("The method or operation is not implemented.");
        }
    }
}

ポーリング操作のために厳密に型指定された受信メッセージを受信する

このセクションでは、SQL アダプターを使用して厳密に型指定された受信ポーリングメッセージを受信する .NET アプリケーションを記述する方法について説明します。

アダプターサービス参照の追加プラグインを使用して、 TypedPolling 操作の WCF サービスコントラクト (インターフェイス) とヘルパークラスを生成します。この例の WCF サービスコントラクトの生成中に、次を指定してください。
- InboundID を Employee として指定する必要があります。
- PollingStatement バインドプロパティのポーリングステートメントを指定する必要があります。この例では、ポーリングステートメントを次のように指定します。
```
SELECT * FROM Employee;EXEC MOVE_EMP_DATA;EXEC ADD_EMP_DETAILS John, Tester, 100000
```
  詳細については、「 Generate a WCF Client or WCF Service Contract for SQL Server Artifacts」を参照してください。必要に応じて、サービスコントラクトとヘルパークラスの生成中にバインドプロパティを指定できます。これにより、生成された構成ファイルに正しく設定されます。

手順 1 で生成されたインターフェイスクラスとヘルパークラスから WCF サービスを実装します。このクラスの TypedPolling メソッドは、 TypedPolling 操作から受信したデータの処理でエラーが発生した場合に、ポーリングトランザクションを中止するために例外をスローできます。それ以外の場合、メソッドは何も返しません。 WCF サービスクラスを次のように属性化する必要があります。

[ServiceBehavior(InstanceContextMode = InstanceContextMode.Single)]

TypedPolling メソッド内では、アプリケーションロジックを直接実装できます。このクラスは、SqlAdapterBindingService.cs にあります。この例のこのコードは、 SqlAdapterBindingService クラスを サブクラスします。このコードでは、厳密に型指定された結果セットとして受信したポーリングメッセージがコンソールに書き込まれます。

[ServiceBehavior(InstanceContextMode = InstanceContextMode.Single)]

public class PollingService : SqlAdapterBindingNamespace.SqlAdapterBindingService
{
    public override void TypedPolling(TypedPolling request)
    {
        Console.WriteLine("\nNew Polling Records Received");
        Console.WriteLine("*************************************************");
        Console.WriteLine("Employee ID\tName\tDesignation\tSalary");

        for (int i = 0; i < request.TypedPollingResultSet0.Length; i++)
        {
            Console.WriteLine("{0}\t{1}\t{2}\t{3}",
            request.TypedPollingResultSet0[i].Employee_ID,
            request.TypedPollingResultSet0[i].Name,
            request.TypedPollingResultSet0[i].Designation,
            request.TypedPollingResultSet0[i].Salary);
        }
        Console.WriteLine("*************************************************");
        Console.WriteLine("\nHit <RETURN> to stop polling");
    }
}

SQL アダプターは接続 URI の一部として資格情報を受け入れないので、SQL Server データベースの資格情報を渡すには、次のクラスを実装する必要があります。アプリケーションの後者の部分では、このクラスをインスタンス化して、SQL Server資格情報を渡します。

class PollingCredentials : ClientCredentials, IServiceBehavior
{
    public void AddBindingParameters(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase, Collection<ServiceEndpoint> endpoints, BindingParameterCollection bindingParameters)
    {
        bindingParameters.Add(this);
    }

    public void ApplyDispatchBehavior(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase)
    { }

    public void Validate(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase)
    { }

    protected override ClientCredentials CloneCore()
    {
        ClientCredentials clone = new PollingCredentials();
        clone.UserName.UserName = this.UserName.UserName;
        clone.UserName.Password = this.UserName.Password;
        return clone;
    }
}

SqlAdapterBinding を作成し、バインドプロパティを指定してポーリング操作を構成します。これは、コード内で明示的に行うか、構成で宣言的に行うことができます。少なくとも、 InboundOperationType、 PolledDataAvailableStatement、および PollingStatement を指定する必要があります。
```
SqlAdapterBinding binding = new SqlAdapterBinding();
binding.InboundOperationType = InboundOperation.TypedPolling;
binding.PolledDataAvailableStatement = "SELECT COUNT (*) FROM EMPLOYEE";
binding.PollingStatement = "SELECT * FROM Employee;EXEC MOVE_EMP_DATA;EXEC ADD_EMP_DETAILS John, Tester, 100000";
```

手順 3 で作成SQL Server PollingCredentials クラスをインスタンス化して、データベース資格情報を指定します。

PollingCredentials credentials = new PollingCredentials();
credentials.UserName.UserName = "<Enter user name here>";
credentials.UserName.Password = "<Enter password here>";

手順 2 で作成した WCF サービスのインスタンスを作成します。
```
// create service instance
PollingService service = new PollingService();
```
WCF サービスとベース接続 URI を使用して 、System.ServiceModel.ServiceHost のインスタンスを作成します。ベース接続 URI に受信 ID を含めることはできません。ここで資格情報も指定する必要があります。
```
// Enable service host
Uri[] baseUri = new Uri[] { new Uri("mssql://mysqlserver//mydatabase") };
ServiceHost serviceHost = new ServiceHost(service, baseUri);
serviceHost.Description.Behaviors.Add(credentials);
```
サービスエンドポイントをサービスホストに追加します。これを行うには、次の手順を実行します。
- 手順 4 で作成したバインディングを使用します。
- 資格情報と必要に応じて受信 ID を含む接続 URI を指定します。
- コントラクトを "TypedPolling_Employee" として指定します。
```
// Add service endpoint: be sure to specify TypedPolling_Employee as the contract
Uri ConnectionUri = new Uri("mssql://mysqlserver//mydatabase?InboundID=Employee");
serviceHost.AddServiceEndpoint("TypedPolling_Employee", binding, ConnectionUri);
```
ポーリングデータを受信するには、サービスホストを開きます。アダプターは、クエリが結果セットを返すたびにデータを返します。
```
// Open the service host to begin polling
serviceHost.Open();
```
ポーリングを終了するには、サービスホストを閉じます。

重要

アダプターは、サービスホストが閉じられるまでポーリングを続行します。
```
serviceHost.Close();
```

例

次の例は、Employee テーブルを実行するポーリングクエリを示しています。ポーリングステートメントは、次のタスクを実行します。

Employee テーブルからすべてのレコードを選択します。
MOVE_EMP_DATA ストアドプロシージャを実行して、すべてのレコードを Employee テーブルから EmployeeHistory テーブルに移動します。
ADD_EMP_DETAILS ストアドプロシージャを実行して、Employee テーブルに 1 つのレコードを追加します。

最初のポーリングメッセージには、Employee テーブルのすべてのレコードが含まれます。後続のポーリングメッセージには、ADD_EMP_DETAILS ストアドプロシージャによって挿入された最後のレコードのみが含まれます。を押 <RETURN>してサービスホストを閉じるまで、アダプターはポーリングを続行します。

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

using Microsoft.Adapters.Sql;
using Microsoft.ServiceModel.Channels;
using System.ServiceModel;
using System.ServiceModel.Description;
using System.ServiceModel.Channels;
using System.Collections.ObjectModel;

namespace TypedPolling_ServiceModel
{
    [ServiceBehavior(InstanceContextMode = InstanceContextMode.Single)]

    public class PollingService : SqlAdapterBindingNamespace.SqlAdapterBindingService
    {
        public override void TypedPolling(TypedPolling request)
        {
            Console.WriteLine("\nNew Polling Records Received");
            Console.WriteLine("*************************************************");
            Console.WriteLine("Employee ID\tName\tDesignation\tSalary");

            for (int i = 0; i < request.TypedPollingResultSet0.Length; i++)
            {
                Console.WriteLine("{0}\t{1}\t{2}\t{3}",
                request.TypedPollingResultSet0[i].Employee_ID,
                request.TypedPollingResultSet0[i].Name,
                request.TypedPollingResultSet0[i].Designation,
                request.TypedPollingResultSet0[i].Salary);
            }
            Console.WriteLine("*************************************************");
            Console.WriteLine("\nHit <RETURN> to stop polling");
        }
    }

    class PollingCredentials : ClientCredentials, IServiceBehavior
    {
        public void AddBindingParameters(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase, Collection<ServiceEndpoint> endpoints, BindingParameterCollection bindingParameters)
        {
            bindingParameters.Add(this);
        }

        public void ApplyDispatchBehavior(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase)
        { }

        public void Validate(ServiceDescription serviceDescription, ServiceHostBase serviceHostBase)
        { }

        protected override ClientCredentials CloneCore()
        {
            ClientCredentials clone = new PollingCredentials();
            clone.UserName.UserName = this.UserName.UserName;
            clone.UserName.Password = this.UserName.Password;
            return clone;
        }
    }

    class Program
    {
        static void Main(string[] args)
        {
            ServiceHost serviceHost = null;
            try
            {
                Console.WriteLine("Sample started...");
                Console.WriteLine("Press any key to start polling...");
                Console.ReadLine();

                SqlAdapterBinding binding = new SqlAdapterBinding();
                binding.InboundOperationType = InboundOperation.TypedPolling;
                binding.PolledDataAvailableStatement = "SELECT COUNT (*) FROM EMPLOYEE";
                binding.PollingStatement = "SELECT * FROM Employee;EXEC MOVE_EMP_DATA;EXEC ADD_EMP_DETAILS John, Tester, 100000";
                Console.WriteLine("Binding properties assigned...");

                // This URI is used to specify the address for the ServiceEndpoint
                // It must contain the InboundId that was used to generate
                // the WCF service callback interface
                Uri ConnectionUri = new Uri("mssql://mysqlserver//mydatabase?InboundId=Employee");

                // This URI is used to initialize the ServiceHost. It cannot contain
                // the InboundID; otherwise,an exception is thrown when
                // the ServiceHost is initialized.
                Uri[] baseUri = new Uri[] { new Uri("mssql://mysqlserver//mydatabase") };

                PollingCredentials credentials = new PollingCredentials();
                credentials.UserName.UserName = "<Enter user name here>";
                credentials.UserName.Password = "<Enter password here>";

                Console.WriteLine("Opening service host...");
                PollingService service = new PollingService();
                serviceHost = new ServiceHost(service, baseUri);
                serviceHost.Description.Behaviors.Add(credentials);
                serviceHost.AddServiceEndpoint("TypedPolling_Employee", binding, ConnectionUri);
                serviceHost.Open();
                Console.WriteLine("Service host opened...");
                Console.WriteLine("Polling started...");
                Console.ReadLine();
            }
            catch (Exception e)
            {
                Console.WriteLine("Exception :" + e.Message);
                Console.ReadLine();

                /* If there is an error it will be specified in the inner exception */
                if (e.InnerException != null)
                {
                    Console.WriteLine("InnerException: " + e.InnerException.Message);
                    Console.ReadLine();
                }
            }
            finally
            {
                // IMPORTANT: you must close the ServiceHost to stop polling
                if (serviceHost.State == CommunicationState.Opened)
                    serviceHost.Close();
                else
                    serviceHost.Abort();
            }
        }
    }
}

参照

WCF サービスモデルで SQL アダプターを使用してSQL Serverポーリングする

次の方法で共有

WCF サービスモデルを使用して、厳密に型指定されたポーリングベースのデータ変更メッセージをSQL Serverから受信する

このトピックでポーリングを示す方法

SQL アダプターバインドプロパティを使用した型指定ポーリングの構成

WCF サービスモデルで厳密に型指定されたポーリングを構成する

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

WCF サービスコントラクトとクラス

WCF サービスコントラクト (インターフェイス)

メッセージコントラクト

WCF サービスクラス

ポーリング操作のために厳密に型指定された受信メッセージを受信する

例

参照

フィードバック

その他のリソース

次の方法で共有

WCF サービス モデルを使用して、厳密に型指定されたポーリング ベースのデータ変更メッセージをSQL Serverから受信する

このトピックでポーリングを示す方法

SQL アダプター バインド プロパティを使用した型指定ポーリングの構成

WCF サービス モデルで厳密に型指定されたポーリングを構成する

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

WCF サービス コントラクトとクラス

WCF サービス コントラクト (インターフェイス)

メッセージ コントラクト

WCF サービス クラス

ポーリング操作のために厳密に型指定された受信メッセージを受信する

例

参照

フィードバック

その他のリソース

WCF サービスモデルを使用して、厳密に型指定されたポーリングベースのデータ変更メッセージをSQL Serverから受信する

SQL アダプターバインドプロパティを使用した型指定ポーリングの構成

WCF サービスモデルで厳密に型指定されたポーリングを構成する

WCF サービスコントラクトとクラス

WCF サービスコントラクト (インターフェイス)

メッセージコントラクト

WCF サービスクラス