sp_helpsubscription_properties (Transact-SQL)
Applies to: 
SQL Server
Azure SQL Managed Instance
Retrieves security information from the MSsubscription_properties table. This stored procedure is executed at the Subscriber.
Transact-SQL syntax conventions
Syntax
sp_helpsubscription_properties
[ [ @publisher = ] N'publisher' ]
[ , [ @publisher_db = ] N'publisher_db' ]
[ , [ @publication = ] N'publication' ]
[ , [ @publication_type = ] publication_type ]
[ ; ]
Arguments
[ @publisher = ] N'publisher'
The name of the Publisher. @publisher is sysname, with a default of %, which returns information on all Publishers.
[ @publisher_db = ] N'publisher_db'
The name of the Publisher database. @publisher_db is sysname, with a default of %, which returns information on all Publisher databases.
[ @publication = ] N'publication'
The name of the publication. @publication is sysname, with a default of %, which returns information on all publications.
[ @publication_type = ] publication_type
The type of publication. @publication_type is int, with a default of NULL. If supplied, @publication_type must be one of the following values:
| Value | Description |
|---|---|
0 |
Transactional publication |
1 |
Snapshot publication |
2 |
Merge publication |
Result set
| Column name | Data type | Description |
|---|---|---|
publisher |
sysname | Name of the Publisher. |
publisher_db |
sysname | Name of the Publisher database. |
publication |
sysname | Name of the publication. |
publication_type |
int | Type of publication:0 = Transactional1 = Snapshot2 = Merge |
publisher_login |
sysname | Login ID used at the Publisher for SQL Server Authentication. |
publisher_password |
nvarchar(524) | Password used at the Publisher for SQL Server Authentication (encrypted). |
publisher_security_mode |
int | Security mode used at the Publisher:0 = SQL Server Authentication1 = Windows Authentication |
distributor |
sysname | Name of the Distributor. |
distributor_login |
sysname | Distributor login. |
distributor_password |
nvarchar(524) | Distributor password (encrypted). |
distributor_security_mode |
int | Security mode used at the Distributor:0 = SQL Server Authentication1 = Windows Authentication |
ftp_address |
sysname | This parameter is deprecated and is maintained for backward compatibility of scripts. |
ftp_port |
int | This parameter is deprecated and is maintained for backward compatibility of scripts. |
ftp_login |
sysname | This parameter is deprecated and is maintained for backward compatibility of scripts. |
ftp_password |
nvarchar(524) | This parameter is deprecated and is maintained for backward compatibility of scripts. |
alt_snapshot_folder |
nvarchar(255) | Specifies the location of the alternate folder for the snapshot. |
working_directory |
nvarchar(255) | Name of the working directory used to store data and schema files. |
use_ftp |
bit | Specifies the use of FTP instead of the regular protocol to retrieve snapshots. If 1, FTP is used. |
dts_package_name |
sysname | Specifies the name of the Data Transformation Services (DTS) package. |
dts_package_password |
nvarchar(524) | Specifies the password on the package, if there's one. |
dts_package_location |
int | Location where the DTS package is stored.0 = the package location is at the Distributor.1 = the package location is at the Subscriber. |
offload_agent |
bit | Specifies if the agent can be activated remotely. If 0, the agent can't be activated remotely. |
offload_server |
sysname | Specifies the network name of the server used for remote activation. |
dynamic_snapshot_location |
nvarchar(255) | Specifies the path to the folder where the snapshot files are saved. |
use_web_sync |
bit | Specifies if the subscription can be synchronized over HTTPS, where a value of 1 means that this feature is enabled. |
internet_url |
nvarchar(260) | URL that represents the location of the replication listener for Web synchronization. |
internet_login |
nvarchar(128) | Login that the Merge Agent uses when connecting to the Web server that is hosting Web synchronization using Basic Authentication. |
internet_password |
nvarchar(524) | Password for the login that the Merge Agent uses when connecting to the Web server that is hosting Web synchronization using Basic Authentication. |
internet_security_mode |
int | The authentication mode used when connecting to the Web server that is hosting Web synchronization, where a value of 1 means Windows Authentication, and a value of 0 means Basic Authentication. |
internet_timeout |
int | Length of time, in seconds, before a Web synchronization request expires. |
hostname |
nvarchar(128) | Specifies the value for HOST_NAME() when this function is used in the WHERE clause parameterized row filter. |
Return code values
0 (success) or 1 (failure).
Remarks
sp_helpsubscription_properties is used in snapshot replication, transactional replication, and merge replication.
Permissions
Only members of the sysadmin fixed server role or db_owner fixed database role can execute sp_helpsubscription_properties.