MergePullSubscription 類別

發行項
02/01/2013

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	基礎結構。Gets or sets the IP address of the FTP server. (繼承自 PullSubscription。)
	FtpLogin	基礎結構。Gets or sets the FTP login. (繼承自 PullSubscription。)
	FtpPassword	基礎結構。Gets or sets the FTP password. (繼承自 PullSubscription。)
	FtpPort	基礎結構。Gets or sets the port number for the FTP server. (繼承自 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	基礎結構。Gets or sets the secured password for the login used to connect to the FTP server. (繼承自 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	基礎結構。Gets or sets the publication 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。)

上層

方法

	名稱	說明
	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。)
	Decouple	Decouples the referenced replication object from the server. (繼承自 ReplicationObject。)
	EnumSynchronizationPartners	Returns the Alternate Synchronization Partners
	Equals	(繼承自 Object。)
	GetHashCode	(繼承自 Object。)
	GetType	(繼承自 Object。)
	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。)
	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.

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 = "AdventureWorks2012Replica";
            string publicationDbName = "AdventureWorks2012";
            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 = "AdventureWorks2012Replica"
Dim publicationDbName As String = "AdventureWorks2012"
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) 成員都是執行緒安全的。並不是所有的執行個體成員都保證可以用於所有的執行緒。

請參閱

參考

Microsoft.SqlServer.Replication 命名空間

其他資源

如何：建立提取訂閱 (RMO 程式設計)

Sales Orders Sample for Merge Replication

共用方式為

MergePullSubscription 類別

繼承階層

語法

建構函式

屬性

方法

備註

Thread Safety

範例

執行緒安全性

請參閱

參考

其他資源

其他資源