--- title: "Create a Pull Subscription | Microsoft Docs" ms.custom: "" ms.date: "03/17/2017" ms.prod: sql ms.prod_service: "database-engine" ms.reviewer: "" ms.technology: replication ms.topic: conceptual helpviewer_keywords: - "pull subscriptions [SQL Server replication], creating" - "merge replication subscribing [SQL Server replication], pull subscriptions" - "subscriptions [SQL Server replication], pull" - "snapshot replication [SQL Server], subscribing" - "transactional replication, subscribing" ms.assetid: 41d1886d-59c9-41fc-9bd6-a59b40e0af6e author: "MashaMSFT" ms.author: "mathoma" monikerRange: "=azuresqldb-mi-current||>=sql-server-2016||=sqlallproducts-allversions" --- # Create a Pull Subscription [!INCLUDE[appliesto-ss-asdbmi-xxxx-xxx-md](../../includes/appliesto-ss-asdbmi-xxxx-xxx-md.md)] This topic describes how create a pull subscription in [!INCLUDE[ssCurrent](../../includes/sscurrent-md.md)] by using [!INCLUDE[ssManStudioFull](../../includes/ssmanstudiofull-md.md)], [!INCLUDE[tsql](../../includes/tsql-md.md)], or Replication Management Objects (RMO). Setting up a pull subscription for P2P replication is possible by script, but is not available through the wizard. ## Using SQL Server Management Studio Create a pull subscription at the Publisher or the Subscriber using the New Subscription Wizard. Follow the pages in the wizard to: - Specify the Publisher and publication. - Select where replication agents will run. For a pull subscription, select **Run each agent at its Subscriber (pull subscriptions)** on the **Distribution Agent Location** page or **Merge Agent Location** page, depending on the type of publication. - Specify Subscribers and subscription databases. - Specify the logins and passwords used for connections made by replication agents: - For subscriptions to snapshot and transactional publications, specify credentials on the **Distribution Agent Security** page. - For subscriptions to merge publications, specify credentials on the **Merge Agent Security** page. For information about the permissions required by each agent, see [Replication Agent Security Model](../../relational-databases/replication/security/replication-agent-security-model.md). - Specify a synchronization schedule and when the Subscriber should be initialized. - Specify additional options for merge publications: subscription type; values for parameterized filtering; and information for synchronization through HTTPS if the publication is enabled for Web synchronization. - Specify additional options for transactional publications that allow updating subscriptions: whether Subscribers should commit changes at the Publisher immediately or write them to a queue; credentials used to connect from the Subscriber to the Publisher. - Optionally script the subscription. #### To create a pull subscription from the Publisher 1. Connect to the Publisher in [!INCLUDE[msCoName](../../includes/msconame-md.md)] [!INCLUDE[ssManStudioFull](../../includes/ssmanstudiofull-md.md)], and then expand the server node. 2. Expand the **Replication** folder, and then expand the **Local Publications** folder. 3. Right-click the publication for which you want to create one or more subscriptions, and then click **New Subscriptions**. 4. Complete the pages in the New Subscription Wizard. #### To create a pull subscription from the Subscriber 1. Connect to the Subscriber in [!INCLUDE[ssManStudioFull](../../includes/ssmanstudiofull-md.md)], and then expand the server node. 2. Expand the **Replication** folder. 3. Right-click the **Local Subscriptions** folder, and then click **New Subscriptions**. 4. On the **Publication** page of the New Subscription Wizard, select **\** or **\** from the **Publisher** drop-down list. 5. Connect to the Publisher in the **Connect to Server** dialog box. 6. Select a publication on the **Publication** page. 7. Complete the pages in the New Subscription Wizard. ## Using Transact-SQL Pull subscriptions can be created programmatically using replication stored procedures. The stored procedures used will depend on the type of publication to which the subscription belongs. #### To create a pull subscription to a snapshot or transactional publication 1. At the Publisher, verify that the publication supports pull subscriptions by executing [sp_helppublication (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-helppublication-transact-sql.md). - If the value of **allow_pull** in the result set is **1**, then the publication supports pull subscriptions. - If the value of **allow_pull** is **0**, execute [sp_changepublication (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-changepublication-transact-sql.md), specifying **allow_pull** for **\@property** and **true** for **\@value**. 2. At the Subscriber, execute [sp_addpullsubscription (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-addpullsubscription-transact-sql.md). Specify **\@publisher** and **\@publication**. For information about updating subscriptions, see [Create an Updatable Subscription to a Transactional Publication](publish/create-an-updatable-subscription-to-a-transactional-publication.md). 3. At the Subscriber, execute [sp_addpullsubscription_agent (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-addpullsubscription-agent-transact-sql.md). Specify the following: - The **\@publisher**, **\@publisher_db**, and **\@publication** parameters. - The [!INCLUDE[msCoName](../../includes/msconame-md.md)] Windows credentials under which the Distribution Agent at the Subscriber runs for **\@job_login** and **\@job_password**. > [!NOTE] > Connections made using Windows Integrated Authentication always use the Windows credentials specified by **\@job_login** and **\@job_password**. The Distribution Agent always makes the local connection to the Subscriber using Windows Integrated Authentication. By default, the agent will connect to the Distributor using Windows Integrated Authentication. - (Optional) A value of **0** for **\@distributor_security_mode** and the SQL Server login information for **\@distributor_login** and **\@distributor_password**, if you need to use SQL Server Authentication when connecting to the Distributor. - A schedule for the Distribution Agent job for this subscription. For more information, see [Specify Synchronization Schedules](../../relational-databases/replication/specify-synchronization-schedules.md). 4. At the Publisher, execute [sp_addsubscription (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-addsubscription-transact-sql.md) to register the pull subscription. Specify **\@publication**, **\@subscriber**, and **\@destination_db**. Specify a value of **pull** for **\@subscription_type**. #### To create a pull subscription to a merge publication 1. At the Publisher, verify that the publication supports pull subscriptions by executing [sp_helpmergepublication (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-helpmergepublication-transact-sql.md). - If the value of **allow_pull** in the result set is **1**, then the publication supports pull subscriptions. - If the value of **allow_pull** is **0**, execute [sp_changemergepublication (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-changemergepublication-transact-sql.md), specifying **allow_pull** for **\@property** and **true** for **\@value**. 2. At the Subscriber, execute [sp_addmergepullsubscription (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-addmergepullsubscription-transact-sql.md). Specify **\@publisher**, **\@publisher_db**, **\@publication**, and the following parameters: - **\@subscriber_type** - specify **local** for a client subscription and **global** for a server subscription. - **\@subscription_priority** - Specify a priority for the subscription (**0.00** to **99.99**). This is only required for a server subscription. For more information, see [Advanced Merge Replication Conflict Detection and Resolution](../../relational-databases/replication/merge/advanced-merge-replication-conflict-detection-and-resolution.md). 3. At the Subscriber, execute [sp_addmergepullsubscription_agent (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-addmergepullsubscription-agent-transact-sql.md). Specify the following parameters: - **\@publisher**, **\@publisher_db**, and **\@publication**. - The Windows credentials under which the Merge Agent at the Subscriber runs for **\@job_login** and **\@job_password**. > [!NOTE] > Connections made using Windows Integrated Authentication always use the Windows credentials specified by **\@job_login** and **\@job_password**. The Merge Agent always makes the local connection to the Subscriber using Windows Integrated Authentication. By default, the agent will connect to the Distributor and Publisher using Windows Integrated Authentication. - (Optional) A value of **0** for **\@distributor_security_mode** and the [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] login information for **\@distributor_login** and **\@distributor_password**, if you need to use [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] Authentication when connecting to the Distributor. - (Optional) A value of **0** for **\@publisher_security_mode** and the [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] login information for **\@publisher_login** and **\@publisher_password**, if you need to use [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)] Authentication when connecting to the Publisher. - A schedule for the Merge Agent job for this subscription. For more information, see [Create an Updatable Subscription to a Transactional Publication](publish/create-an-updatable-subscription-to-a-transactional-publication.md). 4. At the Publisher, execute [sp_addmergesubscription (Transact-SQL)](../../relational-databases/system-stored-procedures/sp-addmergesubscription-transact-sql.md). Specify **\@publication**, **\@subscriber**, **\@subscriber_db**, and a value of **pull** for **\@subscription_type**. This registers the pull subscription. ### Examples (Transact-SQL) The following example creates a pull subscription to a transactional publication. The first batch is executed at the Subscriber, and the second batch is executed at the Publisher. Login and password values are supplied at runtime using sqlcmd scripting variables. ``` -- This script uses sqlcmd scripting variables. They are in the form -- $(MyVariable). For information about how to use scripting variables -- on the command line and in SQL Server Management Studio, see the -- "Executing Replication Scripts" section in the topic -- "Programming Replication Using System Stored Procedures". -- Execute this batch at the Subscriber. DECLARE @publication AS sysname; DECLARE @publisher AS sysname; DECLARE @publicationDB AS sysname; SET @publication = N'AdvWorksProductTran'; SET @publisher = $(PubServer); SET @publicationDB = N'AdventureWorks'; -- At the subscription database, create a pull subscription -- to a transactional publication. USE [AdventureWorksReplica] EXEC sp_addpullsubscription @publisher = @publisher, @publication = @publication, @publisher_db = @publicationDB; -- Add an agent job to synchronize the pull subscription. EXEC sp_addpullsubscription_agent @publisher = @publisher, @publisher_db = @publicationDB, @publication = @publication, @distributor = @publisher, @job_login = $(Login), @job_password = $(Password); GO ``` ``` -- This script uses sqlcmd scripting variables. They are in the form -- $(MyVariable). For information about how to use scripting variables -- on the command line and in SQL Server Management Studio, see the -- "Executing Replication Scripts" section in the topic -- "Programming Replication Using System Stored Procedures". -- Execute this batch at the Publisher. DECLARE @publication AS sysname; DECLARE @subscriber AS sysname; DECLARE @subscriptionDB AS sysname; SET @publication = N'AdvWorksProductTran'; SET @subscriber = $(SubServer); SET @subscriptionDB = N'AdventureWorksReplica'; -- At the Publisher, register the subscription, using the defaults. EXEC sp_addsubscription @publication = @publication, @subscriber = @subscriber, @destination_db = @subscriptionDB, @subscription_type = N'pull', @status = N'subscribed'; GO ``` The following example creates a pull subscription to a merge publication. The first batch is executed at the Subscriber, and the second batch is executed at the Publisher. Login and password values are supplied at runtime using **sqlcmd** scripting variables. ``` -- This script uses sqlcmd scripting variables. They are in the form -- $(MyVariable). For information about how to use scripting variables -- on the command line and in SQL Server Management Studio, see the -- "Executing Replication Scripts" section in the topic -- "Programming Replication Using System Stored Procedures". -- Execute this batch at the Subscriber. DECLARE @publication AS sysname; DECLARE @publisher AS sysname; DECLARE @publicationDB AS sysname; DECLARE @hostname AS sysname; SET @publication = N'AdvWorksSalesOrdersMerge'; SET @publisher = $(PubServer); SET @publicationDB = N'AdventureWorks'; SET @hostname = N'adventure-works\david8'; -- At the subscription database, create a pull subscription -- to a merge publication. USE [AdventureWorksReplica] EXEC sp_addmergepullsubscription @publisher = @publisher, @publication = @publication, @publisher_db = @publicationDB; -- Add an agent job to synchronize the pull subscription. EXEC sp_addmergepullsubscription_agent @publisher = @publisher, @publisher_db = @publicationDB, @publication = @publication, @distributor = @publisher, @job_login = $(Login), @job_password = $(Password), @hostname = @hostname; GO ``` ``` -- Execute this batch at the Publisher. DECLARE @myMergePub AS sysname; DECLARE @mySub AS sysname; DECLARE @mySubDB AS sysname; SET @myMergePub = N'AdvWorksSalesOrdersMerge'; SET @mySub = N'MYSUBSERVER'; SET @mySubDB = N'AdventureWorksReplica'; -- At the Publisher, register the subscription, using the defaults. USE [AdventureWorks] EXEC sp_addmergesubscription @publication = @myMergePub, @subscriber = @mySub, @subscriber_db = @mySubDB, @subscription_type = N'pull'; GO ``` ## Using Replication Management Objects (RMO) The RMO classes used to create a pull subscription depend on the type of publication to which the subscription belongs. #### To create a pull subscription to a snapshot or transactional publication 1. Create connections to both the Subscriber and Publisher by using the Class. 2. Create an instance of the class by using the Publisher connection from step 1. Specify , and . 3. Call the method. If this method returns **false**, either the properties specified in step 2 are incorrect or the publication does not exist on the server. 4. Perform a bitwise logical AND (**&** in Visual C# and **And** in Visual Basic) between the property and . If the result is , set to the result of a bitwise logical OR (**|** in Visual C# and **Or** in Visual Basic) between and . Then, call to enable pull subscriptions. 5. If the subscription database does not exist, create it by using the class. For more information, see [Creating, Altering, and Removing Databases](../../relational-databases/server-management-objects-smo/tasks/creating-altering-and-removing-databases.md). 6. Create an instance of the class. 7. Set the following subscription properties: - The to the Subscriber created in step 1 for . - Name of the subscription database for . - Name of the Publisher for . - Name of the publication database for . - Name of the publication for . - The and fields of to provide the credentials for the [!INCLUDE[msCoName](../../includes/msconame-md.md)] Windows account under which the Distribution Agent runs at the Subscriber. This account is used to make local connections to the Subscriber and to make remote connections using Windows Authentication. > [!NOTE] > Setting is not required when the subscription is created by a member of the **sysadmin** fixed server role, however it is recommended. In this case, the agent will impersonate the SQL Server Agent account. For more information, see [Replication Agent Security Model](../../relational-databases/replication/security/replication-agent-security-model.md). - (Optional) A value of **true** for to create an agent job that is used to synchronize the subscription. If you specify **false** (the default), the subscription can only be synchronized programmatically and you must specify additional properties of when you access this object from the property. For more information, see [Synchronize a Pull Subscription](../../relational-databases/replication/synchronize-a-pull-subscription.md). > [!NOTE] > SQL Server Agent is not available in every edition of [!INCLUDE[msCoName](../../includes/msconame-md.md)][!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)]. For a list of features that are supported by the editions of [!INCLUDE[ssNoVersion](../../includes/ssnoversion-md.md)], see [Features Supported by the Editions of SQL Server 2016](../../sql-server/editions-and-supported-features-for-sql-server-2016.md). When you specify a value of **true** for Express Subscribers, the agent job is not created. However, important subscription-related metadata is stored at the Subscriber. - (Optional) Set the and or fields of when using SQL Server Authentication to connect to the Distributor. 8. Call the method. 9. Using the instance of the class from step 2, call the method to register the pull subscription with the Publisher. If this registration already exists, an exception occurs. #### To create a pull subscription to a merge publication 1. Create connections to both the Subscriber and Publisher by using the class. 2. Create an instance of the class by using the Publisher connection from step 1. Specify , , and . 3. Call the method. If this method returns **false**, either the properties specified in step 2 are incorrect or the publication does not exist on the server. 4. Perform a bitwise logical AND (**&** in Visual C# and **And** in Visual Basic) between the property and . If the result is , set to the result of a bitwise logical OR (**|** in Visual C# and **Or** in Visual Basic) between and . Then, call to enable pull subscriptions. 5. If the subscription database does not exist, create it by using the class. For more information, see [Creating, Altering, and Removing Databases](../../relational-databases/server-management-objects-smo/tasks/creating-altering-and-removing-databases.md). 6. Create an instance of the class. 7. Set the following subscription properties: - The to the Subscriber created in step 1 for . - Name of the subscription database for . - Name of the Publisher for . - Name of the publication database for . - Name of the publication for . - The and fields of to provide the credentials for the [!INCLUDE[msCoName](../../includes/msconame-md.md)] Windows account under which the Merge Agent runs at the Subscriber. This account is used to make local connections to the Subscriber and to make remote connections using Windows Authentication. > [!NOTE] > Setting is not required when the subscription is created by a member of the **sysadmin** fixed server role, however it is recommended. In this case, the agent will impersonate the SQL Server Agent account. For more information, see [Replication Agent Security Model](../../relational-databases/replication/security/replication-agent-security-model.md). - (Optional) A value of **true** for to create an agent job that is used to synchronize the subscription. If you specify **false** (the default), the subscription can only be synchronized programmatically and you must specify additional properties of when you access this object from the property. For more information, see [Synchronize a Pull Subscription](../../relational-databases/replication/synchronize-a-pull-subscription.md). - (Optional) Set the and or fields of when using SQL Server Authentication to connect to the Distributor. - (Optional) Set the and or fields of when using SQL Server Authentication to connect to the Publisher. 8. Call the method. 9. Using the instance of the class from step 2, call the method to register the pull subscription with the Publisher. If this registration already exists, an exception occurs. ### Example (RMO) This example creates a pull subscription to a transactional publication. The [!INCLUDE[msCoName](../../includes/msconame-md.md)] Windows account credentials used to create the Distribution Agent job are passed at runtime. ```csharp // Define the Publisher, publication, and databases. string publicationName = "AdvWorksProductTran"; string publisherName = publisherInstance; string subscriberName = subscriberInstance; string subscriptionDbName = "AdventureWorksReplica"; string publicationDbName = "AdventureWorks"; //Create connections to the Publisher and Subscriber. ServerConnection subscriberConn = new ServerConnection(subscriberName); ServerConnection publisherConn = new ServerConnection(publisherName); // Create the objects that we need. TransPublication publication; TransPullSubscription subscription; try { // Connect to the Publisher and Subscriber. subscriberConn.Connect(); publisherConn.Connect(); // Ensure that the publication exists and that // it supports pull subscriptions. publication = new TransPublication(); publication.Name = publicationName; publication.DatabaseName = publicationDbName; publication.ConnectionContext = publisherConn; if (publication.IsExistingObject) { if ((publication.Attributes & PublicationAttributes.AllowPull) == 0) { publication.Attributes |= PublicationAttributes.AllowPull; } // Define the pull subscription. subscription = new TransPullSubscription(); subscription.ConnectionContext = subscriberConn; subscription.PublisherName = publisherName; subscription.PublicationName = publicationName; subscription.PublicationDBName = publicationDbName; subscription.DatabaseName = subscriptionDbName; // Specify the Windows login credentials for the Distribution Agent job. subscription.SynchronizationAgentProcessSecurity.Login = winLogin; subscription.SynchronizationAgentProcessSecurity.Password = winPassword; // Make sure that the agent job for the subscription is created. subscription.CreateSyncAgentByDefault = true; // By default, subscriptions to transactional publications are synchronized // continuously, but in this case we only want to synchronize on demand. subscription.AgentSchedule.FrequencyType = ScheduleFrequencyType.OnDemand; // Create the pull subscription at the Subscriber. subscription.Create(); Boolean registered = false; // Verify that the subscription is not already registered. foreach (TransSubscription existing in publication.EnumSubscriptions()) { if (existing.SubscriberName == subscriberName && existing.SubscriptionDBName == subscriptionDbName) { registered = true; } } if (!registered) { // Register the subscription with the Publisher. publication.MakePullSubscriptionWellKnown( subscriberName, subscriptionDbName, SubscriptionSyncType.Automatic, TransSubscriberType.ReadOnly); } } else { // Do something here if the publication does not exist. throw new ApplicationException(String.Format( "The publication '{0}' does not exist on {1}.", publicationName, publisherName)); } } catch (Exception ex) { // Implement the appropriate error handling here. throw new ApplicationException(String.Format( "The subscription to {0} could not be created.", publicationName), ex); } finally { subscriberConn.Disconnect(); publisherConn.Disconnect(); } ``` ```vb ' Define the Publisher, publication, and databases. Dim publicationName As String = "AdvWorksProductTran" Dim publisherName As String = publisherInstance Dim subscriberName As String = subscriberInstance Dim subscriptionDbName As String = "AdventureWorksReplica" Dim publicationDbName As String = "AdventureWorks" 'Create connections to the Publisher and Subscriber. Dim subscriberConn As ServerConnection = New ServerConnection(subscriberName) Dim publisherConn As ServerConnection = New ServerConnection(publisherName) ' Create the objects that we need. Dim publication As TransPublication Dim subscription As TransPullSubscription Try ' Connect to the Publisher and Subscriber. subscriberConn.Connect() publisherConn.Connect() ' Ensure that the publication exists and that ' it supports pull subscriptions. publication = New TransPublication() publication.Name = publicationName publication.DatabaseName = publicationDbName publication.ConnectionContext = publisherConn If publication.IsExistingObject Then If (publication.Attributes And PublicationAttributes.AllowPull) = 0 Then publication.Attributes = publication.Attributes _ Or PublicationAttributes.AllowPull End If ' Define the pull subscription. subscription = New TransPullSubscription() subscription.ConnectionContext = subscriberConn subscription.PublisherName = publisherName subscription.PublicationName = publicationName subscription.PublicationDBName = publicationDbName subscription.DatabaseName = subscriptionDbName subscription.Description = "Pull subscription to " + publicationDbName _ + " on " + subscriberName + "." ' Specify the Windows login credentials for the Distribution Agent job. subscription.SynchronizationAgentProcessSecurity.Login = winLogin subscription.SynchronizationAgentProcessSecurity.Password = winPassword ' Make sure that the agent job for the subscription is created. subscription.CreateSyncAgentByDefault = True ' By default, subscriptions to transactional publications are synchronized ' continuously, but in this case we only want to synchronize on demand. subscription.AgentSchedule.FrequencyType = ScheduleFrequencyType.OnDemand ' Create the pull subscription at the Subscriber. subscription.Create() Dim registered As Boolean = False ' Verify that the subscription is not already registered. For Each existing As TransSubscription In publication.EnumSubscriptions() If existing.SubscriberName = subscriberName And _ existing.SubscriptionDBName = subscriptionDbName Then registered = True End If Next existing If Not registered Then ' Register the subscription with the Publisher. publication.MakePullSubscriptionWellKnown( _ subscriberName, subscriptionDbName, _ SubscriptionSyncType.Automatic, _ TransSubscriberType.ReadOnly) End If Else ' Do something here if the publication does not exist. Throw New ApplicationException(String.Format( _ "The publication '{0}' does not exist on {1}.", _ publicationName, publisherName)) End If Catch ex As Exception ' Implement the appropriate error handling here. Throw New ApplicationException(String.Format( _ "The subscription to {0} could not be created.", publicationName), ex) Finally subscriberConn.Disconnect() publisherConn.Disconnect() End Try ``` This example creates a pull subscription to a merge publication. The Windows account credentials used to create the Merge Agent job are passed at runtime. ```cpp# // Define the Publisher, publication, and databases. string publicationName = "AdvWorksSalesOrdersMerge"; string publisherName = publisherInstance; string subscriberName = subscriberInstance; string subscriptionDbName = "AdventureWorksReplica"; string publicationDbName = "AdventureWorks"; string hostname = @"adventure-works\garrett1"; //Create connections to the Publisher and Subscriber. ServerConnection subscriberConn = new ServerConnection(subscriberName); ServerConnection publisherConn = new ServerConnection(publisherName); // Create the objects that we need. MergePublication publication; MergePullSubscription subscription; try { // Connect to the Subscriber. subscriberConn.Connect(); // Ensure that the publication exists and that // it supports pull subscriptions. publication = new MergePublication(); publication.Name = publicationName; publication.DatabaseName = publicationDbName; publication.ConnectionContext = publisherConn; if (publication.LoadProperties()) { if ((publication.Attributes & PublicationAttributes.AllowPull) == 0) { publication.Attributes |= PublicationAttributes.AllowPull; } // Define the pull subscription. subscription = new MergePullSubscription(); subscription.ConnectionContext = subscriberConn; subscription.PublisherName = publisherName; subscription.PublicationName = publicationName; subscription.PublicationDBName = publicationDbName; subscription.DatabaseName = subscriptionDbName; subscription.HostName = hostname; // Specify the Windows login credentials for the Merge Agent job. subscription.SynchronizationAgentProcessSecurity.Login = winLogin; subscription.SynchronizationAgentProcessSecurity.Password = winPassword; // Make sure that the agent job for the subscription is created. subscription.CreateSyncAgentByDefault = true; // Create the pull subscription at the Subscriber. subscription.Create(); Boolean registered = false; // Verify that the subscription is not already registered. foreach (MergeSubscription existing in publication.EnumSubscriptions()) { if (existing.SubscriberName == subscriberName && existing.SubscriptionDBName == subscriptionDbName && existing.SubscriptionType == SubscriptionOption.Pull) { registered = true; } } if (!registered) { // Register the local subscription with the Publisher. publication.MakePullSubscriptionWellKnown( subscriberName, subscriptionDbName, SubscriptionSyncType.Automatic, MergeSubscriberType.Local, 0); } } else { // Do something here if the publication does not exist. throw new ApplicationException(String.Format( "The publication '{0}' does not exist on {1}.", publicationName, publisherName)); } } catch (Exception ex) { // Implement the appropriate error handling here. throw new ApplicationException(String.Format( "The subscription to {0} could not be created.", publicationName), ex); } finally { subscriberConn.Disconnect(); publisherConn.Disconnect(); } ``` ```vb ' Define the Publisher, publication, and databases. Dim publicationName As String = "AdvWorksSalesOrdersMerge" Dim publisherName As String = publisherInstance Dim subscriberName As String = subscriberInstance Dim subscriptionDbName As String = "AdventureWorksReplica" Dim publicationDbName As String = "AdventureWorks" Dim hostname As String = "adventure-works\garrett1" 'Create connections to the Publisher and Subscriber. Dim subscriberConn As ServerConnection = New ServerConnection(subscriberName) Dim publisherConn As ServerConnection = New ServerConnection(publisherName) ' Create the objects that we need. Dim publication As MergePublication Dim subscription As MergePullSubscription Try ' Connect to the Subscriber. subscriberConn.Connect() ' Ensure that the publication exists and that ' it supports pull subscriptions. publication = New MergePublication() publication.Name = publicationName publication.DatabaseName = publicationDbName publication.ConnectionContext = publisherConn If publication.LoadProperties() Then If (publication.Attributes And PublicationAttributes.AllowPull) = 0 Then publication.Attributes = publication.Attributes _ Or PublicationAttributes.AllowPull End If ' Define the pull subscription. subscription = New MergePullSubscription() subscription.ConnectionContext = subscriberConn subscription.PublisherName = publisherName subscription.PublicationName = publicationName subscription.PublicationDBName = publicationDbName subscription.DatabaseName = subscriptionDbName subscription.HostName = hostname ' Specify the Windows login credentials for the Merge Agent job. subscription.SynchronizationAgentProcessSecurity.Login = winLogin subscription.SynchronizationAgentProcessSecurity.Password = winPassword ' Make sure that the agent job for the subscription is created. subscription.CreateSyncAgentByDefault = True ' Create the pull subscription at the Subscriber. subscription.Create() Dim registered As Boolean = False ' Verify that the subscription is not already registered. For Each existing As MergeSubscription In _ publication.EnumSubscriptions() If existing.SubscriberName = subscriberName Then registered = True End If Next If Not registered Then ' Register the local subscription with the Publisher. publication.MakePullSubscriptionWellKnown( _ subscriberName, subscriptionDbName, _ SubscriptionSyncType.Automatic, _ MergeSubscriberType.Local, 0) End If Else ' Do something here if the publication does not exist. Throw New ApplicationException(String.Format( _ "The publication '{0}' does not exist on {1}.", _ publicationName, publisherName)) End If Catch ex As Exception ' Implement the appropriate error handling here. Throw New ApplicationException(String.Format( _ "The subscription to {0} could not be created.", publicationName), ex) Finally subscriberConn.Disconnect() publisherConn.Disconnect() End Try ``` This example creates a pull subscription to a merge publication without creating an associated agent job and subscription metadata in [MSsubscription_properties](../../relational-databases/system-tables/mssubscription-properties-transact-sql.md). The Windows account credentials used to create the Merge Agent job are passed at runtime. ```csharp // Define the Publisher, publication, and databases. string publicationName = "AdvWorksSalesOrdersMerge"; string publisherName = publisherInstance; string subscriberName = subscriberInstance; string subscriptionDbName = "AdventureWorksReplica"; string publicationDbName = "AdventureWorks"; //Create connections to the Publisher and Subscriber. ServerConnection subscriberConn = new ServerConnection(subscriberName); ServerConnection publisherConn = new ServerConnection(publisherName); // Create the objects that we need. MergePublication publication; MergePullSubscription subscription; try { // Connect to the Subscriber. subscriberConn.Connect(); // Ensure that the publication exists and that // it supports pull subscriptions. publication = new MergePublication(); publication.Name = publicationName; publication.DatabaseName = publicationDbName; publication.ConnectionContext = publisherConn; if (publication.LoadProperties()) { if ((publication.Attributes & PublicationAttributes.AllowPull) == 0) { publication.Attributes |= PublicationAttributes.AllowPull; } // Define the pull subscription. subscription = new MergePullSubscription(); subscription.ConnectionContext = subscriberConn; subscription.PublisherName = publisherName; subscription.PublicationName = publicationName; subscription.PublicationDBName = publicationDbName; subscription.DatabaseName = subscriptionDbName; // Specify that an agent job not be created for this subscription. The // subscription can only be synchronized by running the Merge Agent directly. // Subscripition metadata stored in MSsubscription_properties will not // be available and must be specified at run time. subscription.CreateSyncAgentByDefault = false; // Create the pull subscription at the Subscriber. subscription.Create(); Boolean registered = false; // Verify that the subscription is not already registered. foreach (MergeSubscription existing in publication.EnumSubscriptions()) { if (existing.SubscriberName == subscriberName && existing.SubscriptionDBName == subscriptionDbName && existing.SubscriptionType == SubscriptionOption.Pull) { registered = true; } } if (!registered) { // Register the local subscription with the Publisher. publication.MakePullSubscriptionWellKnown( subscriberName, subscriptionDbName, SubscriptionSyncType.Automatic, MergeSubscriberType.Local, 0); } } else { // Do something here if the publication does not exist. throw new ApplicationException(String.Format( "The publication '{0}' does not exist on {1}.", publicationName, publisherName)); } } catch (Exception ex) { // Implement the appropriate error handling here. throw new ApplicationException(String.Format( "The subscription to {0} could not be created.", publicationName), ex); } finally { subscriberConn.Disconnect(); publisherConn.Disconnect(); } ``` ```vb ' Define the Publisher, publication, and databases. Dim publicationName As String = "AdvWorksSalesOrdersMerge" Dim publisherName As String = publisherInstance Dim subscriberName As String = subscriberInstance Dim subscriptionDbName As String = "AdventureWorksReplica" Dim publicationDbName As String = "AdventureWorks" 'Create connections to the Publisher and Subscriber. Dim subscriberConn As ServerConnection = New ServerConnection(subscriberName) Dim publisherConn As ServerConnection = New ServerConnection(publisherName) ' Create the objects that we need. Dim publication As MergePublication Dim subscription As MergePullSubscription Try ' Connect to the Subscriber. subscriberConn.Connect() ' Ensure that the publication exists and that ' it supports pull subscriptions. publication = New MergePublication() publication.Name = publicationName publication.DatabaseName = publicationDbName publication.ConnectionContext = publisherConn If publication.LoadProperties() Then If (publication.Attributes And PublicationAttributes.AllowPull) = 0 Then publication.Attributes = publication.Attributes _ Or PublicationAttributes.AllowPull End If ' Define the pull subscription. subscription = New MergePullSubscription() subscription.ConnectionContext = subscriberConn subscription.PublisherName = publisherName subscription.PublicationName = publicationName subscription.PublicationDBName = publicationDbName subscription.DatabaseName = subscriptionDbName ' Specify that an agent job not be created for this subscription. The ' subscription can only be synchronized by running the Merge Agent directly. ' Subscripition metadata stored in MSsubscription_properties will not ' be available and must be specified at run time. subscription.CreateSyncAgentByDefault = False ' Create the pull subscription at the Subscriber. subscription.Create() Dim registered As Boolean = False ' Verify that the subscription is not already registered. For Each existing As MergeSubscription In _ publication.EnumSubscriptions() If existing.SubscriberName = subscriberName Then registered = True End If Next If Not registered Then ' Register the local subscription with the Publisher. publication.MakePullSubscriptionWellKnown( _ subscriberName, subscriptionDbName, _ SubscriptionSyncType.Automatic, _ MergeSubscriberType.Local, 0) End If Else ' Do something here if the publication does not exist. Throw New ApplicationException(String.Format( _ "The publication '{0}' does not exist on {1}.", _ publicationName, publisherName)) End If Catch ex As Exception ' Implement the appropriate error handling here. Throw New ApplicationException(String.Format( _ "The subscription to {0} could not be created.", publicationName), ex) Finally subscriberConn.Disconnect() publisherConn.Disconnect() End Try ``` This example creates a pull subscription to a merge publication that can be synchronized over the Internet using Web synchronization. The Windows account credentials used to create the Merge Agent job are passed at runtime. For more information, see [Configure Web Synchronization](../../relational-databases/replication/configure-web-synchronization.md). ```csharp // Define the Publisher, publication, and databases. string publicationName = "AdvWorksSalesOrdersMerge"; string publisherName = publisherInstance; string subscriberName = subscriberInstance; string subscriptionDbName = "AdventureWorksReplica"; string publicationDbName = "AdventureWorks"; string hostname = @"adventure-works\garrett1"; string webSyncUrl = "https://" + publisherInstance + "/WebSync/replisapi.dll"; //Create connections to the Publisher and Subscriber. ServerConnection subscriberConn = new ServerConnection(subscriberName); ServerConnection publisherConn = new ServerConnection(publisherName); // Create the objects that we need. MergePublication publication; MergePullSubscription subscription; try { // Connect to the Subscriber. subscriberConn.Connect(); // Ensure that the publication exists and that // it supports pull subscriptions and Web synchronization. publication = new MergePublication(); publication.Name = publicationName; publication.DatabaseName = publicationDbName; publication.ConnectionContext = publisherConn; if (publication.LoadProperties()) { if ((publication.Attributes & PublicationAttributes.AllowPull) == 0) { publication.Attributes |= PublicationAttributes.AllowPull; } if ((publication.Attributes & PublicationAttributes.AllowWebSynchronization) == 0) { publication.Attributes |= PublicationAttributes.AllowWebSynchronization; } // Define the pull subscription. subscription = new MergePullSubscription(); subscription.ConnectionContext = subscriberConn; subscription.PublisherName = publisherName; subscription.PublicationName = publicationName; subscription.PublicationDBName = publicationDbName; subscription.DatabaseName = subscriptionDbName; subscription.HostName = hostname; // Specify the Windows login credentials for the Merge Agent job. subscription.SynchronizationAgentProcessSecurity.Login = winLogin; subscription.SynchronizationAgentProcessSecurity.Password = winPassword; // Enable Web synchronization. subscription.UseWebSynchronization = true; subscription.InternetUrl = webSyncUrl; // Specify the same Windows credentials to use when connecting to the // Web server using HTTPS Basic Authentication. subscription.InternetSecurityMode = AuthenticationMethod.BasicAuthentication; subscription.InternetLogin = winLogin; subscription.InternetPassword = winPassword; // Ensure that we create a job for this subscription. subscription.CreateSyncAgentByDefault = true; // Create the pull subscription at the Subscriber. subscription.Create(); Boolean registered = false; // Verify that the subscription is not already registered. foreach (MergeSubscription existing in publication.EnumSubscriptions()) { if (existing.SubscriberName == subscriberName && existing.SubscriptionDBName == subscriptionDbName && existing.SubscriptionType == SubscriptionOption.Pull) { registered = true; } } if (!registered) { // Register the local subscription with the Publisher. publication.MakePullSubscriptionWellKnown( subscriberName, subscriptionDbName, SubscriptionSyncType.Automatic, MergeSubscriberType.Local, 0); } } else { // Do something here if the publication does not exist. throw new ApplicationException(String.Format( "The publication '{0}' does not exist on {1}.", publicationName, publisherName)); } } catch (Exception ex) { // Implement the appropriate error handling here. throw new ApplicationException(String.Format( "The subscription to {0} could not be created.", publicationName), ex); } finally { subscriberConn.Disconnect(); publisherConn.Disconnect(); } ``` ```vb ' Define the Publisher, publication, and databases. Dim publicationName As String = "AdvWorksSalesOrdersMerge" Dim publisherName As String = publisherInstance Dim subscriberName As String = subscriberInstance Dim subscriptionDbName As String = "AdventureWorksReplica" Dim publicationDbName As String = "AdventureWorks" Dim hostname As String = "adventure-works\garrett1" Dim webSyncUrl As String = "https://" + publisherInstance + "/WebSync/replisapi.dll" 'Create connections to the Publisher and Subscriber. Dim subscriberConn As ServerConnection = New ServerConnection(subscriberName) Dim publisherConn As ServerConnection = New ServerConnection(publisherName) ' Create the objects that we need. Dim publication As MergePublication Dim subscription As MergePullSubscription Try ' Connect to the Subscriber. subscriberConn.Connect() ' Ensure that the publication exists and that ' it supports pull subscriptions and Web synchronization. publication = New MergePublication() publication.Name = publicationName publication.DatabaseName = publicationDbName publication.ConnectionContext = publisherConn If publication.LoadProperties() Then If (publication.Attributes And PublicationAttributes.AllowPull) = 0 Then publication.Attributes = publication.Attributes _ Or PublicationAttributes.AllowPull End If If (publication.Attributes And PublicationAttributes.AllowWebSynchronization) = 0 Then publication.Attributes = publication.Attributes _ Or PublicationAttributes.AllowWebSynchronization End If ' Define the pull subscription. subscription = New MergePullSubscription() subscription.ConnectionContext = subscriberConn subscription.PublisherName = publisherName subscription.PublicationName = publicationName subscription.PublicationDBName = publicationDbName subscription.DatabaseName = subscriptionDbName subscription.HostName = hostname subscription.CreateSyncAgentByDefault = True ' Specify the Windows login credentials for the Merge Agent job. subscription.SynchronizationAgentProcessSecurity.Login = winLogin subscription.SynchronizationAgentProcessSecurity.Password = winPassword ' Enable Web synchronization. subscription.UseWebSynchronization = True subscription.InternetUrl = webSyncUrl ' Specify the same Windows credentials to use when connecting to the ' Web server using HTTPS Basic Authentication. subscription.InternetSecurityMode = AuthenticationMethod.BasicAuthentication subscription.InternetLogin = winLogin subscription.InternetPassword = winPassword ' Create the pull subscription at the Subscriber. subscription.Create() Dim registered As Boolean = False ' Verify that the subscription is not already registered. For Each existing As MergeSubscription In _ publication.EnumSubscriptions() If existing.SubscriberName = subscriberName Then registered = True End If Next If Not registered Then ' Register the local subscription with the Publisher. publication.MakePullSubscriptionWellKnown( _ subscriberName, subscriptionDbName, _ SubscriptionSyncType.Automatic, _ MergeSubscriberType.Local, 0) End If Else ' Do something here if the publication does not exist. Throw New ApplicationException(String.Format( _ "The publication '{0}' does not exist on {1}.", _ publicationName, publisherName)) End If Catch ex As Exception ' Implement the appropriate error handling here. Throw New ApplicationException(String.Format( _ "The subscription to {0} could not be created.", publicationName), ex) Finally subscriberConn.Disconnect() publisherConn.Disconnect() End Try ``` ## See Also [Replication Management Objects Concepts](../../relational-databases/replication/concepts/replication-management-objects-concepts.md) [View and Modify Pull Subscription Properties](../../relational-databases/replication/view-and-modify-pull-subscription-properties.md) [Configure Web Synchronization](../../relational-databases/replication/configure-web-synchronization.md) [Subscribe to Publications](../../relational-databases/replication/subscribe-to-publications.md) [Replication Security Best Practices](../../relational-databases/replication/security/replication-security-best-practices.md)