Chapter 4: ASE Replicator Procedures

sp_helpreplicateart

Returns information about replicate articles.

sp_helpreplicateart [info]

sp_helpreplicateart info, rep_art [, {conn=conn_name|sub=sub_name}]

sp_helpreplicateart fields, rep_art, {conn=conn_name|sub=sub_name}

info: The keyword that requests information about all replicate articles in all replicate databases, or information about a specified replicate article in a specified replicate database or subscription.

fields: The keyword that requests field information for a specified replicate article in a specified replicate database or subscription.

rep_art: The name of a replicate article. Replicate article names can be specified in the form owner.name.

To avoid problems on case-insensitive data servers, always specify replicate object names using the same character case as returned by the catalog stored procedures on the replicate data server.

conn=conn_name

The label identifying a replicate database connection. The connection name (conn_name) must be specified in the form ds.db, where:

sp_helpreplicateart

Returns information about all replicate articles in all replicate database connections.

Using sp_helpreplicateart with no keyword is functionally identical to specifying only the info keyword.

sp_helpreplicateart @rep_art=table1

Returns information about all replicate articles named table1 in all replicate databases. This is functionally identical to Example 3.

sp_helpreplicateart fields, table1, "conn=boulder.doc"

Returns field information about the replicate article table1 in the replicate database doc on the data server boulder.

sp_helpreplicateart fields, "joe.table1", "sub=subdoc"

Returns field information about the replicate article table1 with owner joe in the subscription subdoc.

When listing information about replicate articles, the following result set is returned:

**Table 4-25: ASE Replicator replicate article information**
Column	Datatype	Description
ds	sysname	Name of the replicate data server.
db	sysname	Name of the replicate database.
sub_name	sysname	Subscription name.
rart_owner	sysname	Owner of replicate article.
rart_name	sysname	Name of replicate article.
rart_proc_num	smallint	Stored procedure group number for replicate article. If only one procedure exists, then proc_num=1. Tables are proc_num=0.
art_type	varchar(9)	Type of replicate article: table procedure
proxy_table	sysname	If replicate article is a table, name of the proxy table. Otherwise, null.
dist_proc	sysname	Name of distribution stored procedure for the replicate article.
is_validated	varchar(64)	Validation flag: true false
where_clause	varchar(255) or varchar(1837)	Condition for selecting a subset of data rows to replicate. (Datatype size depends on Adaptive Server version.)
pub_name	sysname	Publication name.
part_owner	sysname	Owner of primary article.
part_name	sysname	Name of primary article.
part_proc_num	smallint	Stored procedure group number for primary article. If only one procedure exists, then proc_num=1. Tables are proc_num=0.

When listing information about replicate article fields, the following result set is returned:

**Table 4-26: ASE Replicator replicate article field information**
Column	Datatype	Description
ds	sysname	Name of the replicate data server.
db	sysname	Name of the replicate database.
sub_name	sysname	Subscription name.
rart_owner	sysname	Owner of replicate article.
rart_name	sysname	Name of replicate article.
rart_proc_num	smallint	Stored procedure group number for replicate article. If only one procedure exists, then proc_num=1. Tables are proc_num=0.
art_type	varchar(9)	Type of replicate article: table procedure
rart_field_id	smallint	Replicate article field identifier, ordinal position.
rart_field_name	sysname	Name of the replicate article field (column or parameter name).
datatype	sysname	Datatype of the field.
precision	int	Length of string or binary field, or precision of a numeric field, if applicable. Otherwise, 0.
scale	smallint	Scale of numeric field, if applicable. Otherwise, 0.
pub_name	sysname	Publication name.
part_owner	sysname	Owner of primary article.
part_name	sysname	Name of primary article.
part_proc_num	smallint	Stored procedure group number for primary article. If only one procedure exists, then proc_num=1. Tables are proc_num=0.
part_field_id	smallint	Primary article field identifier, ordinal position.
part_field_name	sysname	Name of the primary article field (column or parameter name).

When sp_helpreplicateart is invoked with no keyword, it returns information about all replicate articles in all replicate database connections.
When you invoke sp_helpreplicateart with the fields keyword and an article name (rep_art), you must specify either a connection name (conn=conn_name) or a subscription name (sub=sub_name).

To avoid problems on case-insensitive data servers, always specify replicate object names using the same character case as returned by the catalog stored procedures on the replicate data server.
To get information about primary articles, use sp_helpprimaryart.
To get information about publications or subscriptions, use sp_helppub or sp_helpsub.
To get information about database connections, use sp_helpconn, sp_helpprimaryconn, or sp_helpreplicateconn.
When an error occurs, an error message is returned.