MergePullSubscription Class

Definition

表示对合并发布的请求订阅。Represents a pull subscription to a merge publication.

public ref class MergePullSubscription sealed : Microsoft::SqlServer::Replication::PullSubscription
public sealed class MergePullSubscription : Microsoft.SqlServer.Replication.PullSubscription
type MergePullSubscription = class
    inherit PullSubscription
Public NotInheritable Class MergePullSubscription
Inherits PullSubscription
Inheritance
MergePullSubscription

Examples

// 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

Remarks

对于请求订阅,合并代理在订阅服务器上运行。For a pull subscription, the Merge Agent runs at the Subscriber.

线程安全性Thread Safety

此类型的任何公共静态( Shared 在 Microsoft Visual Basic)成员对于多线程操作是安全的。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.

Constructors

MergePullSubscription()

创建 MergePullSubscription 类的新实例。Creates a new instance of the MergePullSubscription class.

MergePullSubscription(String, String, String, String, ServerConnection)

MergePullSubscription用指定的数据库、发布服务器、发布和订阅服务器连接初始化类的新实例。Initializes a new instance of the MergePullSubscription class with the specified database, Publisher, publication, and Subscriber connection.

MergePullSubscription(String, String, String, String, ServerConnection, Boolean)

使用指定的数据库、发布服务器、发布、订阅服务器连接以及是否创建代理作业来创建 MergePullSubscription 类的新实例。Creates a new instance of the MergePullSubscription class with the specified database, Publisher, publication, Subscriber connection, and whether the agent job is created.

Properties

AgentJobId

获取用于同步订阅的代理作业的 ID。Gets the ID of the agent job used to synchronize the subscription.

(Inherited from 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. 对于运行 Microsoft SQL Server 2005 及更高版本的分发服务器, 不再支持该属性。This property is no longer supported for Distributors running Microsoft SQL Server 2005 and later.

(Inherited from PullSubscription)
AgentOffloadServer

获取或设置在使用远程代理激活时运行代理的远程计算机的名称。Gets or sets the name of the remote computer where the agent runs when using remote agent activation.

(Inherited from PullSubscription)
AgentSchedule

获取用于同步订阅的代理作业的计划。Gets the schedule for the agent job used to synchronize the subscription.

(Inherited from 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.

(Inherited from PullSubscription)
CachePropertyChanges

获取或设置是缓存对复制属性所做的更改还是立即应用它们。Gets or sets whether to cache changes made to the replication properties or to apply them immediately.

(Inherited from ReplicationObject)
ConnectionContext

获取或设置与 Microsoft SQL Server 实例的连接。Gets or sets the connection to an instance of Microsoft SQL Server.

(Inherited from 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.

(Inherited from PullSubscription)
DatabaseName

获取或设置订阅数据库的名称。Gets or sets the name of the subscription database.

(Inherited from PullSubscription)
Description

获取或设置请求订阅的文本说明。Gets or sets a textual description of the pull subscription.

(Inherited from PullSubscription)
DistributorName

获取或设置 Microsoft SQL Server 的实例, 该实例为分发服务器, 并且正在分发订阅所订阅的发布。Gets or sets the instance of Microsoft SQL Server that is the Distributor and is distributing the publication to which the subscription subscribes.

(Inherited from PullSubscription)
DistributorSecurity

获取用于连接到分发服务器的安全上下文。Gets the security context used to connect to the Distributor.

(Inherited from PullSubscription)
DynamicSnapshotLocation

获取或设置在发布使用参数化行筛选器时特定于订阅的快照文件的文件位置。Gets or sets the file location for the subscription-specific snapshot files when the publication uses a parameterized row filter.

EnabledForSynchronizationManager

指定是否可以使用 Windows 同步管理器同步订阅。Specifies whether or not the subscription can be synchronized using Windows Synchronization Manager.

(Inherited from PullSubscription)
FtpAddress

获取或设置 FTP 服务器的 IP 地址。Gets or sets the IP address of the FTP server.

(Inherited from PullSubscription)
FtpLogin

获取或设置 FTP 登录名。Gets or sets the FTP login.

(Inherited from PullSubscription)
FtpPassword

获取或设置 FTP 密码。Gets or sets the FTP password.

(Inherited from PullSubscription)
FtpPort

获取或设置 FTP 服务器的端口号。Gets or sets the port number for the FTP server.

(Inherited from PullSubscription)
HostName

获取或设置在定义订阅服务器的数据分区的参数化行筛选器中使用此函数时提供给HOST_NAME函数的值。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

获取或设置在 Web 同步过程中连接到 Web 服务器时用于 HTTP 基本身份验证的登录名。Gets or sets the login used with HTTP Basic Authentication when connecting to the Web server during Web synchronization.

InternetPassword

获取或设置在 Web 同步过程中连接到 Web 服务器时用于提供的 InternetLogin 值的密码。Gets or sets the password for the supplied InternetLogin value when connecting to the Web server during Web synchronization.

InternetSecurityMode

获取或设置在 Web 同步过程中连接到 Web 服务器时使用的 HTTP 身份验证方法。Gets or sets the HTTP authentication method used when connecting to the Web server during Web synchronization.

InternetTimeout

获取或设置在 Web 同步过程中连接到 Web 服务器时的 HTTP 超时值(以秒为单位)。Gets or sets the HTTP timeout, in seconds, when connecting to the Web server during Web synchronization.

InternetUrl

获取或设置在使用 Web 同步来同步订阅时要使用的 URL。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.

(Inherited from ReplicationObject)
IsMemoryOptimized (Inherited from PullSubscription)
LastAgentDateTime

获取上次同步订阅的日期和时间。Gets the date and time when the subscription was last synchronized.

(Inherited from PullSubscription)
LastAgentStatus

获取订阅的最近同步的状态。Gets the status of the most recent synchronization of the subscription.

(Inherited from PullSubscription)
LastAgentSummary

获取订阅的最新同步的结果的摘要。Gets a summary of the result of the most recent synchronization of the subscription.

(Inherited from PullSubscription)
Name

获取为请求订阅生成的名称。Gets the name generated for the pull subscription.

(Inherited from 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.

(Inherited from PullSubscription)
PublicationName

获取或设置订阅要订阅的发布的名称。Gets or sets the name of the publication to which the subscription subscribes.

(Inherited from PullSubscription)
PublisherName

获取或设置发布服务器的名称。Gets or sets the name of the Publisher.

(Inherited from PullSubscription)
PublisherSecurity

获取或设置在连接到发布服务器时同步代理使用的安全上下文。Gets or sets the security context used by the Synchronization Agent when connecting to the Publisher.

(Inherited from PullSubscription)
SecureFtpPassword

获取或设置用于连接到 FTP 服务器的登录名的安全密码。Gets or sets the secured password for the login used to connect to the FTP server.

(Inherited from PullSubscription)
SecureInternetPassword

设置在使用 HTTP 基本身份验证连接到 Web 服务器时使用的密码(作为 SecureString 对象)。Sets the password (as a SecureString object) used when connecting to the Web server using HTTP Basic Authentication.

SqlServerName

获取此对象连接到的 Microsoft SQL Server 实例的名称。Gets the name of the Microsoft SQL Server instance to which this object is connected.

(Inherited from ReplicationObject)
SubscriberSecurity

获取同步代理连接到订阅服务器时使用的安全上下文。Gets the security context that is used by the Synchronization Agent when connecting to the Subscriber.

(Inherited from PullSubscription)
SubscriberType

获取或设置订阅是服务器订阅还是客户端订阅。Gets or sets whether the subscription is a server or client subscription.

SubscriptionId

获取订阅 ID 值。Gets the subscription ID value.

(Inherited from PullSubscription)
SubscriptionType

获取订阅注册是否用于推送、请求或匿名订阅。Gets whether the subscription registration is for a push, pull, or anonymous subscription.

(Inherited from PullSubscription)
SynchronizationAgent

获取一个对象,该对象表示可用于同步订阅的合并代理的实例。Gets an object that represents an instance of the Merge Agent that can be used to synchronize the subscription.

SynchronizationAgentProcessSecurity

获取用于指定运行同步代理作业以同步订阅的 Microsoft Windows 帐户的安全上下文。Gets the security context that is used to specify the Microsoft Windows account under which the Synchronization Agent job runs to synchronize the subscription.

(Inherited from PullSubscription)
SyncType

获取或设置在订阅服务器上初始化数据的方式。Gets or sets the manner in which data is initialized at the Subscriber.

Type

获取或设置发布类型。Gets or sets the publication type.

(Inherited from PullSubscription)
UseFtp

获取或设置同步代理是否使用文件传输协议 (FTP) 访问初始化请求订阅所需的快照文件。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).

(Inherited from 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.

(Inherited from ReplicationObject)
UseWebSynchronization

获取或设置是否使用 Web 同步来同步订阅。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.

(Inherited from PullSubscription)

Methods

CheckValidCreation()

检查有效复制创建。Checks the valid replication creation.

(Inherited from ReplicationObject)
CheckValidDefinition(Boolean)

指示定义是否有效。Indicates whether the definition if valid.

(Inherited from PullSubscription)
CommitPropertyChanges()

将所有缓存的属性更改语句发送到 Microsoft SQL Server 的实例。Sends all the cached property change statements to the instance of Microsoft SQL Server.

(Inherited from ReplicationObject)
Create()

在订阅服务器上创建请求订阅。Creates the pull subscription on the Subscriber.

(Inherited from PullSubscription)
CustomEnabledForSyncMgr(StringBuilder)

启用同步管理器的自定义发布。Enables the custom publication for synchronous manager.

(Inherited from PullSubscription)
Decouple()

将引用的复制对象与服务器相分离。Decouples the referenced replication object from the server.

(Inherited from ReplicationObject)
EnumSynchronizationPartners()

返回备用同步伙伴。Returns the Alternate Synchronization Partners

GetChangeCommand(StringBuilder, String, String)

从复制返回更改命令。Returns the change command from the replication.

(Inherited from ReplicationObject)
GetCreateCommand(StringBuilder, Boolean, ScriptOptions)

从复制返回创建命令。Returns the create command from the replication.

(Inherited from ReplicationObject)
GetDropCommand(StringBuilder, Boolean)

从复制返回删除命令。Returns the drop command from the replication.

(Inherited from ReplicationObject)
InitMemberVariables(String, String, String, String, Boolean)

初始化成员变量。Initializes the member variables.

(Inherited from PullSubscription)
InternalRefresh(Boolean)

从复制启动内部刷新。Initiates an internal refresh from the replication.

(Inherited from ReplicationObject)
LastAgentJobHistoryInfo()

返回有关上次运行的同步代理作业的信息。Returns information on the last Synchronization Agent job that was run.

(Inherited from PullSubscription)
Load()

从服务器加载现有对象的属性。Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
LoadProperties()

从服务器加载现有对象的属性。Loads the properties of an existing object from the server.

(Inherited from ReplicationObject)
Refresh()

重新加载该对象的属性。Reloads the properties of the object.

(Inherited from ReplicationObject)
Reinitialize(Boolean)

将合并请求订阅标记为要重新初始化。Marks the merge pull subscription for reinitialization.

Remove()

删除请求订阅。Removes the pull subscription.

(Inherited from PullSubscription)
Script(ScriptOptions)

返回一个用于-根据PullSubscription对象的当前属性设置创建或删除请求订阅的 transact-sql 脚本。Returns a Transact-SQL script to create or delete the pull subscription based on the current property setting of the PullSubscription object.

(Inherited from PullSubscription)
StopSynchronizationJob()

尝试停止当前正在同步订阅的运行中的合并代理作业。Attempts to stop a running Merge Agent job that is currently synchronizing the subscription.

SynchronizeWithJob()

异步启动代理作业以便同步请求订阅。Starts the agent job asynchronously to synchronize the pull subscription.

Applies to

See also