• Article

Classe MergeSubscription

Represents a subscription to a merge publication registered at the Publisher.

Hiérarchie d'héritage

System. . :: . .Object
  Microsoft.SqlServer.Replication. . :: . .ReplicationObject
    Microsoft.SqlServer.Replication. . :: . .Subscription
      Microsoft.SqlServer.Replication..::..MergeSubscription

Espace de noms :  Microsoft.SqlServer.Replication
Assembly :  Microsoft.SqlServer.Rmo (en Microsoft.SqlServer.Rmo.dll)

Syntaxe

'Déclaration
Public NotInheritable Class MergeSubscription _
    Inherits Subscription
'Utilisation
Dim instance As MergeSubscription

public sealed class MergeSubscription : Subscription

public ref class MergeSubscription sealed : public Subscription

[<SealedAttribute>]
type MergeSubscription =  
    class
        inherit Subscription
    end

public final class MergeSubscription extends Subscription

Le type MergeSubscription expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique MergeSubscription() () () () Creates a new instance of the MergeSubscription class.
Méthode publique MergeSubscription(String, String, String, String, ServerConnection) Creates a new instance of the MergeSubscription class with the specified connection to the Publisher and the properties that uniquely define the subscription.

Haut de la page

Propriétés

  Nom Description
Propriété publique AgentJobId Gets the ID of the agent job used to synchronize the subscription. (hérité de Subscription.)
Propriété publique AgentOffload Gets or sets whether the synchronization agent runs on a computer other than the one where the agent job was created. This property is no longer supported for Distributors running Microsoft SQL Server 2005 and later. (hérité de Subscription.)
Propriété publique AgentOffloadServer Gets or sets the name of the remote computer where the agent runs when using remote agent activation. (hérité de Subscription.)
Propriété publique AgentSchedule Gets the schedule for the agent job used to synchronize the subscription. (hérité de Subscription.)
Propriété publique CachePropertyChanges Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (hérité de ReplicationObject.)
Propriété publique ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (hérité de ReplicationObject.)
Propriété publique CreateSyncAgentByDefault Gets or sets whether the agent job used to synchronize the subscription is created by default. (hérité de Subscription.)
Propriété publique DatabaseName Gets or sets the name of the publication database. (hérité de Subscription.)
Propriété publique Description Gets or sets a textual description of the merge subscription.
Propriété publique EnabledForSynchronizationManager Specifies whether the subscription can be synchronized using Microsoft Windows Synchronization Manager. (hérité de Subscription.)
Propriété publique HostName Gets or sets the value supplied to the HOST_NAME function when this function is used in the parameterized row filter that defines the Subscriber's data partition.
Propriété publique IsExistingObject Gets whether the object exists on the server or not. (hérité de ReplicationObject.)
Propriété publique Name Gets the name assigned to an existing subscription. (hérité de Subscription.)
Propriété publique Priority Gets or sets the relative priority value assigned to a server subscription.
Propriété publique PublicationName Gets or sets the name of the publication to which the subscription subscribes. (hérité de Subscription.)
Propriété publique PublisherSecurity Gets the security context used by the Merge Agent to connect to the Publisher.
Propriété publique SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (hérité de ReplicationObject.)
Propriété publique Status Gets the status of the subscription. (hérité de Subscription.)
Propriété publique SubscriberName Gets or sets the name of the instance of Microsoft SQL Server that is the Subscriber. (hérité de Subscription.)
Propriété publique SubscriberSecurity Gets the security context used to connect to the Subscriber. (hérité de Subscription.)
Propriété publique SubscriberType Gets or sets whether the subscription is a client or server subscription.
Propriété publique SubscriptionDBName Gets or sets the name of the database on the Subscriber that receives the replicated data. (hérité de Subscription.)
Propriété publique SubscriptionType Gets whether the subscription registration is for a push or pull subscription. (hérité de Subscription.)
Propriété publique SynchronizationAgent Gets an instance of the MergeSynchronizationAgent class that can be used to synchronize the subscription.
Propriété publique SynchronizationAgentName Gets or sets the name of the agent job created to synchronize the subscription. (hérité de Subscription.)
Propriété publique SynchronizationAgentProcessSecurity Gets the security context that is used to specify the Microsoft Windows account under which the synchronization agent job runs to synchronize the subscription. (hérité de Subscription.)
Propriété publique SyncType Gets or sets the manner in which the subscription is initialized. (hérité de Subscription.)
Propriété publique UseInteractiveResolver Gets or sets whether the Interactive Resolver is used during the synchronization process.
Propriété publique UserData Gets or sets an object property that allows users to attach their own data to the object. (hérité de ReplicationObject.)

Haut de la page

Méthodes

  Nom Description
Méthode protégée CheckValidCreation Infrastructure. (hérité de ReplicationObject.)
Méthode protégée CheckValidDefinition Infrastructure. (hérité de Subscription.)
Méthode publique CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (hérité de ReplicationObject.)
Méthode publique Create Creates the subscription registration at the Publisher. (hérité de Subscription.)
Méthode publique Decouple Decouples the referenced replication object from the server. (hérité de ReplicationObject.)
Méthode publique Equals (hérité de Object.)
Méthode protégée Finalize (hérité de Object.)
Méthode protégée GetChangeCommand Infrastructure. (hérité de ReplicationObject.)
Méthode protégée GetCreateCommand Infrastructure. (hérité de ReplicationObject.)
Méthode protégée GetDropCommand Infrastructure. (hérité de ReplicationObject.)
Méthode publique GetHashCode (hérité de Object.)
Méthode publique GetType (hérité de Object.)
Méthode protégée InternalRefresh Infrastructure. (hérité de ReplicationObject.)
Méthode publique Load Loads the properties of an existing object from the server. (hérité de ReplicationObject.)
Méthode publique LoadProperties Loads the properties of an existing object from the server. (hérité de ReplicationObject.)
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode publique Refresh Reloads the properties of the object. (hérité de ReplicationObject.)
Méthode publique Reinitialize Marks the merge subscription for reinitialization.
Méthode publique Remove Deletes the subscription registration at the Publisher and removes replication objects at the Subscriber for a push subscription. (hérité de Subscription.)
Méthode publique Script Returns a Transact-SQL script that can be used to create or delete the subscription. (hérité de Subscription.)
Méthode publique StopSynchronizationJob Attempts to stop a running Merge Agent job that is currently synchronizing the subscription.
Méthode publique SynchronizeWithJob Starts the agent job to synchronize the subscription.
Méthode publique ToString (hérité de Object.)

Haut de la page

Notes

The MergeSubscription class is used with both pull and push subscriptions to a merge publication.

When configuring a Publisher with a remote Distributor, the values supplied for all parameters, including SynchronizationAgentProcessSecurity, are sent to the Distributor as plain text. You should encrypt the connection between the Publisher and its remote Distributor before calling the Create method. For more information, see Chiffrement des connexions à SQL Server.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Thread Safety

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

Exemples

            // Define the Publisher, publication, and databases.
            string publicationName = "AdvWorksSalesOrdersMerge";
            string publisherName = publisherInstance;
            string subscriberName = subscriberInstance;
            string subscriptionDbName = "AdventureWorks2008R2Replica";
            string publicationDbName = "AdventureWorks2008R2";
            string hostname = @"adventure-works\garrett1";

            //Create a connection to the Publisher.
            ServerConnection conn = new ServerConnection(subscriberName);

            // Create the objects that we need.
            MergePublication publication;
            MergeSubscription subscription;

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

                // Ensure that the publication exists and that 
                // it supports push subscriptions.
                publication = new MergePublication();
                publication.Name = publicationName;
                publication.DatabaseName = publicationDbName;
                publication.ConnectionContext = conn;

                if (publication.IsExistingObject)
                {
                    if ((publication.Attributes & PublicationAttributes.AllowPush) == 0)
                    {
                        publication.Attributes |= PublicationAttributes.AllowPush;
                    }

                    // Define the push subscription.
                    subscription = new MergeSubscription();
                    subscription.ConnectionContext = conn;
                    subscription.SubscriberName = subscriberName;
                    subscription.PublicationName = publicationName;
                    subscription.DatabaseName = publicationDbName;
                    subscription.SubscriptionDBName = subscriptionDbName;
                    subscription.HostName = hostname;

                    // Set a schedule to synchronize the subscription every 2 hours
                    // during weekdays from 6am to 10pm.
                    subscription.AgentSchedule.FrequencyType = ScheduleFrequencyType.Weekly;
                    subscription.AgentSchedule.FrequencyInterval = Convert.ToInt32(0x003E);
                    subscription.AgentSchedule.FrequencyRecurrenceFactor = 1;
                    subscription.AgentSchedule.FrequencySubDay = ScheduleFrequencySubDay.Hour;
                    subscription.AgentSchedule.FrequencySubDayInterval = 2;
                    subscription.AgentSchedule.ActiveStartDate = 20051108;
                    subscription.AgentSchedule.ActiveEndDate = 20071231;
                    subscription.AgentSchedule.ActiveStartTime = 060000;
                    subscription.AgentSchedule.ActiveEndTime = 100000;

                    // Specify the Windows login credentials for the Merge Agent job.
                    subscription.SynchronizationAgentProcessSecurity.Login = winLogin;
                    subscription.SynchronizationAgentProcessSecurity.Password = winPassword;

                    // Create the push subscription.
                    subscription.Create();
                }
                else
                {
                    // Do something here if the publication does not exist.
                    throw new ApplicationException(String.Format(
                        "The publication '{0}' does not exist on {1}.",
                        publicationName, publisherName));
                }
            }
            catch (Exception ex)
            {
                // Implement the appropriate error handling here.
                throw new ApplicationException(String.Format(
                    "The subscription to {0} could not be created.", publicationName), ex);
            }
            finally
            {
                conn.Disconnect();
            }

' Define the Publisher, publication, and databases.
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publisherName As String = publisherInstance
Dim subscriberName As String = subscriberInstance
Dim subscriptionDbName As String = "AdventureWorks2008R2Replica"
Dim publicationDbName As String = "AdventureWorks2008R2"
Dim hostname As String = "adventure-works\garrett1"

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

' Create the objects that we need.
Dim publication As MergePublication
Dim subscription As MergeSubscription

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

    ' Ensure that the publication exists and that 
    ' it supports push subscriptions.
    publication = New MergePublication()
    publication.Name = publicationName
    publication.DatabaseName = publicationDbName
    publication.ConnectionContext = conn

    If publication.IsExistingObject Then
        If (publication.Attributes And PublicationAttributes.AllowPush) = 0 Then
            publication.Attributes = publication.Attributes _
            Or PublicationAttributes.AllowPush
        End If

        ' Define the push subscription.
        subscription = New MergeSubscription()
        subscription.ConnectionContext = conn
        subscription.SubscriberName = subscriberName
        subscription.PublicationName = publicationName
        subscription.DatabaseName = publicationDbName
        subscription.SubscriptionDBName = subscriptionDbName
        subscription.HostName = hostname

        ' Set a schedule to synchronize the subscription every 2 hours
        ' during weekdays from 6am to 10pm.
        subscription.AgentSchedule.FrequencyType = ScheduleFrequencyType.Weekly
        subscription.AgentSchedule.FrequencyInterval = Convert.ToInt32("0x003E", 16)
        subscription.AgentSchedule.FrequencyRecurrenceFactor = 1
        subscription.AgentSchedule.FrequencySubDay = ScheduleFrequencySubDay.Hour
        subscription.AgentSchedule.FrequencySubDayInterval = 2
        subscription.AgentSchedule.ActiveStartDate = 20051108
        subscription.AgentSchedule.ActiveEndDate = 20071231
        subscription.AgentSchedule.ActiveStartTime = 60000
        subscription.AgentSchedule.ActiveEndTime = 100000

        ' Specify the Windows login credentials for the Merge Agent job.
        subscription.SynchronizationAgentProcessSecurity.Login = winLogin
        subscription.SynchronizationAgentProcessSecurity.Password = winPassword

        ' Create the push subscription.
        subscription.Create()
    Else

        ' Do something here if the publication does not exist.
        Throw New ApplicationException(String.Format( _
         "The publication '{0}' does not exist on {1}.", _
         publicationName, publisherName))
    End If
Catch ex As Exception
    ' Implement the appropriate error handling here.
    Throw New ApplicationException(String.Format( _
    "The subscription to {0} could not be created.", publicationName), ex)
Finally
    conn.Disconnect()
End Try

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.