sp_addarticle (Transact-SQL)

S’applique à : SQL Server Azure SQL Managed Instance

Crée un article et l'ajoute à 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_addarticle
    [ @publication = ] N'publication'
    , [ @article = ] N'article'
    [ , [ @source_table = ] N'source_table' ]
    [ , [ @destination_table = ] N'destination_table' ]
    [ , [ @vertical_partition = ] N'vertical_partition' ]
    [ , [ @type = ] N'type' ]
    [ , [ @filter = ] N'filter' ]
    [ , [ @sync_object = ] N'sync_object' ]
    [ , [ @ins_cmd = ] N'ins_cmd' ]
    [ , [ @del_cmd = ] N'del_cmd' ]
    [ , [ @upd_cmd = ] N'upd_cmd' ]
    [ , [ @creation_script = ] N'creation_script' ]
    [ , [ @description = ] N'description' ]
    [ , [ @pre_creation_cmd = ] N'pre_creation_cmd' ]
    [ , [ @filter_clause = ] N'filter_clause' ]
    [ , [ @schema_option = ] schema_option ]
    [ , [ @destination_owner = ] N'destination_owner' ]
    [ , [ @status = ] status ]
    [ , [ @source_owner = ] N'source_owner' ]
    [ , [ @sync_object_owner = ] N'sync_object_owner' ]
    [ , [ @filter_owner = ] N'filter_owner' ]
    [ , [ @source_object = ] N'source_object' ]
    [ , [ @artid = ] artid OUTPUT ]
    [ , [ @auto_identity_range = ] N'auto_identity_range' ]
    [ , [ @pub_identity_range = ] pub_identity_range ]
    [ , [ @identity_range = ] identity_range ]
    [ , [ @threshold = ] threshold ]
    [ , [ @force_invalidate_snapshot = ] force_invalidate_snapshot ]
    [ , [ @use_default_datatypes = ] use_default_datatypes ]
    [ , [ @identityrangemanagementoption = ] N'identityrangemanagementoption' ]
    [ , [ @publisher = ] N'publisher' ]
    [ , [ @fire_triggers_on_snapshot = ] N'fire_triggers_on_snapshot' ]
[ ; ]

Arguments

[ @publication = ] N’publication'

Nom de la publication qui contient l’article. Le nom doit être unique dans la base de données. @publication est sysname, sans valeur par défaut.

[ @article = ] N’article'

Nom de l’article. Le nom doit être unique dans la publication. @article est sysname, sans valeur par défaut.

[ @source_table = ] N’source_table'

Ce paramètre a été déprécié ; utilisez @source_object à la place. @source_table est nvarchar(386), avec la valeur par défaut NULL. @source_table n’est pas pris en charge pour les serveurs de publication Oracle.

[ @destination_table = ] N’destination_table'

Nom de la table de destination (abonnement), s’il est différent de @source_table ou de la procédure stockée. @destination_table est sysname, avec la valeur par défaut NULL. Si la valeur est définie NULL, cela signifie que @source_table est égal à @destination_table.

[ @vertical_partition = ] N’vertical_partition'

Active ou désactive le filtrage de colonne sur un article de table. @vertical_partition est nchar(5), avec la valeur par défaut false.

• false indique qu’il n’existe aucun filtrage vertical et publie toutes les colonnes.

• true efface toutes les colonnes, à l’exception de la clé primaire déclarée, des colonnes nullables sans valeur par défaut et des colonnes clés uniques. Les colonnes sont ajoutées à l’aide de sp_articlecolumn.

[ @type = ] N’type'

Type d’article. @type est sysname, avec une valeur par défaut NULL, et peut être l’une des valeurs suivantes.

[ @filter = ] N’filter'

Procédure stockée (créée avec FOR REPLICATION) utilisée pour filtrer la table horizontalement. @filter est nvarchar(386), avec la valeur par défaut NULL. Vous devez exécuter sp_articleview et sp_articlefilter manuellement pour créer la procédure stockée d’affichage et de filtre. Si ce n’est pas NULLle cas, la procédure de filtre n’est pas créée (suppose que la procédure stockée est créée manuellement).

[ @sync_object = ] N’sync_object'

Nom de la table ou de la vue utilisée pour produire le fichier de données utilisé pour représenter l’instantané de cet article. @sync_object est nvarchar(386), avec la valeur par défaut NULL. Si NULL, sp_articleview est appelé pour créer automatiquement la vue utilisée pour générer le fichier de sortie. Cela se produit après l’ajout de colonnes avec sp_articlecolumn. Si ce n’est pas NULLle cas, une vue n’est pas créée (suppose que la vue est créée manuellement).

[ @ins_cmd = ] N’ins_cmd'

Type de commande de réplication utilisé lors de la réplication d’insertions pour cet article. @ins_cmd est nvarchar(255) et peut être l’une des valeurs suivantes.

Pour plus d’informations, consultez les articles transactionnels - Spécifier la façon dont les modifications sont propagées.

[ @del_cmd = ] N’del_cmd'

Type de commande de réplication utilisé lors de la réplication des suppressions pour cet article. @del_cmd est nvarchar(255) et peut être l’une des valeurs suivantes.

Pour plus d’informations, consultez les articles transactionnels - Spécifier la façon dont les modifications sont propagées.

[ @upd_cmd = ] N’upd_cmd'

Type de commande de réplication utilisé lors de la réplication des mises à jour pour cet article. @upd_cmd est nvarchar(255) et peut être l’une des valeurs suivantes.

[ @creation_script = ] N’creation_script'

Chemin d’accès et nom d’un script de schéma d’article facultatif utilisé pour créer l’article dans la base de données d’abonnement. @creation_script est nvarchar(255), avec la valeur par défaut NULL.

[ @description = ] N’description'

Entrée descriptive de l’article. @description est nvarchar(255), avec la valeur par défaut NULL.

[ @pre_creation_cmd = ] N’pre_creation_cmd'

Indique l'action que doit entreprendre le système s'il détecte un objet existant de même nom sur l'abonné lors de l'application de l'instantané pour cet article. @pre_creation_cmd est nvarchar(10) et peut être l’une des valeurs suivantes.

[ @filter_clause = ] N’filter_clause'

Clause de restriction (WHERE) qui définit un filtre horizontal. Lorsque vous entrez la clause de restriction, omettez le mot clé WHERE. @filter_clause est nvarchar(max), avec la valeur par défaut NULL. Pour plus d’informations, consultez Filtrer des données publiées.

[ @schema_option = ] schema_option

Masque de bits de l’option de génération de schéma pour l’article donné. @schema_option est varbinary(8), avec une valeur par défaut NULL, et peut être le | (OR au niveau du bit) produit d’une ou plusieurs de ces valeurs :

¹ Non pris en charge pour les serveurs de publication Oracle.

Toutes les valeurs @schema_option ne sont pas valides pour chaque type de réplication et de type d’article. Le tableau Options de schéma valides dans la section Remarques affiche les options de schéma valides qui peuvent être choisies en fonction de la combinaison du type d’article et du type de réplication.

[ @destination_owner = ] N’destination_owner'

Nom du propriétaire de l’objet de destination. @destination_owner est sysname, avec la valeur par défaut NULL. Lorsque @destination_owner n’est pas spécifié, le propriétaire est spécifié automatiquement en fonction des règles suivantes :

Pour prendre en charge les abonnés non-SQL Server, @destination_owner doit être NULL.

[ @status = ] état

Spécifie si l'article est actif et fournit des options supplémentaires pour définir la façon dont les modifications sont propagées. @status est tinyint, et peut être le | (OR au niveau du bit) produit d’une ou plusieurs de ces valeurs.

Par exemple, un article actif utilisant des instructions paramétrables aurait une valeur dans 17 cette colonne. Valeur de 0 signifie que l’article est inactif et qu’aucune propriété supplémentaire n’est définie.

[ @source_owner = ] N’source_owner'

Propriétaire de l’objet source. @source_owner est sysname, avec la valeur par défaut NULL. @source_owner devez être spécifié pour les serveurs de publication Oracle.

[ @sync_object_owner = ] N’sync_object_owner'

Propriétaire de la vue qui définit l’article publié. @sync_object_owner est sysname, avec la valeur par défaut NULL.

[ @filter_owner = ] N’filter_owner'

Propriétaire du filtre. @filter_owner est sysname, avec la valeur par défaut NULL.

[ @source_object = ] N’source_object'

Objet de base de données à publier. @source_object est sysname, avec la valeur par défaut NULL. Si @source_table est NULL, @source_object ne peut pas être NULL. @source_object doit être utilisé au lieu de @source_table. Pour plus d’informations sur les types d’objets qui peuvent être publiés à l’aide d’une réplication d’instantané ou transactionnelle, consultez Publier des données et des objets de base de données.

[ @artid = ] artid OUTPUT

ID d’article du nouvel article. @artid est un paramètre OUTPUT de type int.

[ @auto_identity_range = ] N’auto_identity_range'

Active et désactive la gestion automatique des plages d’identités sur une publication au moment de sa création. @auto_identity_range est nvarchar(5) et peut être l’une des valeurs suivantes :

[ @pub_identity_range = ] pub_identity_range

Contrôle la taille de plage sur le serveur de publication si l’article a @identityrangemanagementoption défini sur automatique ou @auto_identity_range défini sur true. @pub_identity_range est bigint, avec une valeur par défaut de NULL. @pub_identity_range n’est pas pris en charge pour les serveurs de publication Oracle.

[ @identity_range = ] identity_range

Contrôle la taille de plage sur l’Abonné si l’article a @identityrangemanagementoption défini sur automatique ou @auto_identity_range défini sur true. @identity_range est bigint, avec une valeur par défaut de NULL. Utilisé lorsque @auto_identity_range a la valeur true. @identity_range n’est pas pris en charge pour les serveurs de publication Oracle.

[ @threshold = ] seuil

Valeur de pourcentage qui contrôle le moment où l'Agent de distribution affecte une nouvelle plage d'identité. Lorsque le pourcentage de valeurs spécifiées dans @threshold est utilisé, l’Agent de distribution crée une plage d’identités. @threshold est int, avec la valeur par défaut NULL. Utilisé lorsque @identityrangemanagementoption est défini sur automatique ou @auto_identity_range a la valeur true. @threshold n’est pas pris en charge pour les serveurs de publication Oracle.

[ @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 l’ajout d’un article n’entraîne pas l’échec de l’instantané. Si la procédure stockée détecte que la modification requiert un nouvel instantané, un message d'erreur est généré et aucune modification n'est effectuée.

• 1 spécifie que l’ajout d’un article peut rendre l’instantané non valide et, si des abonnements nécessitent un nouvel instantané, donnent l’autorisation à l’instantané existant d’être marqué comme obsolète et qu’un nouvel instantané doit être généré.

[ @use_default_datatypes = ] use_default_datatypes

Indique si les mappages de types de données de colonne par défaut sont utilisés lors de la publication d’un article à partir d’un serveur de publication Oracle. @use_default_datatypes est bit, avec la valeur par défaut 1.

• 1 = les mappages de colonnes d’article par défaut sont utilisés. Les mappages de types de données par défaut peuvent être affichés en exécutant sp_getdefaultdatatypemapping.

• 0 = les mappages de colonnes d’articles personnalisés sont définis et, par conséquent , sp_articleview n’est pas appelé par sp_addarticle.

Lorsque @use_default_datatypes est défini 0sur , vous devez exécuter sp_changearticlecolumndatatype une fois pour chaque mappage de colonnes modifié par défaut. Une fois que tous les mappages de colonnes personnalisés ont été définis, vous devez exécuter sp_articleview.

[ @identityrangemanagementoption = ] N’identityrangemanagementoption'

Spécifie la façon dont la gestion des plages d'identité est gérée pour l'article. @identityrangemanagementoption est nvarchar(10) et peut être l’une des valeurs suivantes.

Pour la compatibilité descendante, lorsque la valeur de @identityrangemanagementoption est NULL, la valeur de @auto_identity_range est vérifiée. Toutefois, lorsque la valeur de @identityrangemanagementoption n’est pas NULL, la valeur de @auto_identity_range est ignorée.

Pour plus d’informations, consultez Répliquer des colonnes d’identité.

[ @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 l’ajout d’un article à un serveur de publication SQL Server.

[ @fire_triggers_on_snapshot = ] N’fire_triggers_on_snapshot'

Si des déclencheurs utilisateur répliqués sont exécutés lorsque l’instantané initial est appliqué. @fire_triggers_on_snapshot est nvarchar(5), avec la valeur par défaut false. true signifie que les déclencheurs utilisateur sur une table répliquée sont exécutés lorsque l’instantané est appliqué. Pour que les déclencheurs soient répliqués, la valeur de masque de bits de @schema_option doit inclure la valeur 0x100.

Valeurs des codes de retour

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

Notes

sp_addarticle est utilisé dans la réplication d’instantanés ou la réplication transactionnelle.

Par défaut, la réplication ne publie aucune colonne dans la table source lorsque le type de données de colonne n’est pas pris en charge par la réplication. Si vous devez publier une telle colonne, vous devez exécuter sp_articlecolumn pour ajouter la colonne.

Lors de l'ajout d'un article à une publication qui prend en charge la réplication transactionnelle d'homologue à homologue, les restrictions suivantes s'appliquent :

• Les instructions paramétrables doivent être spécifiées pour tous les articles logbased. Vous devez inclure 16 dans la valeur @status .

• Le nom et le propriétaire de la table de destination doivent correspondre à la table source.

• L’article ne peut pas être filtré horizontalement ou verticalement.

• La gestion automatique des plages d’identités n’est pas prise en charge. Vous devez spécifier une valeur manuelle pour @identityrangemanagementoption.

• Si une colonne timestamp existe dans la table, vous devez inclure 0x08 dans @schema_option pour répliquer la colonne en tant qu’horodatage.

• Impossible de SQL spécifier une valeur pour @ins_cmd, @upd_cmd et @del_cmd.

Pour plus d’informations, consultez Peer-to-Peer - Réplication transactionnelle.

Lorsque vous publiez des objets, leurs définitions sont copiées sur les abonnés. Si vous publiez un objet de base de données qui dépend d’un ou de plusieurs autres objets, vous devez publier tous les objets référencés. Par exemple, si vous publiez une vue qui dépend d'une table, vous devez publier la table également.

Si @vertical_partition a la valeur true, sp_addarticle reporte la création de la vue jusqu’à ce que sp_articleview soit appelée (après l’ajout du dernier sp_articlecolumn ).

Si la publication autorise la mise à jour des abonnements et que la table publiée n’a pas de colonne uniqueidentifier , sp_addarticle ajoute automatiquement une colonne uniqueidentifier à la table.

Lors de la réplication vers un abonné qui n’est pas une instance de SQL Server (réplication hétérogène), seules les instructions Transact-SQL sont prises en charge pour INSERT, UPDATEet DELETE les commandes.

Lorsque l'Agent de lecture du journal s'exécute, l'ajout d'un article à une publication d'égal à égal peut provoquer un interblocage entre l'Agent de lecture du journal et le processus qui ajoute l'article. Pour éviter ce problème, avant d’ajouter un article à une publication d’égal à égal, utilisez le Moniteur de réplication pour arrêter l’agent de lecture du journal sur le nœud où vous ajoutez l’article. Redémarrez l'Agent de lecture du journal après l'ajout de l'article.

Lorsque vous définissez @del_cmd à NONE ou @ins_cmd NONEà , la propagation des UPDATE commandes peut également être affectée en n’envoyant pas ces commandes lorsqu’une mise à jour limitée se produit. (Une mise à jour limitée est un type d’instruction UPDATE du serveur de publication qui réplique en tant que DELETE/INSERT paire sur l’abonné.)

Options de schéma par défaut

Ce tableau décrit la valeur par défaut définie par la réplication si @schema_options n’est pas spécifié par l’utilisateur, où cette valeur dépend du type de réplication (affiché en haut) et du type d’article (indiqué dans la première colonne).

Options de schéma valides

Ce tableau décrit les valeurs autorisées de @schema_option en fonction du type de réplication (affiché en haut) et du type d’article (indiqué dans la première colonne).

Exemples

DECLARE @publication    AS sysname;
DECLARE @table AS sysname;
DECLARE @filterclause AS nvarchar(500);
DECLARE @filtername AS nvarchar(386);
DECLARE @schemaowner AS sysname;
SET @publication = N'AdvWorksProductTran'; 
SET @table = N'Product';
SET @filterclause = N'[DiscontinuedDate] IS NULL'; 
SET @filtername = N'filter_out_discontinued';
SET @schemaowner = N'Production';

-- Add a horizontally and vertically filtered article for the Product table.
-- Manually set @schema_option to ensure that the Production schema 
-- is generated at the Subscriber (0x8000000).
EXEC sp_addarticle 
    @publication = @publication, 
    @article = @table, 
    @source_object = @table,
    @source_owner = @schemaowner, 
    @schema_option = 0x80030F3,
    @vertical_partition = N'true', 
    @type = N'logbased',
    @filter_clause = @filterclause;

-- (Optional) Manually call the stored procedure to create the 
-- horizontal filtering stored procedure. Since the type is 
-- 'logbased', this stored procedures is executed automatically.
EXEC sp_articlefilter 
    @publication = @publication, 
    @article = @table, 
    @filter_clause = @filterclause, 
    @filter_name = @filtername;

-- Add all columns to the article.
EXEC sp_articlecolumn 
    @publication = @publication, 
    @article = @table;

-- Remove the DaysToManufacture column from the article
EXEC sp_articlecolumn 
    @publication = @publication, 
    @article = @table, 
    @column = N'DaysToManufacture', 
    @operation = N'drop';

-- (Optional) Manually call the stored procedure to create the 
-- vertical filtering view. Since the type is 'logbased', 
-- this stored procedures is executed automatically.
EXEC sp_articleview 
    @publication = @publication, 
    @article = @table,
    @filter_clause = @filterclause;
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_addarticle.

Contenu connexe

• Définir un article
• sp_articlecolumn (Transact-SQL)
• sp_articlefilter (Transact-SQL)
• sp_articleview (Transact-SQL)
• sp_changearticle (Transact-SQL)
• sp_droparticle (Transact-SQL)
• sp_helparticle (Transact-SQL)
• sp_helparticlecolumns (Transact-SQL)
• Procédures stockées de réplication (Transact-SQL)
• Publier des données et des objets de base de données