sp_helpsubscription (T-SQL)

Lists subscription information associated with a particular publication, article, Subscriber, or set of subscriptions.

Syntax

sp_helpsubscription [[@publication =] 'publication']
    [,[@article =] 'article']
    [,[@subscriber =] 'subscriber']
    [,[@destination_db =] 'destination_db']

Arguments

[@publication =] 'publication': Is the name of the associated publication. publication is sysname, with a default of %, which returns all subscription information for this server.
[@article =] 'article': Is the name of the article. article is sysname, with a default of %, which returns all subscription information for the selected publications and Subscribers. If all, only one entry is returned for the full subscription on a publication.
[@subscriber =] 'subscriber': Is the name of the Subscriber viewing subscriptions. subscriber is sysname, with a default of %, which returns all subscription information for the selected publications and articles.
[@destination_db =] 'destination_db': Is the name of the destination database. destination_db is sysname, with a default of %.

Result Sets

Column name	Data type	Description
subscriber	sysname	Name of the Subscriber
publication	sysname	Name of the publication
article	sysname	Name of the article
destination database	sysname	Name of the destination database in which replicated data is placed
subscription status	tinyint	Subscription status: 0 = Inactive 1 = Subscribed 2 = Active
synchronization type	tinyint	Subscription synchronization type: 1 = Automatic 2 = None
subscription type	int	Type of subscription: 0 = Push 1 = Pull 2 = Anonymous
full subscription	bit	Whether subscription is to all articles in the publication: 0 = No 1 = Yes
subscription name	nvarchar(255)	Name of the subscription
update mode	int	0 = Read-only 1 = Immediate-updating subscription
distribution job id	binary(16)	Job ID of the Distribution Agent
loopback_detection	bit	0 = No 1 = Yes

Remarks

sp_helpsubscription is used in snapshot, transactional, and merge replication.

Permissions

Execute permissions default to the public role.