sp_addpushsubscription_agent (Transact-SQL)

Adds a new scheduled agent job used to synchronize a push subscription to a transactional publication. This stored procedure is executed at the Publisher on the publication database.

Security noteSecurity Note

 When configuring a Publisher with a remote Distributor, the values supplied for all parameters, including job_login and job_password, are sent to the Distributor as plain text. You should encrypt the connection between the Publisher and its remote Distributor before executing this stored procedure. For more information, see Encrypting Connections to SQL Server.

Topic link iconTransact-SQL Syntax Conventions

Syntax

sp_addpushsubscription_agent [ @publication= ] 'publication'
    [ , [ @subscriber = ] 'subscriber' ]
    [ , [ @subscriber_db = ] 'subscriber_db' ]
    [ , [ @subscriber_security_mode = ] subscriber_security_mode ]
    [ , [ @subscriber_login = ] 'subscriber_login' ]
    [ , [ @subscriber_password = ] 'subscriber_password' ]
    [ , [ @job_login= ] 'job_login' ] 
    [ , [ @job_password= ] 'job_password' ] 
    [ , [ @job_name= ] 'job_name' ] 
    [ , [ @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 ]
    [ , [ @dts_package_name = ] 'dts_package_name' ]
    [ , [ @dts_package_password = ] 'dts_package_password' ]
    [ , [ @dts_package_location = ] 'dts_package_location' ]
    [ , [ @enabled_for_syncmgr = ] 'enabled_for_syncmgr' ]
    [ , [ @distribution_job_name = ] 'distribution_job_name' ]
    [ , [ @publisher= ] 'publisher' ]
    [ , [ @subscriber_provider= ] 'subscriber_provider' ] 
    [ , [ @subscriber_datasrc= ] 'subscriber_datasrc' ] 
    [ , [ @subscriber_location= ] 'subscriber_location' ]
    [ , [ @subscriber_provider_string= ] 'subscriber_provider_string' ] 
    [ , [ @subscriber_catalog= ] 'subscriber_catalog' ]

Arguments

  • [ @publication =] 'publication'
    Is the name of the publication. publication is sysname, with no default.

  • [ @subscriber =] 'subscriber'
    Is the name of the Subscriber. subscriber is sysname, with a default of NULL.

  • [ @subscriber\_db =] 'subscriber_db'
    Is the name of the subscription database. subscriber_db is sysname, with a default of NULL. For a non-SQL Server Subscriber, specify a value of (default destination) for subscriber_db.

  • [ @subscriber\_security\_mode =] subscriber_security_mode
    Is the security mode to use when connecting to a Subscriber when synchronizing. subscriber_security_mode is int, with a default of 1. 0 specifies SQL Server Authentication. 1 specifies Windows Authentication.

    Security noteSecurity Note

     For queued updating subscriptions, use SQL Server Authentication for connections to Subscribers, and specify a different account for the connection to each Subscriber. For all other subscriptions, use Windows Authentication.

  • [ @subscriber\_login =] 'subscriber_login'
    Is the Subscriber login to use when connecting to a Subscriber when synchronizing. subscriber_login is sysname, with a default of NULL.

  • [ @subscriber\_password =] 'subscriber_password'
    Is the Subscriber password. subscriber_password is required if subscriber_security_mode is set to 0. subscriber_password is sysname, with a default of NULL. If a subscriber password is used, it is automatically encrypted.

    Security noteSecurity Note

    Do not use a blank password. Use a strong password. When possible, prompt users to enter security credentials at runtime. If you must store credentials in a script file, you must secure the file to prevent unauthorized access.

  • [ @job\_login = ] 'job_login'
    Is the login for the Windows account under which the agent runs. job_login is nvarchar(257), with a default value of NULL. This Windows account is always used for agent connections to the Distributor and for connections to the Subscriber when using Windows Integrated authentication.

  • [ @job\_password = ] 'job_password'
    Is the password for the Windows account under which the agent runs. job_password is sysname, with no default.

    Security noteSecurity Note

    When possible, prompt users to enter security credentials at runtime. If you must store credentials in a script file, you must secure the file to prevent unauthorized access.

  • [ @job\_name = ] 'job_name'
    Is the name of an existing agent job. job_name is sysname, with a default value of NULL. This parameter is only specified when the subscription will be synchronized using an existing job instead of a newly created job (the default). If you are not a member of the sysadmin fixed server role, you must specify job_login and job_password when you specify job_name.

  • [ @frequency\_type = ] frequency_type
    Is the frequency with which to schedule the Distribution Agent. frequency_type is int, and can be one of the following values.

    Value

    Description

    1

    One time

    2

    On demand

    4

    Daily

    8

    Weekly

    16

    Monthly

    32

    Monthly relative

    64 (default)

    Autostart

    128

    Recurring

    Note

    Specifying a value of 64 causes the Distribution Agent to run in continuous mode. This corresponds to setting the -Continuous parameter for the agent. For more information, see Replication Distribution Agent.

  • [ @frequency\_interval = ] frequency_interval
    Is the value to apply 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 the following values.

    Value

    Description

    1 (default)

    First

    2

    Second

    4

    Third

    8

    Fourth

    16

    Last

  • [ @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 the following values.

    Value

    Description

    1

    Once

    2

    Second

    4 (default)

    Minute

    8

    Hour

  • [ @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.

  • [ @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.

  • [ @dts\_package\_name = ] 'dts_package_name'
    Specifies the name of the Data Transformation Services (DTS) package. dts_package_name is a sysname with a default of NULL. For example, to specify a package name of DTSPub_Package, the parameter would be @dts\_package\_name = N'DTSPub_Package'.

  • [ @dts\_package\_password = ] 'dts_package_password'
    Specifies the password required to run the package. dts_package_password is sysname with a default of NULL.

    Note

    You must specify a password if dts_package_name is specified.

  • [ @dts\_package\_location = ] 'dts_package_location'
    Specifies the package location. dts_package_location is a nvarchar(12), with a default of DISTRIBUTOR. The location of the package can be distributor or subscriber.

  • [ @enabled\_for\_syncmgr = ] 'enabled_for_syncmgr'
    Is whether the subscription can be synchronized through Microsoft Synchronization Manager. enabled_for_syncmgr is nvarchar(5), with a default of FALSE. If false, the subscription is not registered with Synchronization Manager. If true, the subscription is registered with Synchronization Manager and can be synchronized without starting SQL Server Management Studio.

  • [ @distribution\_job\_name = ] 'distribution_job_name'
    Identified for informational purposes only. Not supported. Future compatibility is not guaranteed.

  • [ @publisher = ] 'publisher'
    Is the name of the Publisher. publisher is sysname, with a default value of NULL.

  • [ **@subscriber\_provider=** ] 'subscriber_provider'
    Is the unique programmatic identifier (PROGID) with which the OLE DB provider for the non-SQL Server data source is registered. subscriber_provider is sysname, with default value of NULL. subscriber_provider must be unique for the OLE DB provider installed on the Distributor. subscriber_provider is only supported for non-SQL Server Subscribers.

  • [ **@subscriber\_datasrc=** ] 'subscriber_datasrc'
    Is the name of the data source as understood by the OLE DB provider. subscriber_datasrc is nvarchar(4000), with a default value of NULL. subscriber_datasrc is passed as the DBPROP_INIT_DATASOURCE property to initialize the OLE DB provider. subscriber_datasrc is only supported for non-SQL Server Subscribers.

  • [ **@subscriber\_location=** ] 'subscriber_location'
    Is the location of the database as understood by the OLE DB provider. subscriber_location is nvarchar(4000), with a default value of NULL. subscriber_location is passed as the DBPROP_INIT_LOCATION property to initialize the OLE DB provider. subscriber_location is only supported for non-SQL Server Subscribers.

  • [ **@subscriber\_provider\_string=** ] 'subscriber_provider_string'
    Is the OLE DB provider-specific connection string that identifies the data source. subscriber_provider_string is nvarchar(4000), with a default value of NULL. subscriber_provider_string is passed to IDataInitialize or set as the DBPROP_INIT_PROVIDERSTRING property to initialize the OLE DB provider. subscriber_provider_string is only supported for non-SQL Server Subscribers.

  • [ **@subscriber\_catalog=** ] 'subscriber_catalog'
    Is the catalog to be used when making a connection to the OLE DB provider. subscriber_catalog is sysname, with default value of NULL. subscriber_catalog is passed as the DBPROP_INIT_CATALOG property to initialize the OLE DB provider. subscriber_catalog is only supported for non-SQL Server Subscribers.

Return Code Values

0 (success) or 1 (failure)

Remarks

sp_addpushsubscription_agent is used in snapshot replication and transactional replication.

Example

-- 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".

DECLARE @publication AS sysname;
DECLARE @subscriber AS sysname;
DECLARE @subscriptionDB AS sysname;
SET @publication = N'AdvWorksProductTran';
SET @subscriber = $(SubServer);
SET @subscriptionDB = N'AdventureWorksReplica';

--Add a push subscription to a transactional publication.
USE [AdventureWorks]
EXEC sp_addsubscription 
  @publication = @publication, 
  @subscriber = @subscriber, 
  @destination_db = @subscriptionDB, 
  @subscription_type = N'push';

--Add an agent job to synchronize the push subscription.
EXEC sp_addpushsubscription_agent 
  @publication = @publication, 
  @subscriber = @subscriber, 
  @subscriber_db = @subscriptionDB, 
  @job_login = $(Login), 
  @job_password = $(Password);
GO

Permissions

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