MergeSynchronizationAgent Classe

Définition

Fournit les fonctionnalités de l'Agent de fusion de réplication.

public ref class MergeSynchronizationAgent : MarshalByRefObject, IDisposable, Microsoft::SqlServer::Replication::IMergeSynchronizationAgent
[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)]
[System.Runtime.InteropServices.ComSourceInterfaces(typeof(Microsoft.SqlServer.Replication.IComStatusEvent))]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Runtime.InteropServices.Guid("ee5ee47e-6d29-448f-b2d2-f8e632db336a")]
public class MergeSynchronizationAgent : MarshalByRefObject, IDisposable, Microsoft.SqlServer.Replication.IMergeSynchronizationAgent
[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)>]
[<System.Runtime.InteropServices.ComSourceInterfaces(typeof(Microsoft.SqlServer.Replication.IComStatusEvent))>]
[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Runtime.InteropServices.Guid("ee5ee47e-6d29-448f-b2d2-f8e632db336a")>]
type MergeSynchronizationAgent = class
    inherit MarshalByRefObject
    interface IDisposable
    interface IMergeSynchronizationAgent
Public Class MergeSynchronizationAgent
Inherits MarshalByRefObject
Implements IDisposable, IMergeSynchronizationAgent
Héritage
MergeSynchronizationAgent
Attributs
Implémente

Exemples

Dans l’exemple suivant, la Synchronize méthode est appelée sur l’instance de la MergeSynchronizationAgent classe accessible à partir de la SynchronizationAgent propriété pour synchroniser l’abonnement par émission de type push.

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

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

MergeSubscription subscription;

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

    // Define the subscription.
    subscription = new MergeSubscription();
    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 Merge 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 = "AdvWorksSalesOrdersMerge"
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 MergeSubscription

Try
    ' Connect to the Publisher
    conn.Connect()

    ' Define the subscription.
    subscription = New MergeSubscription()
    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 Merge Agent for the subscription.
            ' Log agent messages to an output file.
            subscription.SynchronizationAgent.Output = "mergeagent.log"
            subscription.SynchronizationAgent.OutputVerboseLevel = 2
            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

Dans l’exemple suivant, une instance de la MergeSynchronizationAgent classe est utilisée pour synchroniser un abonnement de fusion. Étant donné que l’abonnement par extraction a été créé à l’aide de la valeur false pour CreateSyncAgentByDefault , des propriétés supplémentaires doivent être fournies.

// Define the server, publication, and database names.
string subscriberName = subscriberInstance;
string publisherName = publisherInstance;
string distributorName = distributorInstance;
string publicationName = "AdvWorksSalesOrdersMerge";
string subscriptionDbName = "AdventureWorks2012Replica";
string publicationDbName = "AdventureWorks2012";
string hostname = @"adventure-works\garrett1";
string webSyncUrl = "https://" + publisherInstance + "/SalesOrders/replisapi.dll";

// Create a connection to the Subscriber.
ServerConnection conn = new ServerConnection(subscriberName);

MergePullSubscription subscription;
MergeSynchronizationAgent agent;

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

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

    // If the pull subscription exists, then start the synchronization.
    if (subscription.LoadProperties())
    {
        // Get the agent for the subscription.
        agent = subscription.SynchronizationAgent;

        // Check that we have enough metadata to start the agent.
        if (agent.PublisherSecurityMode == null)
        {
            // Set the required properties that could not be returned
            // from the MSsubscription_properties table. 
            agent.PublisherSecurityMode = SecurityMode.Integrated;
            agent.DistributorSecurityMode = SecurityMode.Integrated;
            agent.Distributor = publisherName;
            agent.HostName = hostname;

            // Set optional Web synchronization properties.
            agent.UseWebSynchronization = true;
            agent.InternetUrl = webSyncUrl;
            agent.InternetSecurityMode = SecurityMode.Standard;
            agent.InternetLogin = winLogin;
            agent.InternetPassword = winPassword;
        }
        // Enable agent output to the console.
        agent.OutputVerboseLevel = 1;
        agent.Output = "";

        // Synchronously start the Merge Agent for the subscription.
        agent.Synchronize();
    }
    else
    {
        // Do something here if the pull subscription does not exist.
        throw new ApplicationException(String.Format(
            "A 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. Verify that the subscription has " +
        "been defined correctly.", 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 = "AdvWorksSalesOrdersMerge"
Dim subscriptionDbName As String = "AdventureWorks2012Replica"
Dim publicationDbName As String = "AdventureWorks2012"
Dim hostname As String = "adventure-works\garrett1"
Dim webSyncUrl As String = "https://" + publisherInstance + "/SalesOrders/replisapi.dll"

' Create a connection to the Subscriber.
Dim conn As ServerConnection = New ServerConnection(subscriberName)

Dim subscription As MergePullSubscription
Dim agent As MergeSynchronizationAgent

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

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

    ' If the pull subscription exists, then start the synchronization.
    If subscription.LoadProperties() Then
        ' Get the agent for the subscription.
        agent = subscription.SynchronizationAgent

        ' Check that we have enough metadata to start the agent.
        If agent.PublisherSecurityMode = Nothing Then
            ' Set the required properties that could not be returned
            ' from the MSsubscription_properties table. 
            agent.PublisherSecurityMode = SecurityMode.Integrated
            agent.Distributor = publisherInstance
            agent.DistributorSecurityMode = SecurityMode.Integrated
            agent.HostName = hostname

            ' Set optional Web synchronization properties.
            agent.UseWebSynchronization = True
            agent.InternetUrl = webSyncUrl
            agent.InternetSecurityMode = SecurityMode.Standard
            agent.InternetLogin = winLogin
            agent.InternetPassword = winPassword
        End If

        ' Enable agent logging to the console.
        agent.OutputVerboseLevel = 1
        agent.Output = ""

        ' Synchronously start the Merge Agent for the subscription.
        agent.Synchronize()
    Else
        ' Do something here if the pull subscription does not exist.
        Throw New ApplicationException(String.Format( _
         "A 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. Verify that the subscription has " + _
     "been defined correctly.", ex)
Finally
    conn.Disconnect()
End Try

Remarques

La MergeSynchronizationAgent classe prend en charge la possibilité d’effectuer les tâches de réplication suivantes :

  • Synchroniser les abonnements.

  • Spécifiez si seule la phase de téléchargement, uniquement la phase de téléchargement, ou les deux phases sont exécutées pendant la synchronisation.

  • Vérifiez qu’un abonnement dispose des données attendues.

  • Spécifiez un autre dossier d’instantanés, à partir duquel l’instantané initial d’un abonnement peut être appliqué.

Constructeurs

MergeSynchronizationAgent()

Crée une instance de la classe MergeSynchronizationAgent.

Propriétés

AlternateSynchronizationPartnerCollection

Obtient les autres partenaires de synchronisation pour un abonnement.

AltSnapshotFolder

Obtient ou définit l'autre dossier d'instantanés pour l'abonnement.

ComErrorCollection

Obtient une collection des erreurs générées par l'agent de réplication.

Distributor

Obtient ou définit le nom de l'instance de Microsoft SQL Server qui joue le rôle de serveur de distribution pour l'abonnement.

DistributorAddress

Obtient ou définit l’adresse réseau utilisée pour se connecter au serveur de distribution lorsque la DistributorNetwork propriété est spécifiée.

DistributorEncryptedPassword

Obtient ou définit le mot de passe chiffré du serveur de distribution.

DistributorLogin

Obtient ou définit le nom de connexion utilisé lors de la connexion au serveur de distribution à l’aide de l’authentification SQL Server.

DistributorNetwork

Obtient ou définit la Net-Library du client utilisée lors de la connexion au serveur de distribution.

DistributorPassword

Définit le mot de passe utilisé lors de la connexion au serveur de distribution à l’aide de l’authentification SQL Server.

DistributorSecurityMode

Obtient ou définit le mode de sécurité utilisé lors de la connexion au serveur de distribution.

DownloadGenerationsPerBatch

Obtient ou définit le nombre de générations à traiter dans un lot unique lors du téléchargement des modifications du serveur de publication vers l'Abonné. Une génération est définie comme un groupe logique de modifications par article.

DynamicSnapshotLocation

Obtient ou définit l'emplacement de l'instantané partitionné pour cet Abonné.

ExchangeType

Obtient ou définit la manière dont les données sont échangées pendant la synchronisation.

FileTransferType

Obtient ou définit la manière dont les fichiers d'instantanés initiaux sont transférés à l'Abonné.

HostName

Obtient ou définit la valeur utilisée par le Agent de fusion lorsqu’il évalue un filtre paramétré qui utilise la fonction HOST_NAME .

InputMessageFile

Obtient ou définit le fichier de messages d'entrée.

InternetLogin

Obtient ou définit le nom de connexion utilisé avec la synchronisation Web lors de la connexion au serveur de publication à l'aide de l'authentification Internet.

InternetPassword

Définit le mot de passe pour la propriété InternetLogin utilisée avec la synchronisation Web lors de la connexion au serveur de publication à l'aide de l'authentification Internet.

InternetProxyLogin

Obtient ou définit le nom de connexion utilisé avec la synchronisation Web lors de la connexion au serveur Web à l'aide d'un serveur proxy Internet.

InternetProxyPassword

Définit le mot de passe pour la connexion utilisée avec la synchronisation Web lors de la connexion au serveur Web à l'aide d'un serveur proxy Internet.

InternetProxyServer

Obtient ou définit le nom du serveur proxy Internet utilisé avec la synchronisation Web lors de la connexion au serveur Web.

InternetSecurityMode

Obtient ou définit la méthode d'authentification HTTP utilisée lors de la connexion au serveur Web pendant la synchronisation Web.

InternetTimeout

Obtient ou définit le délai d'attente HTTP lors de la connexion au serveur Web.

InternetUrl

Obtient ou définit l'URL du service Web configuré pour la synchronisation Web.

LastUpdatedTime

Obtient le timestamp de la dernière synchronisation de l'abonnement par l'agent de réplication.

LoginTimeout

Obtient ou définit le nombre maximal de secondes écoulées pour établir des connexions.

MetadataRetentionCleanup

Obtient ou détermine s'il faut nettoyer les métadonnées.

Output

Obtient ou définit le fichier de sortie de l'agent.

OutputMessageFile

Obtient ou définit le fichier de messages d'entrée.

OutputVerboseLevel

Obtient ou définit le niveau de détail des informations écrites dans le fichier de sortie de l’agent.

ProfileName

Obtient ou définit le nom du profil utilisé par l'agent.

Publication

Obtient ou définit le nom de la publication.

Publisher

Obtient ou définit le nom de l'instance de Microsoft SQL Server qui représente le serveur de publication pour l'abonnement.

PublisherAddress

Obtient ou définit l'adresse réseau utilisée pour se connecter au serveur de publication lorsque la propriété PublisherNetwork est spécifiée.

PublisherChanges

Obtient le nombre total des modifications du serveur de publication appliquées à l'Abonné pendant la dernière synchronisation.

PublisherConflicts

Obtient le nombre total des conflits qui se sont produits sur le serveur de publication pendant la dernière synchronisation.

PublisherDatabase

Obtient ou définit le nom de la base de données de publication.

PublisherEncryptedPassword

Obtient ou définit le mot de passe chiffré du serveur de publication.

PublisherFailoverPartner

Obtient ou définit l’instance de partenaire de basculement de SQL Server qui participe à une session de mise en miroir de bases de données avec la base de données de publication.

PublisherLogin

Obtient ou définit le nom de connexion utilisé lors de la connexion au serveur de publication à l’aide de l’authentification SQL Server.

PublisherNetwork

Obtient ou définit la Net-Library du client utilisée lors de la connexion au serveur de publication.

PublisherPassword

Définit le mot de passe utilisé lors de la connexion au serveur de publication à l’aide de l’authentification SQL Server.

PublisherSecurityMode

Obtient ou définit le mode de sécurité utilisé lors de la connexion au serveur de publication.

QueryTimeout

Obtient ou définit le nombre de secondes autorisées pour terminer les requêtes internes.

SecureDistributorEncryptedPassword

Obtient ou définit le mot de passe chiffré du serveur de distribution sécurisé.

SecurePublisherEncryptedPassword

Obtient ou définit le mot de passe chiffré et sécurisé du serveur de publication.

SecureSubscriberEncryptedPassword

Obtient ou définit le mot de passe chiffré et sécurisé de l'abonné.

Subscriber

Obtient ou définit le nom de l'instance de Microsoft SQL Server qui représente l'Abonné.

SubscriberChanges

Obtient le nombre total des modifications de l'Abonné appliquées au serveur de publication pendant la dernière synchronisation.

SubscriberConflicts

Obtient le nombre total des conflits qui se sont produits sur le serveur de publication pendant la dernière synchronisation.

SubscriberDatabase

Obtient ou définit le nom de la base de données d'abonnement.

SubscriberDatabasePath

Obtient ou définit le chemin d’accès de la base de données de l’abonné.

SubscriberDataSourceType

Obtient ou définit le type de source de données utilisée en tant qu'Abonné.

SubscriberEncryptedPassword

Obtient ou définit le mot de passe chiffré de l'abonné.

SubscriberLogin

Obtient ou définit le nom de connexion utilisé lors de la connexion à l’abonné à l’aide de l’authentification SQL Server.

SubscriberPassword

Définit le mot de passe utilisé lors de la connexion à l’abonné à l’aide de l’authentification SQL Server.

SubscriberSecurityMode

Obtient ou définit le mode de sécurité utilisé lors de la connexion à l'Abonné.

SubscriptionType

Indique si l'abonnement est un abonnement par extraction ou par émission de données.

SyncToAlternate

Obtient ou définit si la synchronisation s'effectue sur un autre partenaire de synchronisation.

UploadGenerationsPerBatch

Obtient ou définit le nombre de générations à traiter dans un lot unique lors du téléchargement des modifications de l'Abonné vers le serveur de publication. Une génération est définie comme un groupe logique de modifications par article.

UseInteractiveResolver

Obtient ou définit si le programme de résolution interactif est utilisé au cours de la réconciliation.

UseWebSynchronization

Obtient ou définit une valeur indiquant si la synchronisation Web est utilisée.

Validate

Obtient ou définit si la validation des données est effectuée sur les données de l'Abonné à la fin de la synchronisation.

WorkingDirectory

Obtient ou définit le répertoire de travail duquel les fichiers d'instantanés sont accessibles lorsque FTP est utilisé.

Méthodes

Abort()

Annule la synchronisation.

ClearAllTraceFlags()

Efface tous les indicateurs de trace utilisés par l'agent de synchronisation.

ClearTraceFlag(Int32)

Efface un indicateur de trace.

Dispose()

Libère les ressources non managées qui sont utilisées par l'objet MergeSynchronizationAgent.

Dispose(Boolean)

Libère les ressources non managées utilisées par la MergeSynchronizationAgent classe et libère éventuellement les ressources managées.

EnableTraceFlag(Int32)

Active le traçage de l'indicateur.

Finalize()

Finalise l'agent.

IsSnapshotRequired()

Se connecte au serveur de publication ou de distribution et à l'Abonné pour déterminer si un nouvel instantané sera appliqué pendant la synchronisation suivante de l'agent.

ProcessMessagesAtPublisher()

Traite les messages sur le serveur de publication.

ProcessMessagesAtSubscriber()

Traite les messages sur l’abonné.

Synchronize()

Démarre l'Agent de fusion pour synchroniser l'abonnement.

Événements

ComStatus

Se produit lorsque l'Agent de fusion retourne des informations sur l'état de la synchronisation.

Status

Se produit lorsque le Agent de fusion retourne des informations d’état de synchronisation.

S’applique à

Cohérence de thread

Tout membre statique public (Shared en Visual Basic) de ce type est thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.