sp_changepublication (Transact-SQL)

S’applique à : SQL Server Azure SQL Managed Instance

Modifie les propriétés d'une publication. Cette procédure stockée est exécutée sur le serveur de publication dans la base de données de publication.

Conventions de la syntaxe Transact-SQL

Syntaxe

sp_changepublication
    [ [ @publication = ] N'publication' ]
    [ , [ @property = ] N'property' ]
    [ , [ @value = ] N'value' ]
    [ , [ @force_invalidate_snapshot = ] force_invalidate_snapshot ]
    [ , [ @force_reinit_subscription = ] force_reinit_subscription ]
    [ , [ @publisher = ] N'publisher' ]
[ ; ]

Arguments

[ @publication = ] N’publication'

Nom de la publication. @publication est sysname, avec la valeur par défaut NULL.

[ @property = ] N’property'

Propriété de publication à modifier. @property est nvarchar(255), avec la valeur par défaut NULL.

[ @value = ] N’value'

Nouvelle valeur de la propriété . @value est nvarchar(255), avec la valeur par défaut NULL.

Le tableau ci-dessous décrit les propriétés modifiables de la publication et les limites liées aux valeurs de ces propriétés.

Propriété Valeur Description
allow_anonymous true Les abonnements anonymes peuvent être créés pour la publication donnée et immediate_sync doivent également être true. Impossible de modifier les publications d’égal à égal.
false Les abonnements anonymes ne peuvent pas être créés pour la publication donnée. Impossible de modifier les publications d’égal à égal.
allow_initialize_from_backup true Les abonnés peuvent initialiser un abonnement à cette publication à partir d'une sauvegarde au lieu de le faire à partir d'un instantané initial. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
false Les abonnés doivent utiliser l'instantané initial. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
allow_partition_switch true ALTER TABLE...SWITCH les instructions peuvent être exécutées sur la base de données publiée. Pour plus d’informations, consultez Répliquer des tables et des index partitionnés.
false ALTER TABLE...SWITCH les instructions ne peuvent pas être exécutées sur la base de données publiée.
allow_pull true Les abonnements par extraction de données (pull) sont autorisés pour la publication concernée. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
false Les abonnements par extraction ne sont pas autorisés pour la publication donnée. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
allow_push true Les abonnements par envoi de données (push) sont autorisés pour la publication concernée.
false Les abonnements Push ne sont pas autorisés pour la publication donnée.
allow_subscription_copy true Active la possibilité de copier les bases de données qui sont abonnées à la publication. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
false Désactive la possibilité de copier les bases de données qui sont abonnées à la publication. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
alt_snapshot_folder Emplacement du dossier de remplacement pour l'instantané.
centralized_conflicts true Les enregistrements en conflit sont stockés sur le serveur de publication. Ne peut être modifiée qu'en l'absence d'abonnements actifs. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
false Les enregistrements en conflit sont stockés à la fois sur le serveur de publication et sur l'Abonné ayant généré le conflit. Ne peut être modifiée qu'en l'absence d'abonnements actifs. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
compress_snapshot true Un instantané dans un dossier d'instantanés de remplacement est compressé au format de fichier .cab. L’instantané dans le dossier d’instantanés par défaut ne peut pas être compressé.
false L’instantané n’est pas compressé, ce qui est le comportement par défaut pour la réplication.
conflict_policy pub wins Politique de résolution des conflits de mise à jour des Abonnés dans laquelle le serveur de publication l'emporte dans le conflit. Cette propriété ne peut être modifiée qu'en l'absence d'abonnements actifs. Non pris en charge pour les serveurs de publication Oracle.
sub reinit Pour la mise à jour des Abonnés, en cas de conflit, l'abonnement doit être réinitialisé. Cette propriété ne peut être modifiée qu'en l'absence d'abonnements actifs. Non pris en charge pour les serveurs de publication Oracle.
sub wins Politique de résolution des conflits de mise à jour des Abonnés dans laquelle l'Abonné l'emporte dans le conflit. Cette propriété ne peut être modifiée qu'en l'absence d'abonnements actifs. Non pris en charge pour les serveurs de publication Oracle.
conflict_retention Valeur int qui spécifie la période de rétention en conflit, en jours. La rétention par défaut est de 14 jours. 0 signifie qu’aucun nettoyage de conflit n’est nécessaire. Non pris en charge pour les serveurs de publication Oracle.
description Entrée facultative décrivant la publication.
enabled_for_het_sub true Permet à la publication de prendre en charge les abonnés non-SQL Server. enabled_for_het_sub ne peut pas être modifié lorsqu’il existe des abonnements à la publication. Vous devrez peut-être exécuter sp_changepublication pour respecter les exigences suivantes avant de définir enabled_for_het_sub la valeur true :
- allow_queued_tran doit être false.
- allow_sync_tran doit être false.
La modification enabled_for_het_sub peut true modifier les paramètres de publication existants. Pour plus d’informations, consultez Non-SQL Server Subscribers. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
false La publication ne prend pas en charge les abonnés non-SQL Server. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
enabled_for_internet true La publication est activée pour Internet, et le protocole FTP peut être utilisé pour le transfert des fichiers d'instantané vers un abonné. Les fichiers de synchronisation de la publication sont placés dans le répertoire suivant : C:\Program Files\Microsoft SQL Server\MSSQL\Repldata\ftp. ftp_address ne peut pas être NULL. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
false La publication n’est pas activée pour Internet. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
enabled_for_p2p true La publication prend en charge la réplication d'égal à égal. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
Pour définir enabled_for_p2p truela valeur , les restrictions suivantes s’appliquent :
- allow_anonymous doit être false
- allow_dts doit être false.
- allow_initialize_from_backup doit être true
- allow_queued_tran doit être false.
- allow_sync_tran doit être false.
- enabled_for_het_sub doit être false.
- independent_agent doit être true.
- repl_freq doit être continuous.
- replicate_ddl doit être 1.
false La publication ne prend pas en charge la réplication d’égal à égal. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
ftp_address Emplacement accessible par FTP des fichiers d'instantané de la publication. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
ftp_login Nom d’utilisateur utilisé pour se connecter au service FTP et la valeur anonymous est autorisée. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
ftp_password Mot de passe associé au nom d'utilisateur utilisé pour la connexion au service FTP. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
ftp_port Numéro de port du service FTP du serveur de distribution. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
ftp_subdirectory Spécifie l’emplacement où les fichiers d’instantanés sont créés si la publication prend en charge la propagation d’instantanés à l’aide de FTP. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
immediate_sync true Les fichiers de synchronisation sont créés ou recréés à chaque exécution de l'Agent d'instantané. Les abonnés peuvent recevoir les fichiers de synchronisation immédiatement après l’abonnement, si l’Agent d’instantané se termine une fois avant l’abonnement. Les nouveaux abonnements obtiennent les fichiers de synchronisation les plus récents, générés lors de la dernière exécution de l'Agent d'instantané. independent_agent doit également être true. Pour plus d’informations, consultez Effet de la synchronisation immédiate.
false Les fichiers de synchronisation sont créés uniquement lors de nouveaux abonnements. Les abonnés ne peuvent pas recevoir les fichiers de synchronisation après l’abonnement tant que l’Agent d’instantané n’est pas démarré et terminé.
independent_agent true La publication a son propre Agent de distribution dédié.
false La publication utilise un Agent de distribution partagé, et chaque paire base de données de publication/base de données d'abonnement a un Agent partagé.
p2p_continue_onconflict true L'Agent de distribution continue à traiter les modifications lorsqu'un conflit est détecté.

Attention : nous vous recommandons d’utiliser la valeur par défaut de FALSE. Lorsque cette option est définie TRUEsur , l’Agent de distribution tente de converger les données dans la topologie en appliquant la ligne en conflit à partir du nœud qui est l’ID d’origine le plus élevé. Cette méthode ne garantit pas la convergence. Vous devez vous assurer que la topologie est cohérente après la détection d'un conflit. Pour plus d’informations, consultez « Gestion des conflits » dans Peer-to-Peer - Détection des conflits dans la réplication d’égal à égal.
false L'Agent de distribution cesse de traiter les modifications lorsqu'un conflit est détecté.
post_snapshot_script Spécifie l’emplacement d’un fichier de script Transact-SQL que le Agent de distribution s’exécute après que tous les autres scripts d’objet répliqués et les données sont appliqués pendant une synchronisation initiale.
pre_snapshot_script Spécifie l’emplacement d’un fichier de script Transact-SQL exécuté par le Agent de distribution avant que tous les autres scripts et données d’objet répliqués soient appliqués lors d’une synchronisation initiale.
publish_to_ActiveDirectory true Ce paramètre est déconseillé et n’est pris en charge que pour la compatibilité descendante des scripts. Vous ne pouvez plus ajouter d’informations de publication à Microsoft Active Directory.
false Supprime les informations de publication d'Active Directory.
queue_type sql Utilisez SQL Server pour stocker des transactions. Cette propriété ne peut être modifiée qu'en l'absence d'abonnements actifs.

Remarque : La prise en charge de l’utilisation de Microsoft Message Queuing est interrompue. La spécification d’une valeur de msmq @value entraîne une erreur.
redirected_publisher Nom de l’écouteur du groupe de disponibilité. Utilisé dans la réplication d’égal à égal lorsqu’un homologue se trouve dans un groupe de disponibilité. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server. Introduit dans SQL Server 2019 (15.x) CU 13. Pour plus d’informations, consultez Configurer un homologue dans le cadre d’un groupe de disponibilité ou Configurer les deux homologues dans des groupes de disponibilité.
repl_freq continuous Publie la sortie de toutes les transactions enregistrées dans le journal.
snapshot Publie uniquement les événements de synchronisation planifiés.
replicate_ddl 1 Les instructions DDL (Data Definition Language) exécutées sur le serveur de publication sont répliquées. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server.
0 Les instructions DDL ne sont pas répliquées. Cette propriété ne peut pas être modifiée pour les publications autres que SQL Server. La réplication des modifications de schéma ne peut pas être désactivée lors de l’utilisation de la réplication d’égal à égal.
replicate_partition_switch true ALTER TABLE...SWITCH les instructions exécutées sur la base de données publiée doivent être répliquées sur les Abonnés. Cette option est valide uniquement si allow_partition_switch elle est définie sur true. Pour plus d’informations, consultez Répliquer des tables et des index partitionnés.
false ALTER TABLE...SWITCH les instructions ne doivent pas être répliquées sur les Abonnés.
retention int représentant la période de rétention, en heures, pour l’activité d’abonnement. Si un abonnement n’est pas actif pendant la période de rétention, il est supprimé.
snapshot_in_defaultfolder true Les fichiers d'instantané sont stockés dans le dossier d'instantané par défaut. Si alt_snapshot_folder elle est également spécifiée, les fichiers d’instantané sont stockés à la fois dans les emplacements par défaut et dans d’autres emplacements.
false Les fichiers d’instantanés sont stockés dans l’autre emplacement spécifié par alt_snapshot_folder.
status active Les données de publication sont disponibles immédiatement pour les Abonnés lors de la création de la publication. Non pris en charge pour les serveurs de publication Oracle.
inactive Les données de publication ne sont pas disponibles pour les Abonnés lors de la création de la publication. Non pris en charge pour les serveurs de publication Oracle.
sync_method native Utilise la copie en bloc en mode natif de toutes les tables lors de la synchronisation des abonnements.
character Utilise la copie en bloc en mode caractère de toutes les tables lors de la synchronisation des abonnements.
concurrent Utilise la sortie du programme de copie en bloc en mode natif de toutes les tables, mais ne verrouille pas les tables pendant le processus de génération d’instantanés. Non valide pour la réplication d'instantané.
concurrent_c Utilise la sortie du programme de copie en bloc en mode caractère de toutes les tables, mais ne verrouille pas les tables pendant le processus de génération d’instantané. Non valide pour la réplication d'instantané.
taskid Cette propriété est déconseillée et n’est plus prise en charge.
allow_drop true Active la DROP TABLE prise en charge des DLL pour les articles qui font partie de la réplication transactionnelle. Version minimale prise en charge : SQL Server 2014 (12.x) Service Pack 2 ou ultérieur et SQL Server 2016 (13.x) Service Pack 1 ou version ultérieure. Pour plus d’informations, consultez la base de connaissances 3170123
false (valeur par défaut) Désactive la DROP TABLE prise en charge des DLL pour les articles qui font partie de la réplication transactionnelle.
NULL (valeur par défaut) Retourne la liste des valeurs prises en charge pour @property.

[ @force_invalidate_snapshot = ] force_invalidate_snapshot

Reconnaît que l’action effectuée par cette procédure stockée peut invalider un instantané existant. @force_invalidate_snapshot est bit, avec la valeur par défaut 0.

  • 0 spécifie que les modifications apportées à l’article n’entraînent pas l’invalidation de l’instantané. Si la procédure stockée détecte que la modification requiert un nouvel instantané, une erreur se produit et aucune modification n'est effectuée.
  • 1 spécifie que les modifications apportées à l’article peuvent entraîner l’échec de l’instantané. Si certains abonnements existants nécessitent un nouvel instantané, cette valeur autorise le marquage de l'instantané existant comme obsolète, et la génération d'un nouvel instantané.

Consultez la section Remarques pour les propriétés qui, en cas de modification, nécessitent la génération d’un nouvel instantané.

[ @force_reinit_subscription = ] force_reinit_subscription

Confirme que l'action entreprise par cette procédure stockée peut nécessiter la réinitialisation des abonnements existants. @force_reinit_subscription est bit, avec la valeur par défaut 0.

  • 0 spécifie que les modifications apportées à l’article n’entraînent pas la réinitialisation de l’abonnement. Si la procédure stockée détecte que la modification nécessite la réinitialisation des abonnements existants, une erreur se produit et aucune modification n'est effectuée.
  • 1 spécifie que les modifications apportées à l’article entraînent la réinitialisation de l’abonnement existant et autorise la réinitialisation de l’abonnement.

[ @publisher = ] N’publisher'

Spécifie un serveur de publication non-SQL Server. @publisher est sysname, avec la valeur par défaut NULL.

@publisher ne doit pas être utilisé lors de la modification des propriétés d’article sur un serveur de publication SQL Server.

Valeurs des codes de retour

0 (réussite) or 1 (échec).

Notes

sp_changepublication est utilisé dans la réplication d’instantanés et la réplication transactionnelle.

Après avoir modifié l’une des propriétés suivantes, vous devez générer un nouvel instantané, et vous devez spécifier une valeur pour 1 le paramètre @force_invalidate_snapshot .

  • alt_snapshot_folder
  • compress_snapshot
  • enabled_for_het_sub
  • ftp_address
  • ftp_login
  • ftp_password
  • ftp_port
  • ftp_subdirectory
  • post_snapshot_script
  • pre_snapshot_script
  • snapshot_in_defaultfolder
  • sync_mode

Pour répertorier les objets de publication dans Active Directory à l’aide du publish_to_active_directory paramètre, l’objet SQL Server doit déjà être créé dans Active Directory.

Effet de la synchronisation immédiate

Lorsque la synchronisation immédiate est activée, toutes les modifications dans le journal sont suivies immédiatement après la génération de l’instantané initial, même s’il n’existe aucun abonnement. Les modifications journalisées sont utilisées lorsqu’un client utilise la sauvegarde pour ajouter un nouveau nœud homologue. Une fois la sauvegarde restaurée, l’homologue est synchronisé avec toutes les autres modifications qui se produisent après la sauvegarde. Étant donné que les commandes sont suivies dans la base de données de distribution, la logique de synchronisation peut examiner le dernier LSN sauvegardé et l’utiliser comme point de départ, sachant que la commande est disponible si la sauvegarde a été effectuée au cours de la période de rétention maximale. (La valeur par défaut de la période de rétention minimale est de 0 heures et la période de rétention maximale est de 24 heures.)

Lorsque la synchronisation immédiate est désactivée, les modifications sont conservées au moins la période de rétention minimale et nettoyées immédiatement pour toutes les transactions déjà répliquées. Si la synchronisation immédiate est désactivée et configurée avec la période de rétention par défaut, il est probable que les modifications requises après la sauvegarde aient été nettoyées et que le nouveau nœud homologue ne sera pas initialisé correctement. La seule option conssite à suspendre la topologie. L'activation de la synchronisation immédiate offre davantage de flexibilité et est le paramètre recommandé pour la réplication P2P.

Exemples

DECLARE @publication AS sysname
SET @publication = N'AdvWorksProductTran' 

-- Turn off DDL replication for the transactional publication.
USE [AdventureWorks2022]
EXEC sp_changepublication 
  @publication = @publication, 
  @property = N'replicate_ddl', 
  @value = 0
GO

autorisations

Seuls les membres du rôle serveur fixe sysadmin ou db_owner rôle de base de données fixe peuvent s’exécuter sp_changepublication.