Share via

  • Article

Procédure : créer une capture instantanée pour une publication de fusion avec des filtres paramétrables (programmation RMO)

Lorsque vous générez une capture instantanée pour une publication de fusion qui utilise des filtres paramétrables, vous devez commencer par générer une capture instantanée standard (de schéma) qui contient toutes les métadonnées de l'Abonné pour l'abonnement. Ensuite, vous devez générer la partie de la capture instantanée qui contient la partition spécifique à l'Abonné des données publiées. Pour plus d'informations, consultez Procédure : créer la capture instantanée initiale (programmation RMO).

Vous pouvez utiliser les objets RMO (Replication Management Objects) pour générer par programme des captures instantanées partitionnées des manières suivantes :

  • Vous pouvez autoriser les Abonnés à demander la génération et l'application d'une capture instantanée lors de leur première synchronisation.

  • Vous pouvez prégénérer des captures instantanées pour chaque partition.

  • Vous pouvez générer manuellement une capture instantanée pour chaque Abonné en exécutant l'Agent de capture instantanée.

[!REMARQUE]

Lorsque le filtrage d'un article génère des partitions qui ne se chevauchent pas et qui sont uniques pour chaque abonnement (en spécifiant une valeur de NonOverlappingSingleSubscription pour PartitionOption lors de la création d'un article de fusion), les métadonnées sont nettoyées à chaque exécution de l'Agent de fusion. Cela signifie que la capture instantanée partitionnée expire plus rapidement. Lorsque vous optez pour cette méthode, envisagez d'autoriser les Abonnées à demander la génération de captures instantanées. Pour plus d'informations, consultez la section Utilisation des options de filtrage appropriées, dans la rubrique Filtres de lignes paramétrés.

Remarque relative à la sécuritéRemarque relative à la sécurité

Si possible, demandez aux utilisateurs de fournir les informations d'identification de sécurité au moment de l'exécution. Si vous devez stocker des informations d'identification, utilisez les Services de chiffrement fournis par Microsoft Windows .NET Framework.

Pour créer une publication qui permet aux Abonnés d'initialiser la génération et la remise de captures instantanées

  1. Créez une connexion au serveur de publication en utilisant la classe ServerConnection.

  2. Créez une instance de la classe ReplicationDatabase pour la base de données de publication, définissez la propriété ConnectionContext sur l'instance de ServerConnection définie à l'étape 1 et appelez la méthode LoadProperties. Si LoadProperties retourne false, confirmez que la base de données existe.

  3. Si la propriété EnabledMergePublishing a la valeur false, affectez-lui la valeur true et appelez CommitPropertyChanges.

  4. Créez une instance de la classe MergePublication et définissez les propriétés suivantes pour cet objet :

    • La classe ServerConnection créée à l'étape 1 pour la propriété ConnectionContext.

    • Le nom de la base de données publiée pour DatabaseName.

    • Un nom pour la publication pour Name.

    • Le nombre maximal de travaux de capture instantanée dynamique à exécuter pour MaxConcurrentDynamicSnapshots. Comme des demandes de capture instantanée initialisées par l'Abonné peuvent se produire à tout moment, cette propriété limite le nombre des travaux de l'Agent de capture instantanée qui peuvent s'exécuter simultanément lorsque plusieurs Abonnés demandent leur capture instantanée partitionnée au même moment. Lorsque le nombre maximal de travaux s'exécute, des demandes de captures instantanées partitionnées supplémentaires sont mises en file d'attente jusqu'à ce que l'un des travaux en cours d'exécution se termine.

    • Utilisez l'opérateur OR logique de bits (| dans Visual C# et Or dans Visual Basic) pour ajouter la valeur AllowSubscriberInitiatedSnapshot à Attributes.

    • Les champs Login et Password de SnapshotGenerationAgentProcessSecurity pour fournir les informations d'identification pour le compte Microsoft Windows sous lequel le travail de l'Agent de capture instantanée s'exécute.

      [!REMARQUE]

      La définition de SnapshotGenerationAgentProcessSecurity est recommandée lorsque la publication est créée par un membre du rôle serveur fixe sysadmin. Pour plus d'informations, consultez Modèle de sécurité de l'Agent de réplication.

  5. Appelez la méthode Create pour créer la publication.

    Remarque relative à la sécuritéRemarque relative à la sécurité

     Lors de la configuration d'un serveur de publication avec un serveur de distribution distant, les valeurs fournies pour toutes les propriétés, y compris SnapshotGenerationAgentProcessSecurity, sont envoyées sous forme de texte brut au serveur de distribution. Vous devez chiffrer la connexion entre le serveur de publication et son serveur de distribution distant avant d'appeler la méthode Create. Pour plus d'informations, consultez Chiffrement des connexions à SQL Server.

  6. Utilisez la propriété MergeArticle pour ajouter des articles à la publication. Spécifiez la propriété FilterClause pour au moins un article qui définit le filtre paramétrable. (Facultatif) Créez des objets MergeJoinFilter qui définissent des filtres de jointure entre les articles. Pour plus d'informations, consultez Procédure : définir un article (programmation RMO).

  7. Si SnapshotAgentExists a la valeur false, appelez CreateSnapshotAgent pour créer le travail de l'Agent de capture instantanée initiale pour cette publication.

  8. Appelez la méthode StartSnapshotGenerationAgentJob de l'objet MergePublication créé à l'étape 4. Cela démarre le travail de l'agent qui génère la capture instantanée initiale. Pour plus d'informations sur la génération d'une capture instantanée initiale et la définition d'une planification personnalisée pour l'Agent de capture instantanée, consultez Procédure : créer la capture instantanée initiale (programmation RMO).

  9. (Facultatif) Cherchez une valeur true pour la propriété SnapshotAvailable afin de déterminer quand la capture instantanée initiale est prête à être utilisée.

  10. Lorsque l'Agent de fusion pour un Abonné se connecte pour la première fois, une capture instantanée partitionnée est générée automatiquement.

Pour créer une publication et prégénérer ou actualiser automatiquement des captures instantanées

  1. Utilisez une instance de la classe MergePublication pour définir une publication de fusion. Pour plus d'informations, consultez Procédure : créer une publication (programmation RMO).

  2. Utilisez la propriété MergeArticle pour ajouter des articles à la publication. Spécifiez la propriété FilterClause pour au moins un article qui définit le filtre paramétrable et créez tous les objets MergeJoinFilter qui définissent les filtres de jointure entre les articles. Pour plus d'informations, consultez Procédure : définir un article (programmation RMO).

  3. Si SnapshotAgentExists a la valeur false, appelez CreateSnapshotAgent pour créer le travail de l'Agent de capture instantanée pour cette publication.

  4. Appelez la méthode StartSnapshotGenerationAgentJob de l'objet MergePublication créé à l'étape 1. Cette méthode démarre le travail de l'agent qui génère la capture instantanée initiale. Pour plus d'informations sur la génération d'une capture instantanée initiale et la définition d'une planification personnalisée pour l'Agent de capture instantanée, consultez Procédure : créer la capture instantanée initiale (programmation RMO).

  5. Cherchez une valeur true pour la propriété SnapshotAvailable afin de déterminer quand la capture instantanée initiale est prête à être utilisée.

  6. Créez une instance de la classe MergePartition et définissez les critères de filtrage paramétrable pour l'Abonné en utilisant une des propriétés suivantes, ou les deux :

  7. Créez une instance de la classe MergeDynamicSnapshotJob et définissez la même propriété qu'à l'étape 6.

  8. Utilisez la classe ReplicationAgentSchedule pour définir une planification pour générer la capture instantanée filtrée pour la partition de l'Abonné.

  9. Utilisez l'instance de MergePublication de l'étape 1 pour appeler AddMergePartition. Passez l'objet MergePartition créé à l'étape 6.

  10. Utilisez l'instance de MergePublication de l'étape 1 pour appeler la méthode AddMergeDynamicSnapshotJob. Passez l'objet MergeDynamicSnapshotJob créé à l'étape 7 et l'objet ReplicationAgentSchedule créé à l'étape 8.

  11. Appelez EnumMergeDynamicSnapshotJobs et localisez l'objet MergeDynamicSnapshotJob correspondant au travail de capture instantanée partitionnée nouvellement ajouté dans le tableau retourné.

  12. Obtenez la propriété Name pour le travail.

  13. Créez une connexion au serveur de distribution en utilisant la classe ServerConnection.

  14. Créez une instance de la classe Server SMO (SQL Server Management Objects), en passant l'objet ServerConnection créé à l'étape 13.

  15. Créez une instance de la classe Job, en passant la propriété JobServer de l'objet Server créé à l'étape 14 et le nom du travail obtenu à l'étape 12.

  16. Appelez la méthode Start pour démarrer le travail de capture instantanée partitionnée.

  17. Répétez les étapes 6 à 16 pour chaque Abonné.

Pour créer une publication et créer manuellement des captures instantanées pour chaque partition

  1. Utilisez une instance de la classe MergePublication pour définir une publication de fusion. Pour plus d'informations, consultez Procédure : créer une publication (programmation RMO).

  2. Utilisez la propriété MergeArticle pour ajouter des articles à la publication. Spécifiez la propriété FilterClause pour au moins un article qui définit le filtre paramétrable et créez tous les objets MergeJoinFilter qui définissent les filtres de jointure entre les articles. Pour plus d'informations, consultez Procédure : définir un article (programmation RMO).

  3. Générez la capture instantanée initiale. Pour plus d'informations, consultez Procédure : créer la capture instantanée initiale (programmation RMO).

  4. Créez une instance de la classe SnapshotGenerationAgent et définissez les propriétés requises suivantes :

  5. Définissez une valeur de Merge pour ReplicationType.

  6. Définissez une ou plusieurs des propriétés suivantes pour définir les paramètres de partitionnement :

  7. Appelez la méthode GenerateSnapshot.

  8. Répétez les étapes 4 à 7 pour chaque Abonné.

Exemple

Cet exemple crée une publication de fusion qui permet aux Abonnés de demander la génération de captures instantanées.

          // Set the Publisher, publication database, and publication names.
            string publisherName = publisherInstance;
            string publicationName = "AdvWorksSalesOrdersMerge";
            string publicationDbName = "AdventureWorks";

            ReplicationDatabase publicationDb;
            MergePublication publication;

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

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

                // Enable the database for merge publication.               
                publicationDb = new ReplicationDatabase(publicationDbName, conn);
                if (publicationDb.LoadProperties())
                {
                    if (!publicationDb.EnabledMergePublishing)
                    {
                        publicationDb.EnabledMergePublishing = true;
                    }
                }
                else
                {
                    // Do something here if the database does not exist. 
                    throw new ApplicationException(String.Format(
                        "The {0} database does not exist on {1}.",
                        publicationDb, publisherName));
                }

                // Set the required properties for the merge publication.
                publication = new MergePublication();
                publication.ConnectionContext = conn;
                publication.Name = publicationName;
                publication.DatabaseName = publicationDbName;

                // Enable precomputed partitions.
                publication.PartitionGroupsOption = PartitionGroupsOption.True;

                // Specify the Windows account under which the Snapshot Agent job runs.
                // This account will be used for the local connection to the 
                // Distributor and all agent connections that use Windows Authentication.
                publication.SnapshotGenerationAgentProcessSecurity.Login = winLogin;
                publication.SnapshotGenerationAgentProcessSecurity.Password = winPassword;

                // Explicitly set the security mode for the Publisher connection
                // Windows Authentication (the default).
                publication.SnapshotGenerationAgentPublisherSecurity.WindowsAuthentication = true;

                // Enable Subscribers to request snapshot generation and filtering.
                publication.Attributes |= PublicationAttributes.AllowSubscriberInitiatedSnapshot;
                publication.Attributes |= PublicationAttributes.DynamicFilters;

                // Enable pull and push subscriptions.
                publication.Attributes |= PublicationAttributes.AllowPull;
                publication.Attributes |= PublicationAttributes.AllowPush;

                if (!publication.IsExistingObject)
                {
                    // Create the merge publication.
                    publication.Create();
                    
                    // Create a Snapshot Agent job for the publication.
                    publication.CreateSnapshotAgent();
                }
                else
                {
                    throw new ApplicationException(String.Format(
                        "The {0} publication already exists.", publicationName));
                }
            }

            catch (Exception ex)
            {
                // Implement custom application error handling here.
                throw new ApplicationException(String.Format(
                    "The publication {0} could not be created.", publicationName), ex);
            }
            finally
            {
                conn.Disconnect();
            }

' Set the Publisher, publication database, and publication names.
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publicationDbName As String = "AdventureWorks"

Dim publicationDb As ReplicationDatabase
Dim publication As MergePublication

' Create a connection to the Publisher.
Dim conn As ServerConnection = New ServerConnection(publisherName)

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

    ' Enable the database for merge publication.                
    publicationDb = New ReplicationDatabase(publicationDbName, conn)
    If publicationDb.LoadProperties() Then
        If Not publicationDb.EnabledMergePublishing Then
            publicationDb.EnabledMergePublishing = True
        End If
    Else
        ' Do something here if the database does not exist. 
        Throw New ApplicationException(String.Format( _
         "The {0} database does not exist on {1}.", _
         publicationDb, publisherName))
    End If

    ' Set the required properties for the merge publication.
    publication = New MergePublication()
    publication.ConnectionContext = conn
    publication.Name = publicationName
    publication.DatabaseName = publicationDbName

    ' Enable precomputed partitions.
    publication.PartitionGroupsOption = PartitionGroupsOption.True

    ' Specify the Windows account under which the Snapshot Agent job runs.
    ' This account will be used for the local connection to the 
    ' Distributor and all agent connections that use Windows Authentication.
    publication.SnapshotGenerationAgentProcessSecurity.Login = winLogin
    publication.SnapshotGenerationAgentProcessSecurity.Password = winPassword

    ' Explicitly set the security mode for the Publisher connection
    ' Windows Authentication (the default).
    publication.SnapshotGenerationAgentPublisherSecurity.WindowsAuthentication = True

    ' Enable Subscribers to request snapshot generation and filtering.
    publication.Attributes = publication.Attributes Or _
        PublicationAttributes.AllowSubscriberInitiatedSnapshot
    publication.Attributes = publication.Attributes Or _
        PublicationAttributes.DynamicFilters

    ' Enable pull and push subscriptions
    publication.Attributes = publication.Attributes Or _
        PublicationAttributes.AllowPull
    publication.Attributes = publication.Attributes Or _
        PublicationAttributes.AllowPush

    If Not publication.IsExistingObject Then
        ' Create the merge publication.
        publication.Create()

        ' Create a Snapshot Agent job for the publication.
        publication.CreateSnapshotAgent()
    Else
        Throw New ApplicationException(String.Format( _
            "The {0} publication already exists.", publicationName))
    End If
Catch ex As Exception
    ' Implement custom application error handling here.
    Throw New ApplicationException(String.Format( _
        "The publication {0} could not be created.", publicationName), ex)
Finally
    conn.Disconnect()
End Try

Cet exemple crée manuellement la partition de l'Abonné et la capture instantanée filtrée pour une publication de fusion avec des filtres de lignes paramétrables.

           // Define the server, database, and publication names
            string publisherName = publisherInstance;
            string publicationName = "AdvWorksSalesOrdersMerge";
            string publicationDbName = "AdventureWorks";
            string distributorName = publisherInstance;

            MergePublication publication;
            MergePartition partition;
            MergeDynamicSnapshotJob snapshotAgentJob;
            ReplicationAgentSchedule schedule;
            
            // Create a connection to the Publisher.
            ServerConnection publisherConn = new ServerConnection(publisherName);

            // Create a connection to the Distributor to start the Snapshot Agent.
            ServerConnection distributorConn = new ServerConnection(distributorName);

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

                // Set the required properties for the publication.
                publication = new MergePublication();
                publication.ConnectionContext = publisherConn;
                publication.Name = publicationName;
                publication.DatabaseName = publicationDbName;


                // If we can't get the properties for this merge publication, 
                // then throw an application exception.
                if (publication.LoadProperties() || publication.SnapshotAvailable)
                {
                    // Set a weekly schedule for the filtered data snapshot.
                    schedule = new ReplicationAgentSchedule();
                    schedule.FrequencyType = ScheduleFrequencyType.Weekly;
                    schedule.FrequencyRecurrenceFactor = 1;
                    schedule.FrequencyInterval = Convert.ToInt32(0x001);

                    // Set the value of Hostname that defines the data partition. 
                    partition = new MergePartition();
                    partition.DynamicFilterHostName = hostname;
                    snapshotAgentJob = new MergeDynamicSnapshotJob();
                    snapshotAgentJob.DynamicFilterHostName = hostname;

                    // Create the partition for the publication with the defined schedule.
                    publication.AddMergePartition(partition);
                    publication.AddMergeDynamicSnapshotJob(snapshotAgentJob, schedule);
                }
                else
                {
                    throw new ApplicationException(String.Format(
                        "Settings could not be retrieved for the publication, " +
                        " or the initial snapshot has not been generated. " +
                        "Ensure that the publication {0} exists on {1} and " +
                        "that the Snapshot Agent has run successfully.",
                        publicationName, publisherName));
                }
            }
            catch (Exception ex)
            {
                // Do error handling here.
                throw new ApplicationException(string.Format(
                    "The partition for '{0}' in the {1} publication could not be created.",
                    hostname, publicationName), ex);
            }
            finally
            {
                publisherConn.Disconnect();
                if (distributorConn.IsOpen) distributorConn.Disconnect();
            }

' Define the server, database, and publication names
Dim publisherName As String = publisherInstance
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publicationDbName As String = "AdventureWorks"
Dim distributorName As String = publisherInstance

Dim publication As MergePublication
Dim partition As MergePartition
Dim snapshotAgentJob As MergeDynamicSnapshotJob
Dim schedule As ReplicationAgentSchedule

' Create a connection to the Publisher.
Dim publisherConn As ServerConnection = New ServerConnection(publisherName)

' Create a connection to the Distributor to start the Snapshot Agent.
Dim distributorConn As ServerConnection = New ServerConnection(distributorName)

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

    ' Set the required properties for the publication.
    publication = New MergePublication()
    publication.ConnectionContext = publisherConn
    publication.Name = publicationName
    publication.DatabaseName = publicationDbName


    ' If we can't get the properties for this merge publication, 
    ' then throw an application exception.
    If (publication.LoadProperties() Or publication.SnapshotAvailable) Then
        ' Set a weekly schedule for the filtered data snapshot.
        schedule = New ReplicationAgentSchedule()
        schedule.FrequencyType = ScheduleFrequencyType.Weekly
        schedule.FrequencyRecurrenceFactor = 1
        schedule.FrequencyInterval = Convert.ToInt32("0x001", 16)

        ' Set the value of Hostname that defines the data partition. 
        partition = New MergePartition()
        partition.DynamicFilterHostName = hostname
        snapshotAgentJob = New MergeDynamicSnapshotJob()
        snapshotAgentJob.DynamicFilterHostName = hostname

        ' Create the partition for the publication with the defined schedule.
        publication.AddMergePartition(partition)
        publication.AddMergeDynamicSnapshotJob(snapshotAgentJob, schedule)
    Else
        Throw New ApplicationException(String.Format( _
         "Settings could not be retrieved for the publication, " + _
         " or the initial snapshot has not been generated. " + _
         "Ensure that the publication {0} exists on {1} and " + _
         "that the Snapshot Agent has run successfully.", _
         publicationName, publisherName))
    End If
Catch ex As Exception
    ' Do error handling here.
    Throw New ApplicationException(String.Format( _
     "The partition for '{0}' in the {1} publication could not be created.", _
     hostname, publicationName), ex)
Finally
    publisherConn.Disconnect()
    If distributorConn.IsOpen Then
        distributorConn.Disconnect()
    End If
End Try

Cet exemple lance manuellement l'Agent de capture instantanée pour qu'il génère la capture instantanée des données filtrées pour un Abonné à une publication de fusion avec des filtres de lignes paramétrables.

            // Set the Publisher, publication database, and publication names.
            string publicationName = "AdvWorksSalesOrdersMerge";
            string publicationDbName = "AdventureWorks";
            string publisherName = publisherInstance;
            string distributorName = publisherInstance;

            SnapshotGenerationAgent agent;

            try
            {
                // Set the required properties for Snapshot Agent.
                agent = new SnapshotGenerationAgent();
                agent.Distributor = distributorName;
                agent.DistributorSecurityMode = SecurityMode.Integrated;
                agent.Publisher = publisherName;
                agent.PublisherSecurityMode = SecurityMode.Integrated;
                agent.Publication = publicationName;
                agent.PublisherDatabase = publicationDbName;
                agent.ReplicationType = ReplicationType.Merge;

                // Specify the partition information to generate a 
                // filtered snapshot based on Hostname.
                agent.DynamicFilterHostName = hostname;

                // Start the agent synchronously.
                agent.GenerateSnapshot();
            }
            catch (Exception ex)
            {
                // Implement custom application error handling here.
                throw new ApplicationException(String.Format(
                    "A snapshot could not be generated for the {0} publication."
                    , publicationName), ex);
            }

' Set the Publisher, publication database, and publication names.
Dim publicationName As String = "AdvWorksSalesOrdersMerge"
Dim publicationDbName As String = "AdventureWorks"
Dim publisherName As String = publisherInstance
Dim distributorName As String = publisherInstance

Dim agent As SnapshotGenerationAgent

Try
    ' Set the required properties for Snapshot Agent.
    agent = New SnapshotGenerationAgent()
    agent.Distributor = distributorName
    agent.DistributorSecurityMode = SecurityMode.Integrated
    agent.Publisher = publisherName
    agent.PublisherSecurityMode = SecurityMode.Integrated
    agent.Publication = publicationName
    agent.PublisherDatabase = publicationDbName
    agent.ReplicationType = ReplicationType.Merge

    ' Specify the partition information to generate a 
    ' filtered snapshot based on Hostname.
    agent.DynamicFilterHostName = hostname

    ' Start the agent synchronously.
    agent.GenerateSnapshot()
Catch ex As Exception
    ' Implement custom application error handling here.
    Throw New ApplicationException(String.Format( _
     "A snapshot could not be generated for the {0} publication." _
     , publicationName), ex)
End Try