MergeSynchronizationAgent Class
Provides the functionality of the Replication Merge Agent.
Inheritance Hierarchy
System.Object
System.MarshalByRefObject
Microsoft.SqlServer.Replication.MergeSynchronizationAgent
Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Replication (in Microsoft.SqlServer.Replication.dll)
Syntax
'Declaration
<ComVisibleAttribute(True)> _
<GuidAttribute("ee5ee47e-6d29-448f-b2d2-f8e632db336a")> _
<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)> _
<PermissionSetAttribute(SecurityAction.Demand, Name := "FullTrust")> _
Public Class MergeSynchronizationAgent _
Inherits MarshalByRefObject _
Implements IDisposable, IMergeSynchronizationAgent
'Usage
Dim instance As MergeSynchronizationAgent
[ComVisibleAttribute(true)]
[GuidAttribute("ee5ee47e-6d29-448f-b2d2-f8e632db336a")]
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
[PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")]
public class MergeSynchronizationAgent : MarshalByRefObject,
IDisposable, IMergeSynchronizationAgent
[ComVisibleAttribute(true)]
[GuidAttribute(L"ee5ee47e-6d29-448f-b2d2-f8e632db336a")]
[ClassInterfaceAttribute(ClassInterfaceType::AutoDispatch)]
[PermissionSetAttribute(SecurityAction::Demand, Name = L"FullTrust")]
public ref class MergeSynchronizationAgent : public MarshalByRefObject,
IDisposable, IMergeSynchronizationAgent
[<ComVisibleAttribute(true)>]
[<GuidAttribute("ee5ee47e-6d29-448f-b2d2-f8e632db336a")>]
[<ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)>]
[<PermissionSetAttribute(SecurityAction.Demand, Name = "FullTrust")>]
type MergeSynchronizationAgent =
class
inherit MarshalByRefObject
interface IDisposable
interface IMergeSynchronizationAgent
end
public class MergeSynchronizationAgent extends MarshalByRefObject implements IDisposable, IMergeSynchronizationAgent
The MergeSynchronizationAgent type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
MergeSynchronizationAgent | Creates an instance of the MergeSynchronizationAgent class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AlternateSynchronizationPartnerCollection | Gets the alternate synchronization partners for a subscription. |
|
AltSnapshotFolder | Gets or sets the alternate snapshot folder for the subscription. |
|
ComErrorCollection | Gets a collection of errors generated by the replication agent. |
|
Distributor | Gets or sets the name of the instance of Microsoft SQL Server that is acting as the Distributor for the subscription. |
|
DistributorAddress | Gets or sets the network address that is used to connect to the Distributor when the DistributorNetwork property is specified. |
|
DistributorEncryptedPassword | Infrastructure. Gets or sets the distributor encrypted password. |
|
DistributorLogin | Gets or sets the login name that is used when connecting to the Distributor using SQL Server Authentication. |
|
DistributorNetwork | Gets or sets the client Net-Library that is used when connecting to the Distributor. |
|
DistributorPassword | Sets the password that is used when connecting to the Distributor using SQL Server Authentication. |
|
DistributorSecurityMode | Gets or sets the security mode used when connecting to the Distributor. |
|
DownloadGenerationsPerBatch | Gets or sets the number of generations to be processed in a single batch while downloading changes from the Publisher to the Subscriber. A generation is defined as a logical group of changes per article. |
|
DynamicSnapshotLocation | Gets or sets the location of the partitioned snapshot for this Subscriber. |
|
ExchangeType | Gets or sets how data is exchanged during synchronization. |
|
FileTransferType | Gets or sets how the initial snapshot files are transferred to the Subscriber. |
|
HostName | Gets or sets the value used by the Merge Agent when it evaluates a parameterized filter that uses the HOST_NAME function. |
|
InputMessageFile | Infrastructure. Gets or sets the input message file. |
|
InternetLogin | Gets or sets the login name that is used with Web synchronization when connecting to the Publisher by using Internet authentication. |
|
InternetPassword | Sets the password for the InternetLogin property that is used with Web synchronization when connecting to the Publisher by using Internet authentication. |
|
InternetProxyLogin | Gets or sets the login name that is used with Web synchronization when connecting to the Web server by using an Internet proxy server. |
|
InternetProxyPassword | Sets the password for the login that is used with Web synchronization when connecting to the Web server by using an Internet proxy server. |
|
InternetProxyServer | Gets or sets the name of the Internet proxy server that is used with Web synchronization when connecting to the Web server. |
|
InternetSecurityMode | Gets or sets the HTTP authentication method that is used when connecting to the Web server during Web synchronization. |
|
InternetTimeout | Gets or sets the HTTP time-out when connecting to the Web server. |
|
InternetUrl | Gets or sets the URL of the Web service that is configured for Web synchronization. |
|
LastUpdatedTime | Gets the timestamp of the last time that replication agent synchronized the subscription. |
|
LoginTimeout | Gets or sets the maximum number of seconds to wait for connections to be established. |
|
MetadataRetentionCleanup | Get or sets whether to clean up metadata. |
|
Output | Gets or sets the agent output file. |
|
OutputMessageFile | Infrastructure. Gets or sets the input message file. |
|
OutputVerboseLevel | Gets or sets the level of detail of information that is written to the agent output file. |
|
ProfileName | Gets or sets the name of the profile that is used by the agent. |
|
Publication | Gets or sets the name of the publication. |
|
Publisher | Gets or sets the name of the instance of Microsoft SQL Server that is the Publisher for the subscription. |
|
PublisherAddress | Gets or sets the network address that is used to connect to the Publisher when the PublisherNetwork property is specified. |
|
PublisherChanges | Gets the total number of Publisher changes that were applied at the Subscriber during the last synchronization. |
|
PublisherConflicts | Gets the total number of conflicts that occurred at the Publisher during the last synchronization. |
|
PublisherDatabase | Gets or sets the name of the publication database. |
|
PublisherEncryptedPassword | Infrastructure. Gets or sets the publisher encrypted password. |
|
PublisherFailoverPartner | Gets or sets the failover partner instance of SQL Server that is participating in a database mirroring session with the publication database. |
|
PublisherLogin | Gets or sets the login name that is used when connecting to the Publisher by using SQL Server Authentication. |
|
PublisherNetwork | Gets or sets the client Net-Library that is used when connecting to the Publisher. |
|
PublisherPassword | Sets the password that is used when connecting to the Publisher by using SQL Server Authentication. |
|
PublisherSecurityMode | Gets or sets the security mode that is used when connecting to the Publisher. |
|
QueryTimeout | Gets or sets the number of seconds that are allowed for internal queries to finish. |
|
SecureDistributorEncryptedPassword | Infrastructure. Gets or sets the secure distributor encrypted password. |
|
SecurePublisherEncryptedPassword | Infrastructure. Gets or sets the secure publisher encrypted password. |
|
SecureSubscriberEncryptedPassword | Infrastructure. Gets or sets the secure subscriber encrypted password. |
|
Subscriber | Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber. |
|
SubscriberChanges | Gets the total number of Subscriber changes that were applied at the Publisher during the last synchronization. |
|
SubscriberConflicts | Gets the total number of conflicts that occurred at the Publisher during the last synchronization. |
|
SubscriberDatabase | Gets or sets the name of the subscription database. |
|
SubscriberDatabasePath | Infrastructure. Gets or sets the subscriber database path. |
|
SubscriberDataSourceType | Gets or sets the type of data source that is used as the Subscriber. |
|
SubscriberEncryptedPassword | Infrastructure. Gets or sets the subscriber encrypted password. |
|
SubscriberLogin | Gets or sets the login name used that is when connecting to the Subscriber by using SQL Server Authentication. |
|
SubscriberPassword | Sets the password that is used when connecting to the Subscriber by using SQL Server Authentication. |
|
SubscriberSecurityMode | Gets or sets the security mode used when connecting to the Subscriber. |
|
SubscriptionType | Gets or sets whether the subscription is a push or pull subscription. |
|
SyncToAlternate | Gets or sets whether the synchronization is to an alternate synchronization partner. |
|
UploadGenerationsPerBatch | Gets or sets the number of generations to be processed in a single batch while uploading changes from the Subscriber to the Publisher. A generation is defined as a logical group of changes per article. |
|
UseInteractiveResolver | Gets or sets whether the interactive resolver is used during reconciliation. |
|
UseWebSynchronization | Gets or sets whether Web synchronization is used. |
|
Validate | Gets or sets whether data validation is performed on the Subscriber data at the end of the synchronization. |
|
WorkingDirectory | Gets or sets the working directory from which snapshot files are accessed when FTP is used. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Abort | Infrastructure. Aborts the synchronization. |
|
ClearAllTraceFlags | Infrastructure. Clears all the trace flags used by the synchronization agent. |
|
ClearTraceFlag | Infrastructure. Clears a trace flag. |
|
CreateObjRef | Security Critical. (Inherited from MarshalByRefObject.) |
|
Dispose() | Infrastructure. Releases the unmanaged resources that are used by MergeSynchronizationAgent. |
.gif "Protected method") |
Dispose(Boolean) | Infrastructure. Releases the unmanaged resources that are used by MergeSynchronizationAgent. |
|
EnableTraceFlag | Infrastructure. Enables the flag tracing. |
|
Equals | (Inherited from Object.) |
|
Finalize | Infrastructure. Finalizes the agent. (Overrides Object.Finalize().) |
|
GetHashCode | (Inherited from Object.) |
|
GetLifetimeService | Security Critical. (Inherited from MarshalByRefObject.) |
|
GetType | (Inherited from Object.) |
|
InitializeLifetimeService | Security Critical. (Inherited from MarshalByRefObject.) |
|
IsSnapshotRequired | Connects to the Publisher or Distributor and the Subscriber to determine whether a new snapshot will be applied during the next agent synchronization. |
|
MemberwiseClone() | (Inherited from Object.) |
|
MemberwiseClone(Boolean) | (Inherited from MarshalByRefObject.) |
|
ProcessMessagesAtPublisher | Infrastructure. Processes the messages at publisher. |
|
ProcessMessagesAtSubscriber | Infrastructure. Processes the messages at subscriber. |
|
Synchronize | Starts the Merge Agent to synchronize the subscription. |
|
ToString | (Inherited from Object.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
ComStatus | Infrastructure. Occurs when the Merge Agent returns synchronization Com status information. |
|
Status | Occurs when the Merge Agent returns synchronization status information. |
Top
Remarks
The MergeSynchronizationAgent class supports the ability to do the following replication tasks:
Synchronize subscriptions.
Specify whether only the upload phase, only the download phase, or both phases are run during synchronization.
Validate that a subscription has the expected data.
Specify a different snapshot folder, from which the initial snapshot for a subscription can be applied.
Examples
In the following example, the Synchronize method is called on the instance of the MergeSynchronizationAgent class that is accessed from the SynchronizationAgent property to synchronize the push subscription.
// Define the server, publication, and database names.
string subscriberName = subscriberInstance;
string publisherName = publisherInstance;
string publicationName = "AdvWorksSalesOrdersMerge";
string subscriptionDbName = "AdventureWorks2012Replica";
string publicationDbName = "AdventureWorks2012";
// Create a connection to the Publisher.
ServerConnection conn = new ServerConnection(publisherName);
MergeSubscription subscription;
try
{
// Connect to the Publisher
conn.Connect();
// Define the subscription.
subscription = new MergeSubscription();
subscription.ConnectionContext = conn;
subscription.DatabaseName = publicationDbName;
subscription.PublicationName = publicationName;
subscription.SubscriptionDBName = subscriptionDbName;
subscription.SubscriberName = subscriberName;
// If the push subscription exists, start the synchronization.
if (subscription.LoadProperties())
{
// Check that we have enough metadata to start the agent.
if (subscription.SubscriberSecurity != null)
{
// Synchronously start the Merge Agent for the subscription.
subscription.SynchronizationAgent.Synchronize();
}
else
{
throw new ApplicationException("There is insufficent metadata to " +
"synchronize the subscription. Recreate the subscription with " +
"the agent job or supply the required agent properties at run time.");
}
}
else
{
// Do something here if the push subscription does not exist.
throw new ApplicationException(String.Format(
"The subscription to '{0}' does not exist on {1}",
publicationName, subscriberName));
}
}
catch (Exception ex)
{
// Implement appropriate error handling here.
throw new ApplicationException("The subscription could not be synchronized.", ex);
}
finally
{
conn.Disconnect();
}
' Define the server, publication, and database names.
Dim subscriberName As String = subscriberInstance
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim subscriptionDbName As String = "AdventureWorks2012Replica"
Dim publicationDbName As String = "AdventureWorks2012"
' Create a connection to the Publisher.
Dim conn As ServerConnection = New ServerConnection(publisherName)
Dim subscription As MergeSubscription
Try
' Connect to the Publisher
conn.Connect()
' Define the subscription.
subscription = New MergeSubscription()
subscription.ConnectionContext = conn
subscription.DatabaseName = publicationDbName
subscription.PublicationName = publicationName
subscription.SubscriptionDBName = subscriptionDbName
subscription.SubscriberName = subscriberName
' If the push subscription exists, start the synchronization.
If subscription.LoadProperties() Then
' Check that we have enough metadata to start the agent.
If Not subscription.SubscriberSecurity Is Nothing Then
' Synchronously start the Merge Agent for the subscription.
' Log agent messages to an output file.
subscription.SynchronizationAgent.Output = "mergeagent.log"
subscription.SynchronizationAgent.OutputVerboseLevel = 2
subscription.SynchronizationAgent.Synchronize()
Else
Throw New ApplicationException("There is insufficent metadata to " + _
"synchronize the subscription. Recreate the subscription with " + _
"the agent job or supply the required agent properties at run time.")
End If
Else
' Do something here if the push subscription does not exist.
Throw New ApplicationException(String.Format( _
"The subscription to '{0}' does not exist on {1}", _
publicationName, subscriberName))
End If
Catch ex As Exception
' Implement appropriate error handling here.
Throw New ApplicationException("The subscription could not be synchronized.", ex)
Finally
conn.Disconnect()
End Try
In the following example, an instance of the MergeSynchronizationAgent class is used to synchronize a merge subscription. Because the pull subscription was created by using a value of false for CreateSyncAgentByDefault, additional properties must be supplied.
// Define the server, publication, and database names.
string subscriberName = subscriberInstance;
string publisherName = publisherInstance;
string distributorName = distributorInstance;
string publicationName = "AdvWorksSalesOrdersMerge";
string subscriptionDbName = "AdventureWorks2012Replica";
string publicationDbName = "AdventureWorks2012";
string hostname = @"adventure-works\garrett1";
string webSyncUrl = "https://" + publisherInstance + "/SalesOrders/replisapi.dll";
// Create a connection to the Subscriber.
ServerConnection conn = new ServerConnection(subscriberName);
MergePullSubscription subscription;
MergeSynchronizationAgent agent;
try
{
// Connect to the Subscriber.
conn.Connect();
// Define the pull subscription.
subscription = new MergePullSubscription();
subscription.ConnectionContext = conn;
subscription.DatabaseName = subscriptionDbName;
subscription.PublisherName = publisherName;
subscription.PublicationDBName = publicationDbName;
subscription.PublicationName = publicationName;
// If the pull subscription exists, then start the synchronization.
if (subscription.LoadProperties())
{
// Get the agent for the subscription.
agent = subscription.SynchronizationAgent;
// Check that we have enough metadata to start the agent.
if (agent.PublisherSecurityMode == null)
{
// Set the required properties that could not be returned
// from the MSsubscription_properties table.
agent.PublisherSecurityMode = SecurityMode.Integrated;
agent.DistributorSecurityMode = SecurityMode.Integrated;
agent.Distributor = publisherName;
agent.HostName = hostname;
// Set optional Web synchronization properties.
agent.UseWebSynchronization = true;
agent.InternetUrl = webSyncUrl;
agent.InternetSecurityMode = SecurityMode.Standard;
agent.InternetLogin = winLogin;
agent.InternetPassword = winPassword;
}
// Enable agent output to the console.
agent.OutputVerboseLevel = 1;
agent.Output = "";
// Synchronously start the Merge Agent for the subscription.
agent.Synchronize();
}
else
{
// Do something here if the pull subscription does not exist.
throw new ApplicationException(String.Format(
"A subscription to '{0}' does not exist on {1}",
publicationName, subscriberName));
}
}
catch (Exception ex)
{
// Implement appropriate error handling here.
throw new ApplicationException("The subscription could not be " +
"synchronized. Verify that the subscription has " +
"been defined correctly.", ex);
}
finally
{
conn.Disconnect();
}
' Define the server, publication, and database names.
Dim subscriberName As String = subscriberInstance
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim subscriptionDbName As String = "AdventureWorks2012Replica"
Dim publicationDbName As String = "AdventureWorks2012"
Dim hostname As String = "adventure-works\garrett1"
Dim webSyncUrl As String = "https://" + publisherInstance + "/SalesOrders/replisapi.dll"
' Create a connection to the Subscriber.
Dim conn As ServerConnection = New ServerConnection(subscriberName)
Dim subscription As MergePullSubscription
Dim agent As MergeSynchronizationAgent
Try
' Connect to the Subscriber.
conn.Connect()
' Define the pull subscription.
subscription = New MergePullSubscription()
subscription.ConnectionContext = conn
subscription.DatabaseName = subscriptionDbName
subscription.PublisherName = publisherName
subscription.PublicationDBName = publicationDbName
subscription.PublicationName = publicationName
' If the pull subscription exists, then start the synchronization.
If subscription.LoadProperties() Then
' Get the agent for the subscription.
agent = subscription.SynchronizationAgent
' Check that we have enough metadata to start the agent.
If agent.PublisherSecurityMode = Nothing Then
' Set the required properties that could not be returned
' from the MSsubscription_properties table.
agent.PublisherSecurityMode = SecurityMode.Integrated
agent.Distributor = publisherInstance
agent.DistributorSecurityMode = SecurityMode.Integrated
agent.HostName = hostname
' Set optional Web synchronization properties.
agent.UseWebSynchronization = True
agent.InternetUrl = webSyncUrl
agent.InternetSecurityMode = SecurityMode.Standard
agent.InternetLogin = winLogin
agent.InternetPassword = winPassword
End If
' Enable agent logging to the console.
agent.OutputVerboseLevel = 1
agent.Output = ""
' Synchronously start the Merge Agent for the subscription.
agent.Synchronize()
Else
' Do something here if the pull subscription does not exist.
Throw New ApplicationException(String.Format( _
"A subscription to '{0}' does not exist on {1}", _
publicationName, subscriberName))
End If
Catch ex As Exception
' Implement appropriate error handling here.
Throw New ApplicationException("The subscription could not be " + _
"synchronized. Verify that the subscription has " + _
"been defined correctly.", ex)
Finally
conn.Disconnect()
End Try
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Reference
Microsoft.SqlServer.Replication Namespace
Other Resources
NIB Synchronize a Pull Subscription (RMO Programming)