sp_addarticle (Transact-SQL)

Gilt für: SQL Server Azure SQL Managed Instance

Erstellt einen Artikel und fügt ihn zu einer Veröffentlichung hinzu. Diese gespeicherte Prozedur wird im Publisher in der Publikationsdatenbank ausgeführt.

Transact-SQL-Syntaxkonventionen

Syntax

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' ]
[ ; ]

Argumente

[ @publication = ] N'Publikation'

Der Name der Publikation, die den Artikel enthält. Der Name muss in der Datenbank eindeutig sein. @publication ist "sysname" ohne Standard.

[ @article = ] N'article'

Der Name des Artikels. Der Name muss innerhalb der Veröffentlichung eindeutig sein. @article ist "sysname" ohne Standard.

[ @source_table = ] N'source_table'

Dieser Parameter ist veraltet; verwenden Sie stattdessen @source_object . @source_table ist nvarchar(386), mit einem Standardwert von NULL. @source_table wird für Oracle Publisher nicht unterstützt.

[ @destination_table = ] N'destination_table'

Der Name der Zieltabelle (Abonnement), falls anders als @source_table oder die gespeicherte Prozedur. @destination_table ist "sysname" mit einem Standardwert von NULL. Wenn dieser Wert festgelegt istNULL, bedeutet dies, dass @source_table @destination_table entspricht.

[ @vertical_partition = ] N'vertical_partition'

Aktiviert und deaktiviert die Spaltenfilterung für einen Tabellenartikel. @vertical_partition ist nchar(5) mit einem Standardwert von false.

• false gibt an, dass keine vertikale Filterung vorhanden ist und alle Spalten veröffentlicht werden.

• true löscht alle Spalten außer dem deklarierten Primärschlüssel, nullfähigen Spalten ohne Standard und eindeutigen Schlüsselspalten. Spalten werden mithilfe von sp_articlecolumn hinzugefügt.

[ @type = ] N'type'

Der Typ des Artikels. @type ist "sysname" mit einem Standardwert von NULL" und kann einer der folgenden Werte sein:

[ @filter = ] N'filter'

Die gespeicherte Prozedur (erstellt mit FOR REPLICATION), die zum horizontalen Filtern der Tabelle verwendet wird. @filter ist nvarchar(386), wobei die Standardeinstellung lautetNULL. Sie müssen sp_articleview ausführen und manuell sp_articlefilter, um die gespeicherte Ansichts- und Filterprozedur zu erstellen. Wenn nicht NULL, wird die Filterprozedur nicht erstellt (vorausgesetzt, die gespeicherte Prozedur wird manuell erstellt).

[ @sync_object = ] N'sync_object'

Der Name der Tabelle oder Ansicht, die zum Erstellen der Datendatei verwendet wird, um die Momentaufnahme für diesen Artikel darzustellen. @sync_object ist nvarchar(386), mit einem Standardwert von NULL. Wenn NULL, sp_articleview aufgerufen wird, um automatisch die Ansicht zu erstellen, die zum Generieren der Ausgabedatei verwendet wird. Dies geschieht nach dem Hinzufügen von Spalten mit sp_articlecolumn. Wenn nicht NULL, wird keine Ansicht erstellt (vorausgesetzt, die Ansicht wird manuell erstellt).

[ @ins_cmd = ] N'ins_cmd'

Der Replikationsbefehlstyp, der beim Replizieren von Einfügungen für diesen Artikel verwendet wird. @ins_cmd ist nvarchar(255), und kann einer der folgenden Werte sein.

Weitere Informationen finden Sie in den Transaktionsartikeln – Angeben, wie Änderungen weitergegeben werden.

[ @del_cmd = ] N'del_cmd'

Der Replikationsbefehlstyp, der beim Replizieren von Löschlöschungen für diesen Artikel verwendet wird. @del_cmd ist "nvarchar(255)" und kann einen der folgenden Werte aufweisen.

Weitere Informationen finden Sie in den Transaktionsartikeln – Angeben, wie Änderungen weitergegeben werden.

[ @upd_cmd = ] N'upd_cmd'

Der Replikationsbefehlstyp, der beim Replizieren von Updates für diesen Artikel verwendet wird. @upd_cmd ist nvarchar(255), und kann einer der folgenden Werte sein.

[ @creation_script = ] N'creation_script'

Der Pfad und der Name eines optionalen Artikelschemaskripts, das zum Erstellen des Artikels in der Abonnementdatenbank verwendet wird. @creation_script ist nvarchar(255), mit einem Standardwert von NULL.

[ @description = ] N'description'

Ein beschreibender Eintrag für den Artikel. @description ist nvarchar(255), mit einem Standardwert von NULL.

[ @pre_creation_cmd = ] N'pre_creation_cmd'

Gibt die vom System durchzuführenden Schritte an, wenn es beim Anwenden der Momentaufnahme für diesen Artikel ein vorhandenes Objekt mit demselben Namen beim Abonnenten erkennt. @pre_creation_cmd ist nvarchar(10) und kann einen der folgenden Werte aufweisen.

[ @filter_clause = ] N'filter_clause'

Eine WHERE-Klausel (Restriction), die einen horizontalen Filter definiert. Wenn Sie die Einschränkungsklausel eingeben, lassen Sie das Schlüsselwort WHERE weg. @filter_clause ist nvarchar(max), mit einem Standardwert von NULL. Weitere Informationen finden Sie unter Filtern von veröffentlichten Daten.

[ @schema_option = ] schema_option

Eine Bitmaske der Schemagenerierungsoption für den angegebenen Artikel. @schema_option ist varbinary(8), mit einem Standardwert von NULL, und kann das | sein (Bitweise ODER) Produkt eines oder mehrerer dieser Werte:

¹ Für Oracle-Herausgeber nicht unterstützt.

Nicht alle @schema_option Werte sind für jeden Replikations- und Artikeltyp gültig. Die Tabelle "Gültige Schemaoptionen " im Abschnitt "Hinweise" zeigt die gültigen Schemaoptionen, die basierend auf der Kombination des Artikeltyps und des Replikationstyps ausgewählt werden können.

[ @destination_owner = ] N'destination_owner'

Der Name des Besitzers des Zielobjekts. @destination_owner ist "sysname" mit einem Standardwert von NULL. Wenn @destination_owner nicht angegeben wird, wird der Besitzer automatisch basierend auf den folgenden Regeln angegeben:

Um Nicht-SQL Server-Abonnenten zu unterstützen, muss @destination_owner sein NULL.

[ @status = ] Status

Gibt an, ob der Artikel aktiv ist. Zudem werden zusätzliche Optionen für die Weitergabe von Änderungen angegeben. @status ist winzig und kann das | (Bitweise ODER) Produkt eines oder mehrerer dieser Werte.

Ein aktiver Artikel mit parametrisierten Anweisungen würde z. B. einen Wert 17 in dieser Spalte aufweisen. Ein Wert von 0 bedeutet, dass der Artikel inaktiv ist und keine zusätzlichen Eigenschaften definiert sind.

[ @source_owner = ] N'source_owner'

Der Besitzer des Quellobjekts. @source_owner ist "sysname" mit einem Standardwert von NULL. @source_owner muss für Oracle Publisher angegeben werden.

[ @sync_object_owner = ] N'sync_object_owner'

Der Besitzer der Ansicht, die den veröffentlichten Artikel definiert. @sync_object_owner ist "sysname" mit einem Standardwert von NULL.

[ @filter_owner = ] N'filter_owner'

Der Besitzer des Filters. @filter_owner ist "sysname" mit der Standardeinstellung "NULL.

[ @source_object = ] N'source_object'

Das datenbankobjekt, das veröffentlicht werden soll. @source_object ist "sysname" mit der Standardeinstellung "NULL. Wenn @source_table ist NULL, kann @source_object nicht sein NULL. @source_object sollten anstelle von @source_table verwendet werden. Weitere Informationen zu den Objekttypen, die mithilfe von Momentaufnahmen oder Transaktionsreplikation veröffentlicht werden können, finden Sie unter Veröffentlichen von Daten und Datenbankobjekten.

[ @artid = ] artid OUTPUT

Die Artikel-ID des neuen Artikels. @artid ist ein OUTPUT-Parameter vom Typ int.

[ @auto_identity_range = ] N'auto_identity_range'

Aktiviert und deaktiviert die automatische Behandlung von Identitätsbereichs für eine Publikation zum Zeitpunkt der Erstellung. @auto_identity_range ist nvarchar(5) und kann einen der folgenden Werte aufweisen:

[ @pub_identity_range = ] pub_identity_range

Steuert die Bereichsgröße in Publisher, wenn der Artikel auf "true" festgelegt @identityrangemanagementoption oder auf "true" festgelegt @auto_identity_range. @pub_identity_range ist großint, mit einem Standardwert von NULL. @pub_identity_range wird für Oracle Publisher nicht unterstützt.

[ @identity_range = ] identity_range

Steuert die Bereichsgröße beim Abonnenten, wenn der Artikel @identityrangemanagementoption auf auto oder @auto_identity_range auf "true" festgelegt ist. @identity_range ist großint, mit einem Standardwert von NULL. Wird verwendet, wenn @auto_identity_range auf "true" festgelegt ist. @identity_range wird für Oracle Publisher nicht unterstützt.

[ @threshold = ] Schwellenwert

Der Prozentwert, der steuert, wann der Verteilungs-Agent einen neuen Identitätsbereich zuweist. Wenn der prozentsatz der in @threshold angegebenen Werte verwendet wird, erstellt die Verteilungs-Agent einen neuen Identitätsbereich. @threshold ist int, mit einem Standardwert von NULL. Wird verwendet, wenn @identityrangemanagementoption auf "automatisch" festgelegt ist oder @auto_identity_range auf "true" festgelegt ist. @threshold wird für Oracle Publisher nicht unterstützt.

[ @force_invalidate_snapshot = ] force_invalidate_snapshot

Erkennt an, dass die von dieser gespeicherten Prozedur ausgeführte Aktion eine vorhandene Momentaufnahme ungültig machen kann. @force_invalidate_snapshot ist bit, mit einem Standardwert von 0.

• 0 Gibt an, dass das Hinzufügen eines Artikels dazu führt, dass die Momentaufnahme ungültig ist. Wenn die gespeicherte Prozedur erkennt, dass die Änderungen eine neue Momentaufnahme erfordern, tritt ein Fehler auf, und es werden keine Änderungen durchgeführt.

• 1 Gibt an, dass das Hinzufügen eines Artikels dazu führen kann, dass die Momentaufnahme ungültig ist, und wenn Abonnements vorhanden sind, die eine neue Momentaufnahme erfordern, die Berechtigung für die vorhandene Momentaufnahme als veraltet gekennzeichnet und eine neue Momentaufnahme generiert werden soll.

[ @use_default_datatypes = ] use_default_datatypes

Gibt an, ob beim Veröffentlichen eines Artikels aus einem Oracle Publisher die Standarddatentypzuordnungen für Spalten verwendet werden. @use_default_datatypes ist bit, mit einem Standardwert von 1.

• 1 = Die standardmäßigen Artikelspaltenzuordnungen werden verwendet. Die Standarddatentypzuordnungen können durch Ausführen von sp_getdefaultdatatypemapping angezeigt werden.

• 0= Benutzerdefinierte Artikelspaltenzuordnungen werden definiert und daher wird sp_articleview nicht aufgerufen.sp_addarticle

Wenn @use_default_datatypes auf "festgelegt" festgelegt 0ist, müssen Sie sp_changearticlecolumndatatype einmal ausführen, damit jede Spaltenzuordnung von der Standardeinstellung geändert wird. Nachdem alle benutzerdefinierten Spaltenzuordnungen definiert wurden, müssen Sie sp_articleview ausführen.

[ @identityrangemanagementoption = ] N'identityrangemanagementoption'

Gibt an, wie die Identitätsbereichsverwaltung für den Artikel gehandhabt wird. @identityrangemanagementoption ist nvarchar(10) und kann einen der folgenden Werte aufweisen.

Aus Gründen der Abwärtskompatibilität wird NULLbeim Wert von @identityrangemanagementoption der Wert @auto_identity_range überprüft. Wenn der Wert von @identityrangemanagementoption jedoch nicht NULList, wird der Wert von @auto_identity_range ignoriert.

Weitere Informationen finden Sie unter Replizieren von Identitätsspalten.

[ @publisher = ] N'publisher'

Gibt einen Nicht-SQL Server-Herausgeber an. @publisher ist "sysname" mit der Standardeinstellung "NULL.

@publisher sollten beim Hinzufügen eines Artikels zu einem SQL Server-Herausgeber nicht verwendet werden.

[ @fire_triggers_on_snapshot = ] N'fire_triggers_on_snapshot'

Wenn replizierte Benutzertrigger ausgeführt werden, wenn die anfängliche Momentaufnahme angewendet wird. @fire_triggers_on_snapshot ist nvarchar(5), mit einem Standardwert von false. true bedeutet, dass Benutzertrigger für eine replizierte Tabelle ausgeführt werden, wenn die Momentaufnahme angewendet wird. Damit Trigger repliziert werden können, muss der Bitmaskenwert von @schema_option den Wert 0x100enthalten.

Rückgabecodewerte

0 (erfolgreich) oder 1 Fehler.

Hinweise

sp_addarticle wird in der Momentaufnahmereplikation oder Transaktionsreplikation verwendet.

Standardmäßig veröffentlicht die Replikation keine Spalten in der Quelltabelle, wenn der Spaltendatentyp von der Replikation nicht unterstützt wird. Wenn Sie eine solche Spalte veröffentlichen müssen, müssen Sie sp_articlecolumn ausführen, um die Spalte hinzuzufügen.

Wird einer Veröffentlichung, die die Peer-zu-Peer-Transaktionsreplikation unterstützt, ein Artikel hinzugefügt, gelten die folgenden Einschränkungen:

• Parametrisierte Anweisungen müssen für alle logbased-Artikel angegeben werden. Sie müssen in den @status Wert einschließen16.

• Name und Besitzer der Ziel- und der Quelltabelle müssen übereinstimmen.

• Der Artikel kann nicht horizontal oder vertikal gefiltert werden.

• Die automatische Verwaltung von Identitätsbereichs wird nicht unterstützt. Sie müssen einen Manuellen Wert für @identityrangemanagementoption angeben.

• Wenn in der Tabelle eine Zeitstempelspalte vorhanden ist, müssen Sie 0x08 in @schema_option einschließen, um die Spalte als Zeitstempel zu replizieren.

• Für @ins_cmd, @upd_cmd und @del_cmd kann kein Wert SQL angegeben werden.

Weitere Informationen finden Sie unter Peer-to-Peer - Transaktionsreplikation.

Wenn Sie Objekte veröffentlichen, werden ihre Definitionen auf Abonnenten kopiert. Wenn Sie ein Datenbankobjekt veröffentlichen, das von einem oder mehreren anderen Objekten abhängt, müssen Sie alle referenzierten Objekte veröffentlichen. Wenn Sie beispielsweise eine Sicht veröffentlichen, die von einer Tabelle abhängt, muss auch die Tabelle veröffentlicht werden.

Wenn @vertical_partition auf "true" festgelegt ist, wird die Erstellung der Ansicht zurückgestellt, sp_addarticle bis sp_articleview aufgerufen wird (nachdem die letzte sp_articlecolumn hinzugefügt wurde).

Wenn die Publikation das Aktualisieren von Abonnements zulässt und die veröffentlichte Tabelle keine eindeutigen Identifikationsspalte enthält, sp_addarticle wird der Tabelle automatisch eine Eindeutigidentifiziererspalte hinzugefügt.

Beim Replizieren auf einen Abonnenten, der keine Instanz von SQL Server (heterogene Replikation) ist, werden nur Transact-SQL-Anweisungen für INSERT, UPDATEund DELETE Befehle unterstützt.

Wenn der Protokollleser-Agent ausgeführt wird, kann das Hinzufügen eines Artikel zu einer Peer-zu-Peer-Veröffentlichung einen Deadlock zwischen dem Protokolllese-Agent und dem Prozess verursachen,der den Artikel hinzufügt. Um dieses Problem zu vermeiden, verwenden Sie vor dem Hinzufügen eines Artikels zu einer Peer-to-Peer-Publikation den Replikationsmonitor, um den Protokollleser-Agent auf dem Knoten zu beenden, in dem Sie den Artikel hinzufügen. Starten Sie den Protokolllese-Agent neu, nachdem Sie den Artikel hinzugefügt haben.

Wenn Sie @del_cmd auf NONE oder @ins_cmd NONEfestlegen, kann die Verteilung von UPDATE Befehlen auch davon betroffen sein, dass diese Befehle nicht gesendet werden, wenn eine begrenzungsgebundene Aktualisierung auftritt. (Bei einer gebundenen Aktualisierung handelt es sich um eine Art von UPDATE Anweisung des Herausgebers, die als DELETE/INSERT Paar für den Abonnenten repliziert wird.)

Standardschemaoptionen

In dieser Tabelle wird der von der Replikation festgelegte Standardwert beschrieben, wenn @schema_options nicht vom Benutzer angegeben wird, wobei dieser Wert vom Replikationstyp (oben dargestellt) und dem Artikeltyp (unten in der ersten Spalte) abhängt.

Gültige Schemaoptionen

In dieser Tabelle werden die zulässigen Werte @schema_option basierend auf dem Replikationstyp (oben dargestellt) und dem Artikeltyp (unten in der ersten Spalte) beschrieben.

Beispiele

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

Berechtigungen

Nur Mitglieder der festen Serverrolle sysadmin oder db_owner feste Datenbankrolle können ausgeführt werden sp_addarticle.

Zugehöriger Inhalt

• Definieren eines Artikels
• 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)
• Gespeicherte Replikationsprozeduren (Transact-SQL)
• Veröffentlichen von Daten und Datenbankobjekten