Is the name of the publication that contains the article. The name must be unique in the database. publication is sysname, with no default.

[ @article = ] 'article'

Is the name of the article. The name must be unique within the publication. article is sysname, with no default.

[ @source_table = ] 'source_table'

This parameter has been deprecated; use source_object instead.

This parameter is not supported for Oracle Publishers.

[ @destination_table = ] 'destination_table'

Is the name of the destination (subscription) table, if different from source_tableor the stored procedure. destination_table is sysname, with a default of NULL, which means that source_table equals destination_table.

[ @vertical_partition = ] 'vertical_partition'

Enables and disables column filtering on a table article. vertical_partition is nchar(5), with a default of FALSE.

false indicates there is no vertical filtering and publishes all columns.

true clears all columns except the declared primary key, nullable columns with no default, and unique key columns. Columns are added using sp_articlecolumn.

[ @type = ] 'type'

Is the type of article. type is sysname, and can be one of the following values.

Value

Description

aggregate schema only

Aggregate function with schema only.

func schema only

Function with schema only.

indexed view logbased

Log-based indexed view article. Not supported for Oracle Publishers. For this type of article, the base table does not need to be published separately.

indexed view logbased manualboth

Log-based indexed view article with manual filter and manual view. This option requires that you specify both sync_object and filter parameters. For this type of article, the base table does not need to be published separately. Not supported for Oracle Publishers.

indexed view logbased manualfilter

Log-based indexed view article with manual filter. This option requires that you specify both sync_object and filter parameters. For this type of article, the base table does not need to be published separately. Not supported for Oracle Publishers.

indexed view logbased manualview

Log-based indexed view article with manual view. This option requires that you specify the sync_object parameter. For this type of article, the base table does not need to be published separately. Not supported for Oracle Publishers.

indexed view schema only

Indexed view with schema only. For this type of article, the base table must also be published.

logbased (default)

Log-based article.

logbased manualboth

Log-based article with manual filter and manual view. This option requires that you specify both sync_object and filter parameters. Not supported for Oracle Publishers.

logbased manualfilter

Log-based article with manual filter. This option requires that you specify both sync_object and filter parameters. Not supported for Oracle Publishers.

logbased manualview

Log-based article with manual view. This option requires that you specify the sync_object parameter. Not supported for Oracle Publishers.

proc exec

Replicates the execution of the stored procedure to all Subscribers of the article. Not supported for Oracle Publishers. We recommend that you use the option serializable proc exec instead of proc exec. For more information, see the section "Types of Stored Procedure Execution Articles" in Publishing Stored Procedure Execution in Transactional Replication. Not available when change data capture is enabled.

proc schema only

Procedure with schema only. Not supported for Oracle Publishers.

serializable proc exec

Replicates the execution of the stored procedure only if it is executed within the context of a serializable transaction. Not supported for Oracle Publishers.

The procedure also must be executed inside an explicit transaction for the procedure execution to be replicated.

view schema only

View with schema only. Not supported for Oracle Publishers. When using this option, you must also publish the base table.

[ @filter = ] 'filter'

Is the stored procedure (created with FOR REPLICATION) used to filter the table horizontally. filter is nvarchar(386), with a default of NULL. sp_articleview and sp_articlefilter must be executed manually to create the view and filter stored procedure. If not NULL, the filter procedure is not created (assumes the stored procedure is created manually).

[ @sync_object = ] 'sync_object'

Is the name of the table or view used for producing the data file used to represent the snapshot for this article. sync_object is nvarchar(386), with a default of NULL. If NULL, sp_articleview is called to automatically create the view used to generate the output file. This occurs after adding any columns with sp_articlecolumn. If not NULL, a view is not created (assumes the view is manually created).

[ @ins_cmd = ] 'ins_cmd'

Is the replication command type used when replicating inserts for this article. ins_cmd is nvarchar(255), and can be one of the following values.

Value

Description

NONE

No action is taken.

CALL sp_MSins_table (default)

-or-

CALL custom_stored_procedure_name

Calls a stored procedure to be executed at the Subscriber. To use this method of replication, use schema_option to specify automatic creation of the stored procedure, or create the specified stored procedure in the destination database of each Subscriber of the article. custom_stored_procedure is the name of a user-created stored procedure. sp_MSins_table contains the name of the destination table in place of the _table part of the parameter. When destination_owner is specified, it is prepended to the destination table name. For example, for the ProductCategory table owned by the Production schema at the Subscriber, the parameter would be CALL sp_MSins_ProductionProductCategory. For an article in a peer-to-peer replication topology, _table is appended with a GUID value. Specifying custom_stored_procedure is not supported for updating subscribers.

SQL or NULL

Replicates an INSERT statement. The INSERT statement is provided values for all columns published in the article. This command is replicated on inserts:

Is the replication command type used when replicating deletes for this article. del_cmd is nvarchar(255), and can be one of the following values.

Value

Description

NONE

No action is taken.

CALLsp_MSdel_table (default)

-or-

CALL custom_stored_procedure_name

Calls a stored procedure to be executed at the Subscriber. To use this method of replication, use schema_option to specify automatic creation of the stored procedure, or create the specified stored procedure in the destination database of each Subscriber of the article. custom_stored_procedure is the name of a user-created stored procedure. sp_MSdel_table contains the name of the destination table in place of the _table part of the parameter. When destination_owner is specified, it is prepended to the destination table name. For example, for the ProductCategory table owned by the Production schema at the Subscriber, the parameter would be CALL sp_MSdel_ProductionProductCategory. For an article in a peer-to-peer replication topology, _table is appended with a GUID value. Specifying custom_stored_procedure is not supported for updating subscribers.

XCALL sp_MSdel_table

-or-

XCALL custom_stored_procedure_name

Calls a stored procedure taking XCALL style parameters. To use this method of replication, use schema_option to specify automatic creation of the stored procedure, or create the specified stored procedure in the destination database of each Subscriber of the article. Specifying a user-created stored procedure is not allowed for updating subscribers.

SQL or NULL

Replicates a DELETE statement. The DELETE statement is provided all primary key column values. This command is replicated on deletes:

Is the replication command type used when replicating updates for this article. upd_cmd is nvarchar(255), and can be one of the following values.

Value

Description

NONE

No action is taken.

CALL sp_MSupd_table

-or-

CALL custom_stored_procedure_name

Calls a stored procedure to be executed at the Subscriber. To use this method of replication, use schema_option to specify automatic creation of the stored procedure, or create the specified stored procedure in the destination database of each Subscriber of the article.

MCALL sp_MSupd_table

-or-

MCALL custom_stored_procedure_name

Calls a stored procedure taking MCALL style parameters. To use this method of replication, use schema_option to specify automatic creation of the stored procedure, or create the specified stored procedure in the destination database of each Subscriber of the article. custom_stored_procedure is the name of a user-created stored procedure. sp_MSupd_table contains the name of the destination table in place of the _table part of the parameter. When destination_owner is specified, it is prepended to the destination table name. For example, for the ProductCategory table owned by the Production schema at the Subscriber, the parameter would be MCALL sp_MSupd_ProductionProductCategory. For an article in a peer-to-peer replication topology, _table is appended with a GUID value. Specifying a user-created stored procedure is not allowed for updating subscribers.

SCALL sp_MSupd_table (default)

-or-

SCALL custom_stored_procedure_name

Calls a stored procedure taking SCALL style parameters. To use this method of replication, use schema_option to specify automatic creation of the stored procedure, or create the specified stored procedure in the destination database of each Subscriber of the article. custom_stored_procedure is the name of a user-created stored procedure. sp_MSupd_table contains the name of the destination table in place of the _table part of the parameter. When destination_owner is specified, it is prepended to the destination table name. For example, for the ProductCategory table owned by the Production schema at the Subscriber, the parameter would be SCALL sp_MSupd_ProductionProductCategory. For an article in a peer-to-peer replication topology, _table is appended with a GUID value. Specifying a user-created stored procedure is not allowed for updating subscribers.

XCALL sp_MSupd_table

-or-

XCALL custom_stored_procedure_name

Calls a stored procedure taking XCALL style parameters. To use this method of replication, use schema_option to specify automatic creation of the stored procedure, or create the specified stored procedure in the destination database of each Subscriber of the article. Specifying a user-created stored procedure is not allowed for updating subscribers.

SQL or NULL

Replicates an UPDATE statement. The UPDATE statement is provided on all column values and the primary key column values. This command is replicated on updates:

The CALL, MCALL, SCALL, and XCALL syntax vary the amount of data propagated to the subscriber. The CALL syntax passes all values for all inserted and deleted columns. The SCALL syntax passes values only for affected columns. The XCALL syntax passes values for all columns, whether changed or not, including the previous value of the column. For more information, see Specify How Changes Are Propagated for Transactional Articles.

[ @creation_script =] 'creation_script'

Is the path and name of an optional article schema script used to create the article in the subscription database. creation_script is nvarchar(255), with a default of NULL.

[ @description =] 'description'

Is a descriptive entry for the article. description is nvarchar(255), with a default of NULL.

[ @pre_creation_cmd =] 'pre_creation_cmd'

Specifies what the system should do if it detects an existing object of the same name at the subscriber when applying the snapshot for this article. pre_creation_cmd is nvarchar(10), and can be one of the following values.

Value

Description

none

Does not use a command.

delete

Deletes data from the destination table before applying the snapshot. When the article is horizontally filtered, only data in columns specified by the filter clause is deleted. Not supported for Oracle Publishers when a horizontal filter is defined.

drop (default)

Drops the destination table.

truncate

Truncates the destination table. Is not valid for ODBC or OLE DB Subscribers.

[ @filter_clause=] 'filter_clause'

Is a restriction (WHERE) clause that defines a horizontal filter. When entering the restriction clause, omit the keyword WHERE. filter_clause is ntext, with a default of NULL. For more information, see Filter Published Data.

[ @schema_option =] schema_option

Is a bitmask of the schema generation option for the given article. schema_option is binary(8), and can be the | (Bitwise OR) product of one or more of these values:

Note

If this value is NULL, the system auto-generates a valid schema option for the article depending on other article properties. The Default Schema Options table given in the Remarks shows the value that will be chosen based upon the combination of the article type and the replication type.

Value

Description

0x00

Disables scripting by the Snapshot Agent and uses creation_script.

0x01

Generates the object creation script (CREATE TABLE, CREATE PROCEDURE, and so on). This value is the default for stored procedure articles.

0x02

Generates the stored procedures that propagate changes for the article, if defined.

0x04

Identity columns are scripted using the IDENTITY property.

0x08

Replicate timestamp columns. If not set, timestamp columns are replicated as binary.

0x10

Generates a corresponding clustered index. Even if this option is not set, indexes related to primary keys and unique constraints are generated if they are already defined on a published table.

0x20

Converts user-defined data types (UDT) to base data types at the Subscriber. This option cannot be used when there is a CHECK or DEFAULT constraint on a UDT column, if a UDT column is part of the primary key, or if a computed column references a UDT column. Not supported for Oracle Publishers.

0x40

Generates corresponding nonclustered indexes. Even if this option is not set, indexes related to primary keys and unique constraints are generated if they are already defined on a published table.

0x80

Replicates primary key constraints. Any indexes related to the constraint are also replicated, even if options 0x10 and 0x40 are not enabled.

0x100

Replicates user triggers on a table article, if defined. Not supported for Oracle Publishers.

0x200

Replicates foreign key constraints. If the referenced table is not part of a publication, all foreign key constraints on a published table are not replicated. Not supported for Oracle Publishers.

0x400

Replicates check constraints. Not supported for Oracle Publishers.

0x800

Replicates defaults. Not supported for Oracle Publishers.

0x1000

Replicates column-level collation.

Note

This option should be set for Oracle Publishers to enable case-sensitive comparisons.

0x2000

Replicates extended properties associated with the published article source object. Not supported for Oracle Publishers.

0x4000

Replicates UNIQUE constraints. Any indexes related to the constraint are also replicated, even if options 0x10 and 0x40 are not enabled.

0x8000

This option is not valid for SQL Server 2005 Publishers.

0x10000

Replicates CHECK constraints as NOT FOR REPLICATION so that the constraints are not enforced during synchronization.

0x20000

Replicates FOREIGN KEY constraints as NOT FOR REPLICATION so that the constraints are not enforced during synchronization.

Attempt to drop dependencies to any objects that are not part of the publication.

0x100000000

Use this option to replicate the FILESTREAM attribute if it is specified on varbinary(max) columns. Do not specify this option if you are replicating tables to SQL Server 2005 Subscribers. Replicating tables that have FILESTREAM columns to SQL Server 2000 Subscribers is not supported, regardless of how this schema option is set.

See related option 0x800000000.

0x200000000

Converts date and time data types (date, time, datetimeoffset, and datetime2) introduced in SQL Server 2008 to data types that are supported on earlier versions of SQL Server.

0x400000000

Replicates the compression option for data and indexes. For more information, see Data Compression.

0x800000000

Set this option to store FILESTREAM data on its own filegroup at the Subscriber. If this option is not set, FILESTREAM data is stored on the default filegroup. Replication does not create filegroups; therefore, if you set this option, you must create the filegroup before you apply the snapshot at the Subscriber. For more information about how to create objects before you apply the snapshot, see Execute Scripts Before and After the Snapshot Is Applied.

See related option 0x100000000.

0x1000000000

Converts common language runtime (CLR) user-defined types (UDTs) that are larger than 8000 bytes to varbinary(max) so that columns of type UDT can be replicated to Subscribers that are running SQL Server 2005.

0x2000000000

Converts the hierarchyid data type to varbinary(max) so that columns of type hierarchyid can be replicated to Subscribers that are running SQL Server 2005. For more information about how to use hierarchyid columns in replicated tables, see hierarchyid (Transact-SQL).

0x4000000000

Replicates any filtered indexes on the table. For more information about filtered indexes, see Create Filtered Indexes.

0x8000000000

Converts the geography and geometry data types to varbinary(max) so that columns of these types can be replicated to Subscribers that are running SQL Server 2005.

0x10000000000

Replicates indexes on columns of type geography and geometry.

0x20000000000

Replicates the SPARSE attribute for columns. For more information about this attribute, see Use Sparse Columns.

NULL

Replication automatically sets schema_option to a default value, the value of which depends on other article properties. The "Default Schema Options" table in the Remarks section shows the default schema options based on article type and replication type.

The default for non-SQL Server publications is 0x050D3.

Not all schema_option values are valid for every type of replication and article type. The Valid Schema Options table in the Remarks section shows the valid schema options that can be chosen based upon the combination of the article type and the replication type.

[ @destination_owner =] 'destination_owner'

Is the name of the owner of the destination object. destination_owner is sysname, with a default of NULL. When destination_owner is not specified, the owner is specified automatically based on the following rules:

To support non-SQL Server Subscribers, destination_owner must be NULL.

[ @status=] status

Specifies if the article is active and additional options for how changes are propagated. status is tinyint, and can be the | (Bitwise OR) product of one or more of these values.

Value

Description

1

Article is active.

8

Includes the column name in INSERT statements.

16 (default)

Uses parameterized statements.

24

Includes the column name in INSERT statements and uses parameterized statements.

64

Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

For example, an active article using parameterized statements would have a value of 17 in this column. A value of 0 means that the article is inactive and no additional properties are defined.

[ @source_owner =] 'source_owner'

Is the owner of the source object. source_owner is sysname, with a default of NULL. source_owner must be specified for Oracle Publishers.

[ @sync_object_owner =] 'sync_object_owner'

Is the owner of the view that defines the published article. sync_object_owner is sysname, with a default of NULL.

[ @filter_owner =] 'filter_owner'

Is the owner of the filter. filter_owner is sysname, with a default of NULL.

[ @source_object =] 'source_object'

Is the database object to be published. source_object is sysname, with a default of NULL. If source_table is NULL, source_object cannot be NULL.source_object should be used instead of source_table. For more information about the types of objects that can be published using snapshot or transactional replication, see Publish Data and Database Objects.

[ @artid = ] article_ID OUTPUT

Is the article ID of the new article. article_ID is int with a default of NULL, and it is an OUTPUT parameter.

[ @auto_identity_range = ] 'auto_identity_range'

Enables and disables automatic identity range handling on a publication at the time it is created. auto_identity_range is nvarchar(5), and can be one of the following values:

Value

Description

true

Enables automatic identity range handling

false

Disables automatic identity range handling

NULL(default)

Identity range handling is set by identityrangemanagementoption.

Note

auto_identity_range has been deprecated and is provided for backward compatibility only. You should use identityrangemanagementoption for specifying identity range management options. For more information, see Replicate Identity Columns.

[ @pub_identity_range = ] pub_identity_range

Controls the range size at the Publisher if the article has identityrangemanagementoption set to auto or auto_identity_range set to true. pub_identity_range is bigint, with a default of NULL. Not supported for Oracle Publishers.

[ @identity_range = ] identity_range

Controls the range size at the Subscriber if the article has identityrangemanagementoption set to auto or auto_identity_range set to true. identity_range is bigint, with a default of NULL. Used when auto_identity_range is set to true. Not supported for Oracle Publishers.

[ @threshold = ] threshold

Is the percentage value that controls when the Distribution Agent assigns a new identity range. When the percentage of values specified in threshold is used, the Distribution Agent creates a new identity range. threshold is bigint, with a default of NULL. Used when identityrangemanagementoption is set to auto or auto_identity_range is set to true. Not supported for Oracle Publishers.

[ @force_invalidate_snapshot = ] force_invalidate_snapshot

Acknowledges that the action taken by this stored procedure may invalidate an existing snapshot. force_invalidate_snapshot is a bit, with a default of 0.

0 specifies that adding an article does not cause the snapshot to be invalid. If the stored procedure detects that the change requires a new snapshot, an error occurs and no changes are made.

1 specifies that adding an article may cause the snapshot to be invalid, and if subscriptions exist that would require a new snapshot, gives permission for the existing snapshot to be marked as obsolete and a new snapshot to be generated.

[ @use_default_datatypes = ] use_default_datatypes

Is whether the default column data type mappings are used when publishing an article from an Oracle Publisher. use_default_datatypes is bit, with a default of 1.

1 = the default article column mappings are used. The default data type mappings can be displayed by executing sp_getdefaultdatatypemapping.

0 = custom article column mappings are defined, and therefore sp_articleview is not called by sp_addarticle.

When use_default_datatypes is set to 0, you must execute sp_changearticlecolumndatatype once for each column mapping being changed from the default. After all custom column mappings have been defined, you must execute sp_articleview.

Note

This parameter should only be used for Oracle Publishers. Setting use_default_datatypes to 0 for a SQL Server Publisher generates an error.

[ @identityrangemanagementoption = ] identityrangemanagementoption

Specifies how identity range management is handled for the article. identityrangemanagementoption is nvarchar(10), and can be one of the following values.

Value

Description

none

Replication does no explicit identity range management. This option is recommended only for backwards compatibility with earlier versions of SQL Server. Not allowed for peer replication.

manual

Marks the identity column using NOT FOR REPLICATION to enable manual identity range handling.

auto

Specifies automatic management of identity ranges.

NULL(default)

Defaults to none when the value of auto_identity_range is not true. Defaults to manual in a peer-to-peer topology default (auto_identity_range is ignored).

For backward compatibility, when the value of identityrangemanagementoption is NULL, the value of auto_identity_range is checked. However, when the value of identityrangemanagementoption is not NULL, then the value of auto_identity_range is ignored.

Specifies a non-SQL Server Publisher. publisher is sysname, with a default of NULL.

Note

publisher should not be used when adding an article to a SQL Server Publisher.

[ @fire_triggers_on_snapshot = ] 'fire_triggers_on_snapshot'

Is if replicated user triggers are executed when the initial snapshot is applied. fire_triggers_on_snapshot is nvarchar(5), with a default of FALSE. true means that user triggers on a replicated table are executed when the snapshot is applied. In order for triggers to be replicated, the bitmask value of schema_option must include the value 0x100.

sp_addarticle is used in snapshot replication or transactional replication.

By default, replication does not publish any columns in the source table when the column data type is not supported by replication. If you need to publish such a column, you must execute sp_articlecolumn to add the column.

When adding an article to a publication that supports peer-to-peer transactional replication, the following restrictions apply:

Parameterized statements must be specified for all logbased articles. You must include 16 in the status value.

Name and owner of the destination table must match the source table.

The article cannot be filtered horizontally or vertically.

Automatic identity range management is not supported. You must specify a value of manual for identityrangemanagementoption.

If a timestamp column exists in the table, you must include 0x08 in schema_option to replicate the column as timestamp.

When you publish objects, their definitions are copied to Subscribers. If you are publishing a database object that depends on one or more other objects, you must publish all referenced objects. For example, if you publish a view that depends on a table, you must publish the table also.

If vertical_partition is set to true, sp_addarticle defers the creation of the view until sp_articleview is called (after the last sp_articlecolumn is added).

If the publication allows updating subscriptions and the published table does not have a uniqueidentifier column, sp_addarticle adds a uniqueidentifier column to the table automatically.

When replicating to a subscriber that is not an instance of SQL Server (heterogeneous replication), only Transact-SQL statements are supported for INSERT, UPDATE, and DELETE commands.

When the log reader agent is running, adding an article to a peer-to-peer publication can cause a deadlock between the log reader agent and the process that adds the article. To avoid this issue, before adding an article to a peer-to-peer publication use the Replication Monitor to stop the log reader agent on the node where you are adding the article. Restart the log reader agent after adding the article.

When setting @del_cmd = 'NONE' or @ins_cmd = 'NONE', the propagation of UPDATE commands might also be affected by not sending those commands when a bounded update occurs. (A bounded update is type of UPDATE statement from the publisher that replicates as a DELETE/INSERT pair on the subscriber.)

Default Schema Options

This table describes the default value set by replication if schema_options is not specified by the user, where this value depends on the replication type (shown across the top) and the article type (shown down the first column).

Article type

Replication type

Transactional

Snapshot

aggregate schema only

0x01

0x01

func schema only

0x01

0x01

indexed view schema only

0x01

0x01

indexed view logbased

0x30F3

0x3071

indexed view logbase manualboth

0x30F3

0x3071

indexed view logbased manualfilter

0x30F3

0x3071

indexed view logbased manualview

0x30F3

0x3071

logbased

0x30F3

0x3071

logbased manualfilter

0x30F3

0x3071

logbased manualview

0x30F3

0x3071

proc exec

0x01

0x01

proc schema only

0x01

0x01

serializable proc exec

0x01

0x01

view schema only

0x01

0x01

Note

If a publication is enabled for queued updating, a schema_option value of 0x80 is added to the default value shown in the table. The default schema_option for a non-SQL Server publication is 0x050D3.

Valid Schema Options

This table describes the allowable values of schema_option based upon the replication type (shown across the top) and the article type (shown down the first column).