Chapter 4: ASE Replicator Procedures

sp_helprep

Description

Returns statistics or status information about ASE Replicator, ASE Replicator objects, or ASE Replicator components.

Syntax

sp_helprep [stats, { reset|rep_conns|rep_conn=conn_name }]

sp_helprep [status [, {conns|subs|
	{pri_conn|rep_conn}=conn_name|
	sub=sub_name }]]

sp_helprep [version]

Parameters

stats: The keyword that requests statistics information about ASE Replicator.

status: The keyword that requests status information about ASE Replicator. This is the default value.

version: The keyword that requests the ASE Replicator version string.

reset: The keyword that resets all statistics counters to zero.

rep_conns: The keyword that requests statistics information for all replicate database connections.

subs: The keyword that requests status information for all subscriptions.

pri_conn=: The label identifying a primary database connection to request status information for that connection.

rep_conn=: The label identifying a replicate database connection to request statistics or status information for that connection.

conn_name

A database connection name specified in the form ds.db, where:

ds is the name of the data server on which the database resides.
db is the name of the database.

sub=sub_name: A label identifying a subscription (sub_name) to request status information for that subscription.

Examples

Example 1

sp_helprep

Returns current status of overall replication system.

Using sp_helprep with no keyword is functionally identical to specifying only the status keyword.

Example 2

sp_helprep stats, reset

Resets all ASE Replicator statistics counters.

Example 3

sp_helprep stats, rep_conns

Returns current statistics for all replicate database connections.

Example 4

sp_helprep stats, "rep_conn=boulder.doc"

Returns current statistics for the replicate database connection to the database doc on data server boulder.

Example 5

sp_helprep status, "sub=subdoc"

Returns current status of the subscription subdoc.

Example 6

sp_helprep version

Returns the ASE Replicator version string.

Usage

When listing statistics, the following result set is returned:

**Table 4-21: ASE Replicator statistics information**
Column	Datatype	Description
type	varchar(3)	Type of entity: REP – replicate connection
name	sysname	Name of the ASE Replicator instance
tstamp	datetime	Timestamp the statistic was generated
statistic	varchar(128)	Name of the statistic
value	varchar(255)	Value of the statistic

When listing status of the overall replication system, the following result set is returned:

**Table 4-22: ASE Replicator system status information**
Column	Datatype	Description
type	varchar(32)	Type of object: PRI – status of a primary connection REP – status of a replicate connection SUB – status of a subscription
name	varchar(128)	Name of object: if type = PRI or REP, name = ds.db if type = SUB, name = subname
status	smallint	Status of object: 1 – up 0 – down -1 – error
status_desc	varchar(255)	Description of status

When listing status of connections, the following result set is returned:

**Table 4-23: ASE Replicator connection status information**
Column	Datatype	Description
conn_type	varchar(3)	Type of connection: PRI – primary REP – replicate
ds	sysname	If conn_type is PRI, then ds is the name of the local primary data server. If conn_type is REP, then ds is the name of the replicate data server.
db	sysname	If conn_type is PRI, then db is the name of the local primary database. If conn_type is REP, then db is the name of the replicate database.
maint_user	sysname	Maintenance User name in the database identified in db.
lastcmt_proxy	sysname	Lastcommit proxy table name.
restart_locator	varchar(64)	If conn_type is PRI, then restart_locator identifies the restart position in the database log. If conn_type is REP, then restart_locator identifies the restart position in the stable queue.
timestamp	datetime	Timestamp of the restart locator.
status	smallint	Status of the connection: 1 – up 0 – down -1 – error
status_desc	varchar(255)	Description of the connection status.

When listing status of subscriptions, the following result set is returned:

**Table 4-24: ASE Replicator subscription status information**
Column	Datatype	Description
ds	sysname	Name of the replicate data server
db	sysname	Name of the replicate database
sub_name	sysname	Name of the subscription
status	smallint	Status of the subscription: 1 – up 0 – down -1 – error
status_desc	varchar(255)	Status description
pub_name	sysname	Name of the associated publication

When you invoke sp_helprep with the stats keyword, you must also supply an additional option.
- When you invoke sp_helprep with the stats keyword and the reset keyword, it resets all ASE Replicator statistics counters.
- When you invoke sp_helprep with the stats keyword and the rep_conns keyword, it returns statistics for all replicate database connections.
- When you invoke sp_helprep with the stats keyword and specify a replicate connection (rep_conn=conn_name), it returns statistics for the specified connection.
To get statistics information about primary connections, use sp_helpprimaryconn stats.
When you invoke sp_helprep with no keyword specified, it returns status of the overall replication system. Using sp_helprep with no keyword is functionally identical to specifying only the status keyword.
- When you invoke sp_helprep with the status keyword and the pri_conns keyword, it returns status of all primary database connections.
- When you invoke sp_helprep with the status keyword and the rep_conns keyword, it returns status of all replicate database connections.
- When you invoke sp_helprep with the status keyword and the subs keyword, it returns status of all subscriptions on all replicate database connections.
- When you invoke sp_helprep with the status keyword and specify a connection (pri_conn=conn_name or rep_conn=conn_name), it returns status of the specified connection.
- When you invoke sp_helprep with the status keyword and specify a subscription (sub=sub_name), it returns status of the specified subscription.
When an error occurs, an error message is returned.