sp_addsubscriber

Adds a new Subscriber to a Publisher, enabling it to receive publications. This stored procedure is executed at the Publisher on the publication database.

Syntax

sp_addsubscriber [ @subscriber = ] 'subscriber'
    [ , [ @type = ] type ]
    [ , [ @login = ] 'login' ]
    [ , [ @password = ] 'password' ]
    [ , [ @commit_batch_size = ] commit_batch_size ]
    [ , [ @status_batch_size = ] status_batch_size ]
    [ , [ @flush_frequency = ] flush_frequency ]
    [ , [ @frequency_type = ] frequency_type ]
    [ , [ @frequency_interval = ] frequency_interval ]
    [ , [ @frequency_relative_interval = ] frequency_relative_interval ]
    [ , [ @frequency_recurrence_factor = ] frequency_recurrence_factor ]
    [ , [ @frequency_subday = ] frequency_subday ]
    [ , [ @frequency_subday_interval = ] frequency_subday_interval ]
    [ , [ @active_start_time_of_day = ] active_start_time_of_day ]
    [ , [ @active_end_time_of_day = ] active_end_time_of_day ]
    [ , [ @active_start_date = ] active_start_date ]
    [ , [ @active_end_date = ] active_end_date ]
    [ , [ @description = ] 'description' ]
    [ , [ @security_mode = ] security_mode ]
    [ , [ @encrypted_password = ] encrypted_password ]

Arguments

[@subscriber = ] 'subscriber'

Is the name of the server to be added as a valid Subscriber to the publications on this server. subscriber is sysname, with no default.

[@type = ] type

Is the type of Subscriber. type is tinyint, and can be one of these values.

[@login = ] 'login'

Is the login ID for SQL Server Authentication. login is sysname, with a default of sa.

[@password = ] 'password

Is the password for SQL Server Authentication. password is sysname, with a default of NULL.

[@commit_batch_size = ] commit_batch_size

Supported for backward compatibility only.

[@status_batch_size = ] status_batch_size

Supported for backward compatibility only.

[@flush_frequency = ] flush_frequency

Supported for backward compatibility only.

[@frequency_type = ] frequency_type

Is the frequency with which to schedule the Distribution Agent. frequency_type is int, and can be one of these values.

[@frequency_interval = ] frequency_interval

Is the value applied to the frequency set by frequency_type. frequency_interval is int, with a default of 1.

[@frequency_relative_interval = ] frequency_relative_interval

Is the date of the Distribution Agent. This parameter is used when frequency_type is set to 32 (monthly relative). frequency_relative_interval is int, and can be one of these values.

[@frequency_recurrence_factor = ] frequency_recurrence_factor

Is the recurrence factor used by frequency_type. frequency_recurrence_factor is int, with a default of 0.

[@frequency_subday = ] frequency_subday

Is how often to reschedule during the defined period. frequency_subday is int, and can be one of these values.

[@frequency_subday_interval = ] frequency_subday_interval

Is the interval for frequency_subday. frequency_subday_interval is int, with a default of 5.

[@active_start_time_of_day = ] active_start_time_of_day

Is the time of day when the Distribution Agent is first scheduled, formatted as HHMMSS. active_start_time_of_day is int, with a default of 0.

[@active_end_time_of_day = ] active_end_time_of_day

Is the time of day when the Distribution Agent stops being scheduled, formatted as HHMMSS. active_end_time_of_day is int, with a default of 235959, which means 11:59:59 P.M. as measured on a 24-hour clock.

[@active_start_date = ] active_start_date

Is the date when the Distribution Agent is first scheduled, formatted as YYYYMMDD. active_start_date is int, with a default of 0.

[@active_end_date = ] active_end_date

Is the date when the Distribution Agent stops being scheduled, formatted as YYYYMMDD. active_end_date is int, with a default of 99991231, which means December 31, 9999.

[@description = ] 'description'

Is a text description of the Subscriber. description is nvarchar(255), with a default of NULL.

[@security_mode = ] security_mode

Is the implemented security mode. security_mode is int, with a default of 1. 0 specifies SQL Server Authentication. 1 specifies Windows Authentication.

[@encrypted_password = ] encrypted_password

For internal use only.

Return Code Values

0 (success) or 1 (failure)

Remarks

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

sp_addsubscriber writes to the MSsubscriber_info table in the distribution database.

Permissions

Only members of the sysadmin fixed server role can execute sp_addsubscriber.

See Also

sp_addremotelogin

sp_addserver

sp_changesubscriber

sp_dboption

sp_dropsubscriber

sp_helpdistributor

sp_helpserver

sp_helpsubscriberinfo

sp_remoteoption

sp_serveroption

System Stored Procedures