[アーティクル]
04/01/2012

マージアーティクルにビジネスロジックハンドラを実装する方法 (RMO プログラミング)

Microsoft.SqlServer.Replication.BusinessLogicSupport 名前空間に実装されているインターフェイスを使用すると、マージレプリケーションの同期処理で発生したイベントを処理するためのカスタムビジネスロジックを作成できます。ビジネスロジックハンドラのメソッドは、同期中にレプリケートされる変更行ごとに、レプリケーション処理から呼び出すことができます。

ビジネスロジックハンドラを実装するための一般的な手順を次に示します。

ビジネスロジックハンドラのアセンブリを作成します。
ディストリビュータにアセンブリを登録します。
マージエージェントが実行されるサーバーにアセンブリを配置します。プルサブスクリプションの場合、エージェントはサブスクライバ上で実行されます。プッシュサブスクリプションの場合、エージェントはディストリビュータ上で実行されます。Web 同期を使用した場合、エージェントは Web サーバー上で実行されます。
ビジネスロジックハンドラを使用するアーティクルを作成するか、ビジネスロジックハンドラを使用するように既存のアーティクルを変更します。

指定するビジネスロジックハンドラは、同期されるすべての行に対して実行されます。その他のアプリケーションまたはネットワークサービスに対する複雑なロジックおよび呼び出しは、パフォーマンスに影響を与える可能性があります。ビジネスロジックハンドラの詳細については、「マージ同期中のビジネスロジックの実行」を参照してください。

ビジネスロジックハンドラを作成するには

Microsoft Visual Studio で、.NET アセンブリの新しいプロジェクトを作成し、ビジネスロジックハンドラの実装コードを記述します。

次の名前空間の参照をプロジェクトに追加します。

アセンブリ参照	場所
Microsoft.SqlServer.Replication.BusinessLogicSupport	C:\Program Files\Microsoft SQL Server\100\COM (既定インストール)
System.Data	GAC (.NET Framework のコンポーネント)
System.Data.Common	GAC (.NET Framework のコンポーネント)

BusinessLogicModule クラスをオーバーライドするクラスを追加します。
処理対象の変更の種類を指定する HandledChangeStates プロパティを実装します。

BusinessLogicModule クラスのメソッドのうち、次のいずれかまたは複数のメソッドをオーバーライドします。

CommitHandler - 同期中、データ変更がコミットされたときに呼び出されます。
DeleteErrorHandler - DELETE ステートメントのアップロードまたはダウンロード時、エラーが発生した場合に呼び出されます。
DeleteHandler - DELETE ステートメントをアップロードまたはダウンロードするときに呼び出されます。
InsertErrorHandler - INSERT ステートメントのアップロードまたはダウンロード時、エラーが発生した場合に呼び出されます。
InsertHandler - INSERT ステートメントをアップロードまたはダウンロードするときに呼び出されます。
UpdateConflictsHandler - パブリッシャおよびサブスクライバで、UPDATE ステートメントの競合が発生した場合に呼び出されます。
UpdateDeleteConflictHandler - パブリッシャおよびサブスクライバで、UPDATE ステートメントと DELETE ステートメントが競合した場合に呼び出されます。
UpdateErrorHandler - UPDATE ステートメントのアップロードまたはダウンロード時、エラーが発生した場合に呼び出されます。
UpdateHandler - UPDATE ステートメントをアップロードまたはダウンロードするときに呼び出されます。

注
アーティクル競合時の処理がカスタムビジネスロジックによって明示的に定義されていない場合は、アーティクルの既定の競合回避モジュールによって処理されます。

プロジェクトをビルドして、ビジネスロジックハンドラアセンブリを作成します。

ビジネスロジックハンドラを登録するには

ServerConnection クラスを使用して、ディストリビュータへの接続を作成します。
ReplicationServer クラスのインスタンスを作成します。手順 1. の ServerConnection を渡します。
EnumBusinessLogicHandlers を呼び出し、返された ArrayList オブジェクトをチェックして、そのアセンブリがビジネスロジックハンドラとしてまだ登録されていないことを確認します。
BusinessLogicHandler クラスのインスタンスを作成します。次のプロパティを指定します。
- DotNetAssemblyName - .NET アセンブリの名前です。マージエージェントの実行可能ファイルがあるディレクトリ、マージエージェントを同期的に起動するアプリケーションがあるディレクトリ、および GAC の、いずれとも異なる場所にアセンブリが配置されている場合は、アセンブリ名に完全パスを含める必要があります。ビジネスロジックハンドラを Web 同期で使用する場合は、アセンブリ名に完全パスを含める必要があります。
- DotNetClassName - BusinessLogicModule をオーバーライドし、ビジネスロジックハンドラを実装するクラスの完全修飾名です。
- FriendlyName - ビジネスロジックハンドラへのアクセス時に使用する表示名です。
- IsDotNetAssembly - true を指定します。

ビジネスロジックハンドラを配置するには

マージエージェントが実行されるサーバーにアセンブリを配置します。格納場所は、ディストリビュータにビジネスロジックハンドラを登録したときに指定した場所になります。プルサブスクリプションの場合、エージェントはサブスクライバ上で実行されます。プッシュサブスクリプションの場合、エージェントはディストリビュータ上で実行されます。Web 同期を使用した場合、エージェントは Web サーバー上で実行されます。ビジネスロジックハンドラの登録時、アセンブリ名に完全パスを含めなかった場合は、マージエージェントの実行可能ファイルがあるディレクトリ (マージエージェントを同期的に起動するアプリケーションがあるディレクトリ) にアセンブリを配置してください。同じアセンブリを使用するアプリケーションが複数存在する場合は、アセンブリを GAC にインストールする必要があります。

新しいテーブルアーティクルでビジネスロジックハンドラを使用するには

ServerConnection クラスを使用して、パブリッシャへの接続を作成します。
MergeArticle クラスのインスタンスを作成します。次のプロパティを設定します。
- Name にアーティクル名を指定します。
- PublicationName にパブリケーション名を指定します。
- DatabaseName にパブリケーションデータベース名を指定します。
- ArticleResolver にビジネスロジックハンドラの表示名 (FriendlyName) を指定します。
Create メソッドを呼び出します。詳細については、「アーティクルを定義する方法 (RMO プログラミング)」を参照してください。

既存のテーブルアーティクルでビジネスロジックハンドラを使用するには

ServerConnection クラスを使用して、パブリッシャへの接続を作成します。
MergeArticle クラスのインスタンスを作成します。
Name、PublicationName、DatabaseName の各プロパティを設定します。
手順 1. で作成した接続を ConnectionContext プロパティに設定します。
LoadProperties メソッドを呼び出して、オブジェクトのプロパティを取得します。このメソッドから false が返された場合、手順 3. で指定したアーティクルのプロパティが正しく定義されていないか、アーティクルが存在していません。詳細については、「アーティクルのプロパティを表示および変更する方法 (RMO プログラミング)」を参照してください。
ArticleResolver にビジネスロジックハンドラの表示名を設定します。これは、ビジネスロジックハンドラの登録時に指定した FriendlyName プロパティの値になります。

使用例

次のビジネスロジックハンドラの例では、サブスクライバでの挿入、更新、および削除に関する情報をログに記録します。

using System;
using System.Text;
using System.Data;
using System.Data.Common;
using Microsoft.SqlServer.Replication.BusinessLogicSupport;
using Microsoft.Samples.SqlServer.BusinessLogicHandler;

namespace Microsoft.Samples.SqlServer.BusinessLogicHandler
{
    public class OrderEntryBusinessLogicHandler :
      Microsoft.SqlServer.Replication.BusinessLogicSupport.BusinessLogicModule
    {
        // Variables to hold server names.
        private string publisherName;
        private string subscriberName;

        public OrderEntryBusinessLogicHandler()
        {
        }

        // Implement the Initialize method to get publication 
        // and subscription information.
        public override void Initialize(
            string publisher,
            string subscriber,
            string distributor,
            string publisherDB,
            string subscriberDB,
            string articleName)
        {
            // Set the Publisher and Subscriber names.
            publisherName = publisher;
            subscriberName = subscriber;
        }

        // Declare what types of row changes, conflicts, or errors to handle.
        override public ChangeStates HandledChangeStates
        {
            get
            {
                // Handle Subscriber inserts, updates and deletes.
                return ChangeStates.SubscriberInserts |
                  ChangeStates.SubscriberUpdates | ChangeStates.SubscriberDeletes;
            }
        }

        public override ActionOnDataChange InsertHandler(SourceIdentifier insertSource,
          DataSet insertedDataSet, ref DataSet customDataSet, ref int historyLogLevel,
          ref string historyLogMessage)
        {
            if (insertSource == SourceIdentifier.SourceIsSubscriber)
            {
                // Build a line item in the audit message to log the Subscriber insert.
                StringBuilder AuditMessage = new StringBuilder();
                AuditMessage.Append(String.Format("A new order was entered at {0}. " +
                  "The SalesOrderID for the order is :", subscriberName));
                AuditMessage.Append(insertedDataSet.Tables[0].Rows[0]["SalesOrderID"].ToString());
                AuditMessage.Append("The order must be shipped by :");
                AuditMessage.Append(insertedDataSet.Tables[0].Rows[0]["DueDate"].ToString());

                // Set the reference parameter to write the line to the log file.
                historyLogMessage = AuditMessage.ToString();
                
                // Set the history log level to the default verbose level.
                historyLogLevel = 1;

                // Accept the inserted data in the Subscriber's data set and 
                // apply it to the Publisher.
                return ActionOnDataChange.AcceptData;
            }
            else
            {
                return base.InsertHandler(insertSource, insertedDataSet, ref customDataSet,
                  ref historyLogLevel, ref historyLogMessage);
            }
        }

        public override ActionOnDataChange UpdateHandler(SourceIdentifier updateSource,
          DataSet updatedDataSet, ref DataSet customDataSet, ref int historyLogLevel,
          ref string historyLogMessage)
        {
            if (updateSource == SourceIdentifier.SourceIsPublisher)
            {
                // Build a line item in the audit message to log the Subscriber update.
                StringBuilder AuditMessage = new StringBuilder();
                AuditMessage.Append(String.Format("An existing order was updated at {0}. " +
                  "The SalesOrderID for the order is ", subscriberName));
                AuditMessage.Append(updatedDataSet.Tables[0].Rows[0]["SalesOrderID"].ToString());
                AuditMessage.Append("The order must now be shipped by :");
                AuditMessage.Append(updatedDataSet.Tables[0].Rows[0]["DueDate"].ToString());

                // Set the reference parameter to write the line to the log file.
                historyLogMessage = AuditMessage.ToString();
                // Set the history log level to the default verbose level.
                historyLogLevel = 1;

                // Accept the updated data in the Subscriber's data set and apply it to the Publisher.
                return ActionOnDataChange.AcceptData;
            }
            else
            {
                return base.UpdateHandler(updateSource, updatedDataSet,
                  ref customDataSet, ref historyLogLevel, ref historyLogMessage);
            }
        }

        public override ActionOnDataDelete DeleteHandler(SourceIdentifier deleteSource,
          DataSet deletedDataSet, ref int historyLogLevel, ref string historyLogMessage)
        {
            if (deleteSource == SourceIdentifier.SourceIsSubscriber)
            {
                // Build a line item in the audit message to log the Subscriber deletes.
                // Note that the rowguid is the only information that is 
                // available in the dataset.
                StringBuilder AuditMessage = new StringBuilder();
                AuditMessage.Append(String.Format("An existing order was deleted at {0}. " +
                  "The rowguid for the order is ", subscriberName));
                AuditMessage.Append(deletedDataSet.Tables[0].Rows[0]["rowguid"].ToString());

                // Set the reference parameter to write the line to the log file.
                historyLogMessage = AuditMessage.ToString();
                // Set the history log level to the default verbose level.
                historyLogLevel = 1;

                // Accept the delete and apply it to the Publisher.
                return ActionOnDataDelete.AcceptDelete;
            }
            else
            {
                return base.DeleteHandler(deleteSource, deletedDataSet,
                  ref historyLogLevel, ref historyLogMessage);
            }
        }
    }
}

Imports System
Imports System.Text
Imports System.Data
Imports System.Data.Common
Imports Microsoft.SqlServer.Replication.BusinessLogicSupport

Namespace Microsoft.Samples.SqlServer.BusinessLogicHandler
    Public Class OrderEntryBusinessLogicHandler
        Inherits BusinessLogicModule

        ' Variables to hold server names.
        Private publisherName As String
        Private subscriberName As String

        ' Implement the Initialize method to get publication 
        ' and subscription information.
        Public Overrides Sub Initialize( _
        ByVal publisher As String, _
        ByVal subscriber As String, _
        ByVal distributor As String, _
        ByVal publisherDB As String, _
        ByVal subscriberDB As String, _
        ByVal articleName As String _
      )
            ' Set the Publisher and Subscriber names.
            publisherName = publisher
            subscriberName = subscriber
        End Sub

        ' Declare what types of row changes, conflicts, or errors to handle.
        Public Overrides ReadOnly Property HandledChangeStates() As ChangeStates
            Get
                ' Handle Subscriber inserts, updates and deletes.
                Return (ChangeStates.SubscriberInserts Or _
                 ChangeStates.SubscriberUpdates Or ChangeStates.SubscriberDeletes)
            End Get
        End Property

        Public Overrides Function InsertHandler(ByVal insertSource As SourceIdentifier, _
        ByVal insertedDataSet As DataSet, ByRef customDataSet As DataSet, _
        ByRef historyLogLevel As Integer, ByRef historyLogMessage As String) _
        As ActionOnDataChange

            If insertSource = SourceIdentifier.SourceIsSubscriber Then
                ' Build a line item in the audit message to log the Subscriber insert.
                Dim AuditMessage As StringBuilder = New StringBuilder()
                AuditMessage.Append(String.Format("A new order was entered at {0}. " + _
                 "The SalesOrderID for the order is :", subscriberName))
                AuditMessage.Append(insertedDataSet.Tables(0).Rows(0)("SalesOrderID").ToString())
                AuditMessage.Append("The order must be shipped by :")
                AuditMessage.Append(insertedDataSet.Tables(0).Rows(0)("DueDate").ToString())

                ' Set the reference parameter to write the line to the log file.
                historyLogMessage = AuditMessage.ToString()

                ' Set the history log level to the default verbose level.
                historyLogLevel = 1

                ' Accept the inserted data in the Subscriber's data set and 
                ' apply it to the Publisher.
                Return ActionOnDataChange.AcceptData
            Else
                Return MyBase.InsertHandler(insertSource, insertedDataSet, customDataSet, _
                 historyLogLevel, historyLogMessage)
            End If
        End Function
        Public Overrides Function UpdateHandler(ByVal updateSource As SourceIdentifier, _
        ByVal updatedDataSet As DataSet, ByRef customDataSet As DataSet, _
        ByRef historyLogLevel As Integer, ByRef historyLogMessage As String) _
        As ActionOnDataChange

            If updateSource = SourceIdentifier.SourceIsPublisher Then
                ' Build a line item in the audit message to log the Subscriber update.
                Dim AuditMessage As StringBuilder = New StringBuilder()
                AuditMessage.Append(String.Format("An existing order was updated at {0}. " + _
                 "The SalesOrderID for the order is ", subscriberName))
                AuditMessage.Append(updatedDataSet.Tables(0).Rows(0)("SalesOrderID").ToString())
                AuditMessage.Append("The order must now be shipped by :")
                AuditMessage.Append(updatedDataSet.Tables(0).Rows(0)("DueDate").ToString())

                ' Set the reference parameter to write the line to the log file.
                historyLogMessage = AuditMessage.ToString()
                ' Set the history log level to the default verbose level.
                historyLogLevel = 1

                ' Accept the updated data in the Subscriber's data set and apply it to the Publisher.
                Return ActionOnDataChange.AcceptData
            Else
                Return MyBase.UpdateHandler(updateSource, updatedDataSet, _
                 customDataSet, historyLogLevel, historyLogMessage)
            End If
        End Function
        Public Overrides Function DeleteHandler(ByVal deleteSource As SourceIdentifier, _
        ByVal deletedDataSet As DataSet, ByRef historyLogLevel As Integer, _
         ByRef historyLogMessage As String) As ActionOnDataDelete
            If deleteSource = SourceIdentifier.SourceIsSubscriber Then
                ' Build a line item in the audit message to log the Subscriber deletes.
                ' Note that the rowguid is the only information that is 
                ' available in the dataset.
                Dim AuditMessage As StringBuilder = New StringBuilder()
                AuditMessage.Append(String.Format("An existing order was deleted at {0}. " + _
                 "The rowguid for the order is ", subscriberName))
                AuditMessage.Append(deletedDataSet.Tables(0).Rows(0)("rowguid").ToString())

                ' Set the reference parameter to write the line to the log file.
                historyLogMessage = AuditMessage.ToString()
                ' Set the history log level to the default verbose level.
                historyLogLevel = 1

                ' Accept the delete and apply it to the Publisher.
                Return ActionOnDataDelete.AcceptDelete
            Else
                Return MyBase.DeleteHandler(deleteSource, deletedDataSet, _
                 historyLogLevel, historyLogMessage)
            End If
        End Function
    End Class
End Namespace

次の例では、ディストリビュータにビジネスロジックハンドラを登録します。

           // Specify the Distributor name and business logic properties.
            string distributorName = publisherInstance;
            string assemblyName = @"C:\Program Files\Microsoft SQL Server\100\COM\CustomLogic.dll";
            string className = "Microsoft.Samples.SqlServer.BusinessLogicHandler.OrderEntryBusinessLogicHandler";
            string friendlyName = "OrderEntryLogic";

            ReplicationServer distributor;
            BusinessLogicHandler customLogic;

                // Create a connection to the Distributor.
            ServerConnection distributorConn = new ServerConnection(distributorName);

            try
            {
                // Connect to the Distributor.
                distributorConn.Connect();

                // Set the Distributor properties.
                distributor = new ReplicationServer(distributorConn);

                // Set the business logic handler properties.
                customLogic = new BusinessLogicHandler();
                customLogic.DotNetAssemblyName = assemblyName;
                customLogic.DotNetClassName = className;
                customLogic.FriendlyName = friendlyName;
                customLogic.IsDotNetAssembly = true;

                Boolean isRegistered = false;

                // Check if the business logic handler is already registered at the Distributor.
                foreach (BusinessLogicHandler registeredLogic
                    in distributor.EnumBusinessLogicHandlers())
                {
                    if (registeredLogic == customLogic)
                    {
                        isRegistered = true;
                    }
                }

                // Register the custom logic.
                if (!isRegistered)
                {
                    distributor.RegisterBusinessLogicHandler(customLogic);
                }
            }
            catch (Exception ex)
            {
                // Do error handling here.
                throw new ApplicationException(string.Format(
                    "The {0} assembly could not be registered.",
                    assemblyName), ex);
            }
            finally
            {
                distributorConn.Disconnect();
            }

' Specify the Distributor name and business logic properties.
Dim distributorName As String = publisherInstance
Dim assemblyName As String = "C:\Program Files\Microsoft SQL Server\100\COM\CustomLogic.dll"
Dim className As String = "Microsoft.Samples.SqlServer.BusinessLogicHandler.OrderEntryBusinessLogicHandler"
Dim friendlyName As String = "OrderEntryLogic"

Dim distributor As ReplicationServer
Dim customLogic As BusinessLogicHandler

' Create a connection to the Distributor.
Dim distributorConn As ServerConnection = New ServerConnection(distributorName)

Try
    ' Connect to the Distributor.
    distributorConn.Connect()

    ' Set the Distributor properties.
    distributor = New ReplicationServer(distributorConn)

    ' Set the business logic handler properties.
    customLogic = New BusinessLogicHandler()
    customLogic.DotNetAssemblyName = assemblyName
    customLogic.DotNetClassName = className
    customLogic.FriendlyName = friendlyName
    customLogic.IsDotNetAssembly = True

    Dim isRegistered As Boolean = False

    ' Check if the business logic handler is already registered at the Distributor.
    For Each registeredLogic As BusinessLogicHandler _
    In distributor.EnumBusinessLogicHandlers
        If registeredLogic Is customLogic Then
            isRegistered = True
        End If
    Next

    ' Register the custom logic.
    If Not isRegistered Then
        distributor.RegisterBusinessLogicHandler(customLogic)
    End If
Catch ex As Exception
    ' Do error handling here.
    Throw New ApplicationException(String.Format( _
     "The {0} assembly could not be registered.", _
     assemblyName), ex)
Finally
    distributorConn.Disconnect()
End Try

次の例では、既存のアーティクルを変更してビジネスロジックハンドラを使用します。

           // Define the Publisher, publication, and article names.
            string publisherName = publisherInstance;
            string publicationName = "AdvWorksSalesOrdersMerge";
            string publicationDbName = "AdventureWorks2008R2";
            string articleName = "SalesOrderHeader";
            
            // Set the friendly name of the business logic handler.
            string customLogic = "OrderEntryLogic";

            MergeArticle article = new MergeArticle();
            
            // Create a connection to the Publisher.
            ServerConnection conn = new ServerConnection(publisherName);

            try
            {
                // Connect to the Publisher.
                conn.Connect();

                // Set the required properties for the article.
                article.ConnectionContext = conn;
                article.Name = articleName;
                article.DatabaseName = publicationDbName;
                article.PublicationName = publicationName;

                // Load the article properties.
                if (article.LoadProperties())
                {
                    article.ArticleResolver = customLogic;
                }
                else
                {
                    // Throw an exception of the article does not exist.
                    throw new ApplicationException(String.Format(
                    "{0} is not published in {1}", articleName, publicationName));
                }
                
            }
            catch (Exception ex)
            {
                // Do error handling here and rollback the transaction.
                throw new ApplicationException(String.Format(
                    "The business logic handler {0} could not be associated with " +
                    " the {1} article.",customLogic,articleName), ex);
            }
            finally
            {
                conn.Disconnect();
            }

' Define the Publisher, publication, and article names.
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publicationDbName As String = "AdventureWorks2008R2"
Dim articleName As String = "SalesOrderHeader"

' Set the friendly name of the business logic handler.
Dim customLogic As String = "OrderEntryLogic"

Dim article As MergeArticle = New MergeArticle()

' Create a connection to the Publisher.
Dim conn As ServerConnection = New ServerConnection(publisherName)

Try
    ' Connect to the Publisher.
    conn.Connect()

    ' Set the required properties for the article.
    article.ConnectionContext = conn
    article.Name = articleName
    article.DatabaseName = publicationDbName
    article.PublicationName = publicationName

    ' Load the article properties.
    If article.LoadProperties() Then
        article.ArticleResolver = customLogic
    Else
        ' Throw an exception of the article does not exist.
        Throw New ApplicationException(String.Format( _
         "{0} is not published in {1}", articleName, publicationName))
    End If

Catch ex As Exception
    ' Do error handling here and rollback the transaction.
    Throw New ApplicationException(String.Format( _
     "The business logic handler {0} could not be associated with " + _
     " the {1} article.", customLogic, articleName), ex)
Finally
    conn.Disconnect()
End Try

次の方法で共有

マージアーティクルにビジネスロジックハンドラを実装する方法 (RMO プログラミング)

ビジネスロジックハンドラを作成するには

ビジネスロジックハンドラを登録するには

ビジネスロジックハンドラを配置するには

新しいテーブルアーティクルでビジネスロジックハンドラを使用するには

既存のテーブルアーティクルでビジネスロジックハンドラを使用するには

使用例

関連項目

タスク

概念

その他のリソース

次の方法で共有

マージ アーティクルにビジネス ロジック ハンドラを実装する方法 (RMO プログラミング)

ビジネス ロジック ハンドラを作成するには

ビジネス ロジック ハンドラを登録するには

ビジネス ロジック ハンドラを配置するには

新しいテーブル アーティクルでビジネス ロジック ハンドラを使用するには

既存のテーブル アーティクルでビジネス ロジック ハンドラを使用するには

使用例

関連項目

タスク

概念

その他のリソース

マージアーティクルにビジネスロジックハンドラを実装する方法 (RMO プログラミング)

ビジネスロジックハンドラを作成するには

ビジネスロジックハンドラを登録するには

ビジネスロジックハンドラを配置するには

新しいテーブルアーティクルでビジネスロジックハンドラを使用するには

既存のテーブルアーティクルでビジネスロジックハンドラを使用するには