sp_helparticle
Displays information about an article. This stored procedure is executed at the Publisher on the publication database.
Syntax
sp_helparticle [ @publication = ] 'publication'
[ , [ @article = ] 'article' ]
[ , [ @returnfilter = ] returnfilter ]
Arguments
[@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.
Result Sets
| Column name | Data type | Description |
|---|---|---|
| article id | int | ID of the article. |
| article name | sysname | Name of the article. |
| base object | nvarchar(257) | Name of the underlying table represented by the article or stored procedure. |
| destination object | sysname | Name of the destination (subscription) table, if different from source_table or the stored procedure. |
| synchronization object | nvarchar(257) | Name of the table or view used for producing a synchronization output file. |
| type | tinyint | Type of article. |
| status | tinyint | Bitmask of the article name:
0 = For internal use only. |
| filter | nvarchar(257) | Stored procedure (created with FOR REPLICATION) used to filter the table (horizontal filtering). |
| description | nvarchar(255) | Descriptive entry for the article. |
| insert_command | nvarchar(255) | Call to the stored procedure to execute upon insert. |
| update_command | nvarchar(255) | Call to the stored procedure to execute upon update. |
| delete_command | nvarchar(255) | Call to the stored procedure to execute upon delete. |
| creation script path | nvarchar(255) | Path and name of an article schema script used to create target tables. |
| vertical partition | bit | Columns to replicate. |
| pre_creation_cmd | tinyint | Precreation command for DROP TABLE, DELETE TABLE, or TRUNCATE TABLE. |
| filter_clause | ntext | WHERE clause specifying the horizontal filtering. |
| schema_option | binary(8) | Bitmap of the schema generation option for the given article. |
| dest_owner | sysname | Name of the owner of the destination object. |
| source_owner | sysname | Owner of the source object. |
| unqualified_source_object | sysname | Name of the source object, without the owner name. |
| sync_object_owner | sysname | Owner of the synchronization object. |
| unqualified_sync_object | sysname | Name of the synchronization object, without the owner name. |
| filter_owner | sysname | Owner of the filter. |
| unqualified_filter | sysname | Name of the filter, without the owner name. |
| auto_identity_range | int | Flag 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. Note that identity range management only pertains to snapshot or transactional publications that allow immediate updating or queued updating |
| publisher_identity_range | int | Range size of the identity range at the Publisher if the article has auto_identity_range set to true. |
| identity_range | bigint | Range size of the identity range at the Subscriber if the article has auto_identity_range set to true. |
| threshold | bigint | Percentage value indicating when the Distribution Agent assigns a new identity range. |
Remarks
sp_helparticle is used in snapshot replication and transactional replication.
Permissions
Execute permissions default to the public role.