MergeSynchronizationAgent Classe

Définition

Espace de noms:: Microsoft.SqlServer.Replication

Assembly:: Microsoft.SqlServer.Replication.dll

Important

Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.

Fournit la fonctionnalité de l’Agent de 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: MarshalByRefObject
MergeSynchronizationAgent

Attributs: ClassInterfaceAttribute ComSourceInterfacesAttribute ComVisibleAttribute GuidAttribute

Implémente: IMergeSynchronizationAgent IDisposable

Exemples

Dans l’exemple suivant, la Synchronize méthode est appelée sur l’instance de la MergeSynchronizationAgent classe qui est accédée depuis la SynchronizationAgent propriété pour synchroniser l’abonnement 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. Parce que l’abonnement pull a été créé en utilisant une valeur de 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 permet d’effectuer les tâches de réplication suivantes :

Synchronisez les abonnements.
Précisez si seule la phase d’upload, uniquement la phase de téléchargement, ou les deux phases sont exécutées pendant la synchronisation.
Validez qu’un abonnement contient les données attendues.
Spécifiez un dossier d’instantanés différent, à partir duquel le premier instantané pour un abonnement peut être appliqué.

Constructeurs

Nom	Description
MergeSynchronizationAgent()	Crée une instance de la classe MergeSynchronizationAgent.

Propriétés

Nom	Description
AlternateSynchronizationPartnerCollection	Il obtient les partenaires de synchronisation alternatifs pour un abonnement.
AltSnapshotFolder	Obtient ou définit le dossier d’instantanés alternatif pour l’abonnement.
ComErrorCollection	Obtient une collection d’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 agit comme distributeur pour l’abonnement.
DistributorAddress	Obtient ou définit l’adresse réseau utilisée pour se connecter au distributeur lorsque la DistributorNetwork propriété est spécifiée.
DistributorEncryptedPassword	Obtient ou règle le mot de passe chiffré par le distributeur.
DistributorLogin	Obtient ou définit le nom de connexion utilisé lors de la connexion au distributeur via l’authentification SQL Server.
DistributorNetwork	Obtient ou définit le Net-Library client utilisé lors de la connexion au distributeur.
DistributorPassword	Définit le mot de passe utilisé lors de la connexion au distributeur via l’authentification SQL Server.
DistributorSecurityMode	Obtient ou règle le mode de sécurité utilisé lors de la connexion au distributeur.
DownloadGenerationsPerBatch	Obtient ou définit le nombre de générations à traiter dans un seul lot lors du téléchargement des modifications du Publisher 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 lors de la synchronisation.
FileTransferType	Obtient ou définit la manière dont les fichiers 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 message d’entrée.
InternetLogin	Obtient ou définit le nom de connexion utilisé lors de la synchronisation Web lors de la connexion au Publisher en utilisant l’authentification Internet.
InternetPassword	Définit le mot de passe de la InternetLogin propriété utilisée avec la synchronisation Web lors de la connexion au Publisher via l’authentification Internet.
InternetProxyLogin	Obtient ou définit le nom de connexion utilisé avec la synchronisation Web lors de la connexion au serveur Web en utilisant un serveur proxy Internet.
InternetProxyPassword	Définit le mot de passe pour la connexion utilisée lors de la synchronisation Web lors de la connexion au serveur Web en utilisant un serveur proxy Internet.
InternetProxyServer	Obtient ou définit le nom du serveur proxy Internet utilisé lors de 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 lors de la synchronisation Web.
InternetTimeout	Obtient ou définit le délai 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 l’heure de la dernière fois que cet agent de réplication a synchronisé l’abonnement.
LoginTimeout	Prend ou règle le nombre maximal de secondes pour attendre que les connexions soient établies.
MetadataRetentionCleanup	Obtenez ou définissez 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 message 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 donne le nom de la publication.
Publisher	Obtient ou définit le nom de l’instance de Microsoft SQL Server qui est le Publisher de l’abonnement.
PublisherAddress	Obtient ou définit l’adresse réseau utilisée pour se connecter au Publisher lorsque la PublisherNetwork propriété est spécifiée.
PublisherChanges	Obtient le nombre total de modifications du Publisher qui ont été appliquées à l’abonné lors de la dernière synchronisation.
PublisherConflicts	Affiche le nombre total de conflits survenus au Publisher lors de 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é par l’éditeur.
PublisherFailoverPartner	Obtient ou définit l’instance partenaire de basculement de SQL Server qui participe à une session de miroir de base 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 Publisher en utilisant l’authentification SQL Server.
PublisherNetwork	Obtient ou définit le Net-Library client utilisé lors de la connexion au Publisher.
PublisherPassword	Définit le mot de passe utilisé lors de la connexion au Publisher en utilisant l’authentification SQL Server.
PublisherSecurityMode	Obtient ou définit le mode de sécurité utilisé lors de la connexion au Publisher.
QueryTimeout	Obtient ou définit le nombre de secondes autorisées pour que les requêtes internes se terminent.
SecureDistributorEncryptedPassword	Obtient ou définit le mot de passe chiffré par distributeur sécurisé.
SecurePublisherEncryptedPassword	Obtient ou définit le mot de passe sécurisé chiffré par l’éditeur.
SecureSubscriberEncryptedPassword	Obtient ou définit le mot de passe sécurisé chiffré pour l’abonné.
Subscriber	Obtient ou définit le nom de l’instance de Microsoft SQL Server qui est l’abonné.
SubscriberChanges	Obtient le nombre total de modifications d’abonné qui ont été appliquées sur le Publisher lors de la dernière synchronisation.
SubscriberConflicts	Affiche le nombre total de conflits survenus au Publisher lors de la dernière synchronisation.
SubscriberDatabase	Obtient ou définit le nom de la base de données par abonnement.
SubscriberDatabasePath	Obtient ou définit le chemin de la base de données des abonnés.
SubscriberDataSourceType	Obtient ou définit le type de source de données utilisé 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é en utilisant l’authentification SQL Server.
SubscriberPassword	Définit le mot de passe utilisé lors de la connexion à l’abonné en utilisant l’authentification SQL Server.
SubscriberSecurityMode	Obtient ou définit le mode de sécurité utilisé lors de la connexion à l’abonné.
SubscriptionType	Obtient ou détermine si l’abonnement est un abonnement push ou pull.
SyncToAlternate	Obtient ou définit si la synchronisation est avec un partenaire de synchronisation alternatif.
UploadGenerationsPerBatch	Obtient ou définit le nombre de générations à traiter dans un seul lot lors de l’upload des modifications de l’Abonné vers le Publisher. Une génération est définie comme un groupe logique de modifications par article.
UseInteractiveResolver	Permet d’obtenir ou de définir si le résolveur interactif est utilisé lors du rapprochement.
UseWebSynchronization	Obtient ou détermine 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 à partir duquel les fichiers instantanés sont consultés lors de l’utilisation du FTP.

Méthodes

Nom	Description
Abort()	Annule la synchronisation.
ClearAllTraceFlags()	Efface tous les drapeaux de trace utilisés par l’agent de synchronisation.
ClearTraceFlag(Int32)	Un drapeau de trace est dégagé.
Dispose()	Libère les ressources non gérées utilisées par MergeSynchronizationAgent.
Dispose(Boolean)	Libère les ressources non gérées utilisées par MergeSynchronizationAgent la classe et libère optionnellement les ressources gérées.
EnableTraceFlag(Int32)	Activez le traçage de drapeau.
Finalize()	Finalise l’agent.
IsSnapshotRequired()	Se connecte au Publisher ou au Distributeur et à l’Abonné pour déterminer si un nouvel instantané sera appliqué lors de la prochaine synchronisation de l’agent.
ProcessMessagesAtPublisher()	Traite les messages chez l’éditeur.
ProcessMessagesAtSubscriber()	Traite les messages à l’abonné.
Synchronize()	Lance l’Agent de fusion pour synchroniser l’abonnement.

Événements

Nom	Description
ComStatus	Se produit lorsque l’Agent de fusion renvoie les informations de statut de la Com de synchronisation.
Status	Se produit lorsque l’Agent de fusion retourne les informations de statut de synchronisation.

S’applique à

Cohérence de thread

Tout membre statique public (partagé dans Visual Basic) de ce type est sécurisé pour les threads. Il n'y a aucune garantie que les membres d’instance soient thread-safe.