sp_helparticle (Transact-SQL)
TOC
Collapse the table of content
Expand the table of content

sp_helparticle (Transact-SQL)

 

Updated: June 10, 2016

Applies To: SQL Server

Displays information about an article. This stored procedure is executed at the Publisher on the publication database. For Oracle Publishers, this stored procedure is executed at the Distributor on any database.

Topic link icon Transact-SQL Syntax Conventions

  
sp_helparticle [ @publication = ] 'publication'   
    [ , [ @article = ] 'article' ]  
    [ , [ @returnfilter = ] returnfilter ]  
    [ , [ @publisher = ] 'publisher' ]  
    [ , [ @found = ] found OUTPUT ]  

[ @publication =] 'publication'
Is the name of the publication. publication is sysname, with no default.

[ @article=] 'article'
Is the name of an article in the publication. article is sysname, with a default of %. If article is not supplied, information on all articles for the specified publication is returned.

[ @returnfilter=] returnfilter
Specifies whether the filter clause should be returned. returnfilter is bit, with a default of 1, which returns the filter clause.

[ @publisher= ] 'publisher'
Specifies a non-Microsoft SQL Server publisher. publisher is sysname, with a default of NULL.

System_CAPS_ICON_note.jpg Note


publisher should not be specified when requesting information on an article published by a SQL Server Publisher.

[ @found= ] found OUTPUT
Internal use only.

Column nameData typeDescription
article idintID of the article.
article namesysnameName of the article.
base objectnvarchar(257)Name of the underlying table represented by the article or stored procedure.
destination objectsysnameName of the destination (subscription) table.
synchronization objectnvarchar(257)Name of the view that defines the published article.
typesmallintThe type of article:

 1 = Log-based.

 3 = Log-based with manual filter.

 5 = Log-based with manual view.

 7 = Log-based with manual filter and manual view.

 8 = Stored procedure execution.

 24 = Serializable stored procedure execution.

 32 = Stored procedure (schema only).

 64 = View (schema only).

 96 = Aggregate function (schema only).

 128 = Function (schema only).

 257 = Log-based indexed view.

 259 = Log-based indexed view with manual filter.

 261 = Log-based indexed view with manual view.

 263 = Log-based indexed view with manual filter and manual view.

 320 = Indexed view (schema only).

statustinyintCan be the & (Bitwise AND) result of one or more or these article properties:

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

 0x01 = Article is active.

 0x08 = Include the column name in insert statements.

 0x16 = Use parameterized statements.

 0x32 = Use parameterized statements and include the column name in insert statements.
filternvarchar(257)Stored procedure used to horizontally filter the table. This stored procedure must have been created using FOR REPLICATION clause.
descriptionnvarchar(255)Descriptive entry for the article.
insert_commandnvarchar(255)The replication command type used when replicating inserts with table articles. For more information, see Specify How Changes Are Propagated for Transactional Articles.
update_commandnvarchar(255)The replication command type used when replicating updates with table articles. For more information, see Specify How Changes Are Propagated for Transactional Articles.
delete_commandnvarchar(255)The replication command type used when replicating deletes with table articles. For more information, see Specify How Changes Are Propagated for Transactional Articles.
creation script pathnvarchar(255)Path and name of an article schema script used to create target tables.
vertical partitionbitIs whether vertical partitioning is enabled for the article; where a value of 1 means that vertical partitioning is enabled.
pre_creation_cmdtinyintPrecreation command for DROP TABLE, DELETE TABLE, or TRUNCATE TABLE.
filter_clausentextWHERE clause specifying the horizontal filtering.
schema_optionbinary(8)Bitmap of the schema generation option for the given article. For a complete list of schema_option values, see sp_addarticle (Transact-SQL).
dest_ownersysnameName of the owner of the destination object.
source_ownersysnameOwner of the source object.
unqua_source_objectsysnameName of the source object, without the owner name.
sync_object_ownersysnameOwner of the view that defines the published article. .
unqualified_sync_objectsysnameName of the view that defines the published article, without the owner name.
filter_ownersysnameOwner of the filter.
unqua_filtersysnameName of the filter, without the owner name.
auto_identity_rangeintFlag indicating if automatic identity range handling was turned on at the publication at the time it was created. 1 means that automatic identity range is enabled; 0 means it is disabled.
publisher_identity_rangeintRange size of the identity range at the Publisher if the article has identityrangemanagementoption set to auto or auto_identity_range set to true.
identity_rangebigintRange size of the identity range at the Subscriber if the article has identityrangemanagementoption set to auto or auto_identity_range set to true.
thresholdbigintPercentage value indicating when the Distribution Agent assigns a new identity range.
identityrangemanagementoptionintIndicates the identity range management handled for the article.
fire_triggers_on_snapshotbitIs if replicated user triggers are executed when the initial snapshot is applied.

 1 = user triggers are executed.

 0 = user triggers are not executed.

0 (success) or 1 (failure)

sp_helparticle is used in snapshot replication and transactional replication.

Only members of the sysadmin fixed server role, the db_owner fixed database role, or the publication access list for the current publication can execute sp_helparticle.

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

USE [AdventureWorks2012]
EXEC sp_helparticle
  @publication = @publication;
GO

View and Modify Article Properties
sp_addarticle (Transact-SQL)
sp_articlecolumn (Transact-SQL)
sp_changearticle (Transact-SQL)
sp_droparticle (Transact-SQL)
Replication Stored Procedures (Transact-SQL)

Community Additions

ADD
Show:
© 2016 Microsoft