Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

BusinessLogicModule Class

 

Applies To: SQL Server 2016 Preview

Implements the custom business logic that is invoked during the merge replication synchronization process.

Namespace:   Microsoft.SqlServer.Replication.BusinessLogicSupport
Assembly:  Microsoft.SqlServer.Replication.BusinessLogicSupport (in Microsoft.SqlServer.Replication.BusinessLogicSupport.dll)

System.Object
  Microsoft.SqlServer.Replication.BusinessLogicSupport.BusinessLogicModule

public abstract class BusinessLogicModule

NameDescription
System_CAPS_protmethodBusinessLogicModule()

Constructor.

NameDescription
System_CAPS_pubpropertyHandledChangeStates

Required property that returns information on the types of changes handled by the business logic module.

NameDescription
System_CAPS_pubmethodCommitHandler(SourceIdentifier, Guid)

Optional method implements the custom business logic that is invoked when a data change is committed during synchronization.

System_CAPS_pubmethodDeleteErrorHandler(SourceIdentifier, DataSet, ErrorLogType, String, Int32, String, Int32, String)

Optional method that implements the custom business logic invoked when an error occurs at the time a DELETE statement is being uploaded or downloaded.

System_CAPS_pubmethodDeleteHandler(SourceIdentifier, DataSet, Int32, String)

Optional method that implements the custom business logic invoked when DELETE statements are being uploaded or downloaded.

System_CAPS_pubmethodDispose()

Disposes of all used resources. This method is invoked after all the custom business logic has been executed.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize(String, String, String, String, String, String)

Sends information about the article being synchronized to the business logic resolver when the Merge Agent is started.

System_CAPS_pubmethodInsertErrorHandler(SourceIdentifier, DataSet, ErrorLogType, String, Int32, String, Int32, String)

Optional method implements the custom business logic invoked when an error occurs at the time an INSERT statement is being uploaded or downloaded.

System_CAPS_pubmethodInsertHandler(SourceIdentifier, DataSet, DataSet, Int32, String)

Optional method that implements the custom business logic invoked when INSERT statements are being uploaded or downloaded.

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodPhaseBegin(Boolean)

Optional method that indicates the beginning of an upload or download phase of the synchronization.

System_CAPS_pubmethodToString()

(Inherited from Object.)

System_CAPS_pubmethodUpdateConflictsHandler(DataSet, DataSet, DataSet, ConflictLogType, String, Int32, String)

Optional method that implements the custom business logic invoked when conflicting UPDATE statements occur at the Publisher and at the Subscriber.

System_CAPS_pubmethodUpdateDeleteConflictHandler(SourceIdentifier, DataSet, DataSet, ConflictLogType, String, Int32, String)

Optional method that implements the custom business logic invoked when UPDATE statements conflict with DELETE statements at the Publisher and at the Subscriber.

System_CAPS_pubmethodUpdateErrorHandler(SourceIdentifier, DataSet, ErrorLogType, String, Int32, String, Int32, String)

Optional method that implements the custom business logic invoked when an error occurs at the time an UPDATE statement is being uploaded or downloaded.

System_CAPS_pubmethodUpdateHandler(SourceIdentifier, DataSet, DataSet, Int32, String)

Optional method that implements the custom business logic invoked when UPDATE statements are being uploaded or downloaded.

An implementation needs to be provided only for the specific methods that contain the custom logic. If a user-defined implementation is not provided, the default action will be performed.

Legacy Code Example

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);
			}
		}
	}
}

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top

Community Additions

Show:
© 2015 Microsoft