MergePullSubscription 类

Represents a pull subscription to a merge publication.

继承层次结构

System. . :: . .Object
  Microsoft.SqlServer.Replication. . :: . .ReplicationObject
    Microsoft.SqlServer.Replication. . :: . .PullSubscription
      Microsoft.SqlServer.Replication..::..MergePullSubscription

命名空间:  Microsoft.SqlServer.Replication
程序集:  Microsoft.SqlServer.Rmo(在 Microsoft.SqlServer.Rmo.dll 中)

语法

声明
Public NotInheritable Class MergePullSubscription _
    Inherits PullSubscription
用法
Dim instance As MergePullSubscription
public sealed class MergePullSubscription : PullSubscription
public ref class MergePullSubscription sealed : public PullSubscription
[<SealedAttribute>]
type MergePullSubscription =  
    class
        inherit PullSubscription
    end
public final class MergePullSubscription extends PullSubscription

MergePullSubscription 类型公开以下成员。

构造函数

  名称 说明
公共方法 MergePullSubscription() () () () Creates a new instance of the MergePullSubscription class.
公共方法 MergePullSubscription(String, String, String, String, ServerConnection) Creates a new instance of the MergePullSubscription class with the specified database, Publisher, publication, and Subscriber connection.
公共方法 MergePullSubscription(String, String, String, String, ServerConnection, Boolean) Creates a new instance of the MergePullSubscription class with the specified database, Publisher, publication, Subscriber connection, and whether the agent job is created.

页首

属性

  名称 说明
公共属性 AgentJobId Gets the ID of the agent job used to synchronize the subscription. (从 PullSubscription 继承。)
公共属性 AgentOffload Gets or sets whether or not 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. (从 PullSubscription 继承。)
公共属性 AgentOffloadServer Gets or sets the name of the remote computer where the agent runs when using remote agent activation. (从 PullSubscription 继承。)
公共属性 AgentSchedule Gets the schedule for the agent job used to synchronize the subscription. (从 PullSubscription 继承。)
公共属性 AltSnapshotFolder Gets or sets the location where the publication snapshot files are obtained when the default snapshot location at the Distributor is not used. (从 PullSubscription 继承。)
公共属性 CachePropertyChanges Gets or sets whether to cache changes made to the replication properties or to apply them immediately. (从 ReplicationObject 继承。)
公共属性 ConnectionContext Gets or sets the connection to an instance of Microsoft SQL Server. (从 ReplicationObject 继承。)
公共属性 CreateSyncAgentByDefault Gets or sets whether or not the agent job used to start the Replication Agent to synchronize the subscription is created when the subscription is created. (从 PullSubscription 继承。)
公共属性 DatabaseName Gets or sets the name of the subscription database. (从 PullSubscription 继承。)
公共属性 Description Gets or sets a textual description of the pull subscription. (从 PullSubscription 继承。)
公共属性 DistributorName Gets or sets the instance of Microsoft SQL Server that is the Distributor and is distributing the publication to which the subscription subscribes. (从 PullSubscription 继承。)
公共属性 DistributorSecurity Gets the security context used to connect to the Distributor. (从 PullSubscription 继承。)
公共属性 DynamicSnapshotLocation Gets or sets the file location for the subscription-specific snapshot files when the publication uses a parameterized row filter.
公共属性 EnabledForSynchronizationManager Specifies whether or not the subscription can be synchronized using Windows Synchronization Manager. (从 PullSubscription 继承。)
公共属性 FtpAddress 基础结构。 (从 PullSubscription 继承。)
公共属性 FtpLogin 基础结构。 (从 PullSubscription 继承。)
公共属性 FtpPassword 基础结构。 (从 PullSubscription 继承。)
公共属性 FtpPort 基础结构。 (从 PullSubscription 继承。)
公共属性 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.
公共属性 InternetLogin Gets or sets the login used with HTTP Basic Authentication when connecting to the Web server during Web synchronization.
公共属性 InternetPassword Gets or sets the password for the supplied InternetLogin value when connecting to the Web server during Web synchronization.
公共属性 InternetSecurityMode Gets or sets the HTTP authentication method used when connecting to the Web server during Web synchronization.
公共属性 InternetTimeout Gets or sets the HTTP timeout, in seconds, when connecting to the Web server during Web synchronization.
公共属性 InternetUrl Gets or sets the URL to use when synchronizing the subscription using Web synchronization.
公共属性 IsExistingObject Gets whether the object exists on the server or not. (从 ReplicationObject 继承。)
公共属性 LastAgentDateTime Gets the date and time when the subscription was last synchronized. (从 PullSubscription 继承。)
公共属性 LastAgentStatus Gets the status of the most recent synchronization of the subscription. (从 PullSubscription 继承。)
公共属性 LastAgentSummary Gets a summary of the result of the most recent synchronization of the subscription. (从 PullSubscription 继承。)
公共属性 Name Gets the name generated for the pull subscription. (从 PullSubscription 继承。)
公共属性 Priority Gets or sets the weighting of this server subscription relative to other server subscriptions when resolving conflicts between subscriptions.
公共属性 PublicationDBName Gets or sets the name of the publication database. (从 PullSubscription 继承。)
公共属性 PublicationName Gets or sets the name of the publication to which the subscription subscribes. (从 PullSubscription 继承。)
公共属性 PublisherName Gets or sets the name of the Publisher. (从 PullSubscription 继承。)
公共属性 PublisherSecurity Gets or sets the security context used by the Synchronization Agent when connecting to the Publisher. (从 PullSubscription 继承。)
公共属性 SecureFtpPassword 基础结构。 (从 PullSubscription 继承。)
公共属性 SecureInternetPassword Sets the password (as a SecureString object) used when connecting to the Web server using HTTP Basic Authentication.
公共属性 SqlServerName Gets the name of the Microsoft SQL Server instance to which this object is connected. (从 ReplicationObject 继承。)
公共属性 SubscriberSecurity Gets the security context that is used by the Synchronization Agent when connecting to the Subscriber. (从 PullSubscription 继承。)
公共属性 SubscriberType Gets or sets whether the subscription is a server or client subscription.
公共属性 SubscriptionId Gets the subscription ID value. (从 PullSubscription 继承。)
公共属性 SubscriptionType Gets whether the subscription registration is for a push, pull, or anonymous subscription. (从 PullSubscription 继承。)
公共属性 SynchronizationAgent Gets an object that represents an instance of the Merge Agent that can be used to synchronize the subscription.
公共属性 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. (从 PullSubscription 继承。)
公共属性 SyncType Gets or sets the manner in which data is initialized at the Subscriber.
公共属性 Type 基础结构。 (从 PullSubscription 继承。)
公共属性 UseFtp Gets or sets whether or not the snapshot files needed to initialize the pull subscription are accessed by the Synchronization Agent using File Transfer Protocol (FTP). (从 PullSubscription 继承。)
公共属性 UseInteractiveResolver Gets or sets whether the Interactive Resolver is used during the synchronization process.
公共属性 UserData Gets or sets an object property that allows users to attach their own data to the object. (从 ReplicationObject 继承。)
公共属性 UseWebSynchronization Gets or sets whether the subscription is synchronized using Web synchronization.
公共属性 WorkingDirectory Gets or sets the path of the directory at the Subscriber that is used to temporarily store and decompress downloaded snapshot files. (从 PullSubscription 继承。)

页首

方法

  名称 说明
受保护方法 CheckValidCreation 基础结构。 (从 ReplicationObject 继承。)
受保护方法 CheckValidDefinition 基础结构。 (从 PullSubscription 继承。)
公共方法 CommitPropertyChanges Sends all the cached property change statements to the instance of Microsoft SQL Server. (从 ReplicationObject 继承。)
公共方法 Create Creates the pull subscription on the Subscriber. (从 PullSubscription 继承。)
受保护方法 CustomEnabledForSyncMgr 基础结构。 (从 PullSubscription 继承。)
公共方法 Decouple Decouples the referenced replication object from the server. (从 ReplicationObject 继承。)
公共方法 EnumSynchronizationPartners Returns the Alternate Synchronization Partners
公共方法 Equals (从 Object 继承。)
受保护方法 Finalize (从 Object 继承。)
受保护方法 GetChangeCommand 基础结构。 (从 ReplicationObject 继承。)
受保护方法 GetCreateCommand 基础结构。 (从 ReplicationObject 继承。)
受保护方法 GetDropCommand 基础结构。 (从 ReplicationObject 继承。)
公共方法 GetHashCode (从 Object 继承。)
公共方法 GetType (从 Object 继承。)
受保护方法 InitMemberVariables 基础结构。 (从 PullSubscription 继承。)
受保护方法 InternalRefresh 基础结构。 (从 ReplicationObject 继承。)
公共方法 LastAgentJobHistoryInfo Returns information on the last Synchronization Agent job that was run. (从 PullSubscription 继承。)
公共方法 Load Loads the properties of an existing object from the server. (从 ReplicationObject 继承。)
公共方法 LoadProperties Loads the properties of an existing object from the server. (从 ReplicationObject 继承。)
受保护方法 MemberwiseClone (从 Object 继承。)
公共方法 Refresh Reloads the properties of the object. (从 ReplicationObject 继承。)
公共方法 Reinitialize Marks the merge pull subscription for reinitialization.
公共方法 Remove Removes the pull subscription. (从 PullSubscription 继承。)
公共方法 Script Returns a Transact-SQL script to create or delete the pull subscription based on the current property setting of the PullSubscription object. (从 PullSubscription 继承。)
公共方法 StopSynchronizationJob Attempts to stop a running Merge Agent job that is currently synchronizing the subscription. (覆盖 PullSubscription. . :: . .StopSynchronizationJob() () () ()。)
公共方法 SynchronizeWithJob Starts the agent job asynchronously to synchronize the pull subscription. (覆盖 PullSubscription. . :: . .SynchronizeWithJob() () () ()。)
公共方法 ToString (从 Object 继承。)

页首

注释

For a pull subscription, the Merge Agent runs at the Subscriber.

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.

示例

           // 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 connections to the Publisher and Subscriber.
            ServerConnection subscriberConn = new ServerConnection(subscriberName);
            ServerConnection publisherConn = new ServerConnection(publisherName);

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

            try
            {
                // Connect to the Subscriber.
                subscriberConn.Connect();

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

                if (publication.LoadProperties())
                {
                    if ((publication.Attributes & PublicationAttributes.AllowPull) == 0)
                    {
                        publication.Attributes |= PublicationAttributes.AllowPull;
                    }

                    // Define the pull subscription.
                    subscription = new MergePullSubscription();
                    subscription.ConnectionContext = subscriberConn;
                    subscription.PublisherName = publisherName;
                    subscription.PublicationName = publicationName;
                    subscription.PublicationDBName = publicationDbName;
                    subscription.DatabaseName = subscriptionDbName;
                    subscription.HostName = hostname;

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

                    // Make sure that the agent job for the subscription is created.
                    subscription.CreateSyncAgentByDefault = true;

                    // Create the pull subscription at the Subscriber.
                    subscription.Create();

                    Boolean registered = false;

                    // Verify that the subscription is not already registered.
                    foreach (MergeSubscription existing
                        in publication.EnumSubscriptions())
                    {
                        if (existing.SubscriberName == subscriberName
                            && existing.SubscriptionDBName == subscriptionDbName
                            && existing.SubscriptionType == SubscriptionOption.Pull)
                        {
                            registered = true;
                        }
                    }
                    if (!registered)
                    {
                        // Register the local subscription with the Publisher.
                        publication.MakePullSubscriptionWellKnown(
                            subscriberName, subscriptionDbName,
                            SubscriptionSyncType.Automatic,
                            MergeSubscriberType.Local, 0);
                    }
                }
                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
            {
                subscriberConn.Disconnect();
                publisherConn.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 connections to the Publisher and Subscriber.
Dim subscriberConn As ServerConnection = New ServerConnection(subscriberName)
Dim publisherConn As ServerConnection = New ServerConnection(publisherName)

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

Try
    ' Connect to the Subscriber.
    subscriberConn.Connect()

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

    If publication.LoadProperties() Then
        If (publication.Attributes And PublicationAttributes.AllowPull) = 0 Then
            publication.Attributes = publication.Attributes _
            Or PublicationAttributes.AllowPull
        End If

        ' Define the pull subscription.
        subscription = New MergePullSubscription()
        subscription.ConnectionContext = subscriberConn
        subscription.PublisherName = publisherName
        subscription.PublicationName = publicationName
        subscription.PublicationDBName = publicationDbName
        subscription.DatabaseName = subscriptionDbName
        subscription.HostName = hostname

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

        ' Make sure that the agent job for the subscription is created.
        subscription.CreateSyncAgentByDefault = True

        ' Create the pull subscription at the Subscriber.
        subscription.Create()

        Dim registered As Boolean = False

        ' Verify that the subscription is not already registered.
        For Each existing As MergeSubscription In _
        publication.EnumSubscriptions()
            If existing.SubscriberName = subscriberName Then
                registered = True
            End If
        Next
        If Not registered Then
            ' Register the local subscription with the Publisher.
            publication.MakePullSubscriptionWellKnown( _
             subscriberName, subscriptionDbName, _
             SubscriptionSyncType.Automatic, _
             MergeSubscriberType.Local, 0)
        End If
    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
    subscriberConn.Disconnect()
    publisherConn.Disconnect()
End Try

线程安全

此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。