TechNet
Export (0) Print
Expand All
Collapse the table of content
Expand the table of content
Expand Minimize

sp_helpsubscriberinfo (Transact-SQL)

 

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Displays information about a Subscriber. This stored procedure is executed at the Publisher on any database.

Topic link icon Transact-SQL Syntax Conventions

  
sp_helpsubscriberinfo [ [ @subscriber =] 'subscriber']  
    [ , [ @publisher = ] 'publisher' ]  

[ @subscriber = ] 'subscriber'
Is the name of the Subscriber. subscriber is sysname, with a default of %, which returns all information.

[ @publisher = ] 'publisher'
Is the name of the Publisher. publisher is sysname, and defaults to the name of the current server.

System_CAPS_ICON_note.jpg Note


publisher should not be specified, except when it is an Oracle Publisher.

Column nameData typeDescription
publishersysnameName of the Publisher.
subscribersysnameName of the Subscriber.
typetinyintType of Subscriber:

 0 = Microsoft SQL Server database 1 = ODBC data source
loginsysnameLogin ID for SQL Server Authentication.
passwordsysnamePassword for SQL Server Authentication.
commit_batch_sizeintNot supported.
status_batch_sizeintNot supported.
flush_frequencyintNot supported.
frequency_typeintFrequency with which the Distribution Agent is run:

 1 = One time

 2 = On demand

 4 = Daily

 8 = Weekly

 16 = Monthly

 32 = Monthly relative

 64 = Autostart

 128 = Recurring
frequency_intervalintValue applied to the frequency set by frequency_type.
frequency_relative_intervalintDate of the Distribution Agent used when frequency_type is set to 32 (monthly relative):

 1 = First

 2 = Second

 4 = Third

 8 = Fourth

 16 = Last
frequency_recurrence_factorintRecurrence factor used by frequency_type.
frequency_subdayintHow often to reschedule during the defined period:

 1 = Once

 2 = Second

 4 = Minute

 8 = Hour
frequency_subday_intervalintInterval for frequency_subday.
active_start_time_of_dayintTime of day when the Distribution Agent is first scheduled, formatted as HHMMSS.
active_end_time_of_dayintTime of day when the Distribution Agent stops being scheduled, formatted as HHMMSS.
active_start_dateintDate when the Distribution Agent is first scheduled, formatted as YYYYMMDD.
active_end_dateintDate when the Distribution Agent stops being scheduled, formatted as YYYYMMDD.
retryattemptintNot supported.
retrydelayintNot supported.
descriptionnvarchar(255)Text description of the Subscriber.
security_modeintImplemented security mode:

 0 = SQL Server Authentication

 1 = Microsoft Windows Authentication
frequency_type2intFrequency with which the Merge Agent is run:

 1 = One time

 2 = On demand

 4 = Daily

 8 = Weekly

 16 = Monthly

 32 = Monthly relative

 64 = Autostart

 128 = Recurring
frequency_interval2intValue applied to the frequency set by frequency_type.
frequency_relative_interval2intDate of the Merge Agent used when frequency_type is set to 32(monthly relative):

 1 = First

 2 = Second

 4 = Third

 8 = Fourth

 16 = Last
frequency_recurrence_factor2intRecurrence factor used by frequency_type.
frequency_subday2intHow often to reschedule during the defined period:

 1 = Once

 2 = Second

 4 = Minute

 8 = Hour
frequency_subday_interval2intInterval for frequency_subday.
active_start_time_of_day2intTime of day when the Merge Agent is first scheduled, formatted as HHMMSS.
active_end_time_of_day2intTime of day when the Merge Agent stops being scheduled, formatted as HHMMSS.
active_start_date2intDate when the Merge Agent is first scheduled, formatted as YYYYMMDD.
active_end_date2intDate when the Merge Agent stops being scheduled, formatted as YYYYMMDD.

0 (success) or 1 (failure)

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

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

sp_adddistpublisher (Transact-SQL)
sp_addpullsubscription (Transact-SQL)
sp_changesubscriber (Transact-SQL)
sp_dropsubscriber (Transact-SQL)
sp_helpdistributor (Transact-SQL)
sp_helpserver (Transact-SQL)
System Stored Procedures (Transact-SQL)

Community Additions

ADD
Show:
© 2016 Microsoft