Transact-SQL Reference

sp_addmergepullsubscription

Adds a pull subscription to a merge publication. This stored procedure is executed at the Subscriber on the subscription database.

Syntax

sp_addmergepullsubscription [ @publication = ] 'publication'
    
[ , [ @publisher = ] 'publisher' ]
    
[ , [ @publisher_db = ] 'publisher_db' ]
    [ , [ @subscriber_type = ] 'subscriber_type' ]
    [ , [ @subscription_priority = ] subscription_priority ]
    [ , [ @sync_type = ] 'sync_type' ]
    [ , [ @description = ] 'description' ]

Arguments

[@publication = ] 'publication'

Is the name of the publication. publication is sysname, with no default.

[@publisher = ] 'publisher'

Is the name of the Publisher. publisher is sysname, with a default of the local server name. The Publisher must be a valid server.

[@publisher_db = ] 'publisher_db

Is the name of the Publisher database. publisher_db is sysname, with a default of NULL.

[@subscriber_type = ] 'subscriber_type'

Is the type of Subscriber. subscriber_type is nvarchar(15), and can be global, local or anonymous.

[@subscription_priority = ] subscription_priority

Is the subscription priority. subscription_priority is real, with a default of NULL. For local and anonymous subscriptions, the priority is 0.0. The priority is used by the default resolver to pick a winner when conflicts are detected. For global subscribers, the subscription priority must be less than 100, which is the priority of the publisher.

[@sync_type = ] 'sync_type'

Is the subscription synchronization type. sync_type is nvarchar(15), with a default of automatic. Can be automatic or none. If automatic, the schema and initial data for published tables are transferred to the Subscriber first. If none, it is assumed the Subscriber already has the schema and initial data for published tables. System tables and data are always transferred.

[@description = ] 'description'

Is a brief description of this pull subscription. description is nvarchar(255), with a default of NULL.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_addmergepullsubscription is used for merge replication.

sp_addmergepullsubscription implements similar functionality to sp_addmergesubscription regarding pull subscriptions, except that it does not create an agent for this subscription. The current server name and current database name are assumed to be subscriber and subscriber_db, and do not appear in the parameter list.

If creating a global subscription, the sp_addmergesubscription and sp_addsubscriber stored procedures must be run at the Publisher in addition to running sp_addmergepullsubscription at the Subscriber.

If using SQL Agent to synchronize the subscription, the sp_addmergepullsubscription_agent stored procedure must be run at the Subscriber to create an agent and job to synchronize with the Publication.

Permissions

Only members of the sysadmin fixed server role or db_owner fixed database role can execute sp_addmergepullsubscription.

See Also

sp_changemergepullsubscription

sp_dropmergepullsubscription

sp_helpmergepullsubscription

System Stored Procedures