TransSubscription.SynchronizationAgent 属性

定义

获取可用于同步订阅的 TransSynchronizationAgent 类的实例。

public:
 property Microsoft::SqlServer::Replication::TransSynchronizationAgent ^ SynchronizationAgent { Microsoft::SqlServer::Replication::TransSynchronizationAgent ^ get(); };
public Microsoft.SqlServer.Replication.TransSynchronizationAgent SynchronizationAgent { get; }
member this.SynchronizationAgent : Microsoft.SqlServer.Replication.TransSynchronizationAgent
Public ReadOnly Property SynchronizationAgent As TransSynchronizationAgent

属性值

TransSynchronizationAgent

TransSynchronizationAgent 对象。

示例

// Define the server, publication, and database names.
string subscriberName = subscriberInstance;
string publisherName = publisherInstance;
string publicationName = "AdvWorksProductTran";
string subscriptionDbName = "AdventureWorks2012Replica";
string publicationDbName = "AdventureWorks2012";

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

TransSubscription subscription;

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

    // Define the push subscription.
    subscription = new TransSubscription();
    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 Distribution 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 = "AdvWorksProductTran"
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 TransSubscription

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

    ' Define the push subscription.
    subscription = New TransSubscription()
    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 Distribution 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.")
        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

注解

Synchronize 返回的对象调用方法 TransSynchronizationAgent ,以便同步订阅。

CommitPropertyChanges 检索以同步订阅之前,应调用以在服务器上保存任何属性更改 SynchronizationAgent

如果创建的订阅的值 falseCreateSyncAgentByDefault ,则不会创建订阅的分发代理作业。 可能需要在返回的对象上指定其他属性, TransSynchronizationAgent 然后才能将其用于同步订阅。

SynchronizationAgent只有 sysadmin 发布服务器上的固定服务器角色的成员、 db_owner 发布数据库中固定数据库角色的成员或该订阅所属的发布的发布访问列表(PAL)的成员才能检索属性。

检索 SynchronizationAgent 等效于执行Sp_helpsubscription (transact-sql)

适用于