Edit

Share via


sp_changesubscriptiondtsinfo (Transact-SQL)

Applies to: SQL Server Azure SQL Managed Instance

Changes the Data Transformation Services (DTS) package properties of a subscription. This stored procedure is executed at the Subscriber on the subscription database.

Transact-SQL syntax conventions

Syntax

sp_changesubscriptiondtsinfo
    [ @job_id = ] job_id
    [ , [ @dts_package_name = ] N'dts_package_name' ]
    [ , [ @dts_package_password = ] N'dts_package_password' ]
    [ , [ @dts_package_location = ] N'dts_package_location' ]
[ ; ]

Arguments

[ @job_id = ] job_id

The job ID of the Distribution Agent for the push subscription. @job_id is varbinary(16), with no default. To find the Distribution Job ID, run sp_helpsubscription or sp_helppullsubscription.

[ @dts_package_name = ] N'dts_package_name'

Specifies the name of the DTS package. @dts_package_name is sysname, with a default of NULL. For example, to specify a package named DTSPub_Package, you would specify @dts_package_name = N'DTSPub_Package'.

[ @dts_package_password = ] N'dts_package_password'

Specifies the password on the package. @dts_package_password is sysname, with a default of NULL, which specifies that the password property is to be left unchanged.

Note

A DTS package must have a password.

[ @dts_package_location = ] N'dts_package_location'

Specifies the package location. @dts_package_location is nvarchar(12), with a default of NULL, which specifies that the package location is to be left unchanged. The location of the package can be changed to distributor or subscriber.

Return code values

0 (success) or 1 (failure).

Remarks

sp_changesubscriptiondtsinfo is used for snapshot replication and transactional replication that are push subscriptions only.

Permissions

Only members of the sysadmin fixed server role, db_owner fixed database role, or the creator of the subscription can execute sp_changesubscriptiondtsinfo.