TransSubscription.SynchronizationAgent Eigenschaft

Definition

Namespace:

Microsoft.SqlServer.Replication

Assembly:

Microsoft.SqlServer.Rmo.dll

Ruft eine Instanz der TransSynchronizationAgent-Klasse ab, die verwendet werden kann, um das Abonnement zu synchronisieren.

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

Eigenschaftswert

TransSynchronizationAgent

Ein TransSynchronizationAgent-Objekt.

Beispiele

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

Hinweise

Rufen Sie die Synchronize Methode für das zurückgegebene TransSynchronizationAgent Objekt auf, um das Abonnement zu synchronisieren.

Sie sollten aufrufen CommitPropertyChanges , um alle Eigenschaftenänderungen auf dem Server zu speichern, bevor Sie das Abonnement abrufen SynchronizationAgent .

Wenn das Abonnement mit einem Wert false für CreateSyncAgentByDefault, einen Verteilungs-Agent Auftrag für das Abonnement erstellt wird, nicht erstellt wird. Möglicherweise müssen Sie zusätzliche Eigenschaften für das zurückgegebene TransSynchronizationAgent Objekt angeben, bevor sie zum Synchronisieren des Abonnements verwendet werden kann.

Die SynchronizationAgent Eigenschaft kann nur von Mitgliedern der sysadmin Festen Serverrolle im Publisher abgerufen werden, Mitglieder der festen Datenbankrolle in der db_owner Publikationsdatenbank oder Mitglieder der Publikationszugriffsliste (PAL) für die Publikation, zu der das Abonnement gehört.

Das SynchronizationAgent Abrufen entspricht dem Ausführen von sp_helpsubscription (Transact-SQL).