Applies to: SQL Server Azure SQL Managed Instance
Returns properties of the Queue Reader agent. This stored procedure is executed at the Distributor on the distribution database or at the Publisher on any database.
Transact-SQL syntax conventions
sp_helpqreader_agent [ [ @frompublisher = ] frompublisher ]
[ @frompublisher = ] frompublisher
Specifies whether the stored procedure is called at the Publisher or at the Distributor. frompublisher is bit, with a default value of 0. 1 means that the stored procedure is called from the Publisher, and 0 means that the stored procedure is called from the Distributor.
|Column name||Data type||Description|
|id||int||ID of the agent.|
|name||nvarchar(100)||Name of the agent.|
|job_id||uniqueidentifier||Unique ID of the agent job.|
|job_login||nvarchar(512)||Is the Windows account under which the Distribution agent runs, which is returned in the format DOMAIN\username.|
|job_password||sysname||For security reasons, a value of ********** is always returned.|
Return Code Values
0 (success) or 1 (failure)
sp_helpqreader_agent is used in transactional replication.
When the value of frompublisher is 1, only members of the sysadmin fixed server role at the Publisher or members of the db_owner fixed database role on the publication database can execute sp_helpqreader_agent. Otherwise, only members of the sysadmin fixed server role at the Distributor or members of the db_owner fixed database role on the distribution database can execute sp_helpqreader_agent.
Enable Updating Subscriptions for Transactional Publications