| title | sp_addqreader_agent (Transact-SQL) | ||
|---|---|---|---|
| description | sp_addqreader_agent adds a Queue Reader agent for a given Distributor. | ||
| author | markingmyname | ||
| ms.author | maghan | ||
| ms.reviewer | randolphwest | ||
| ms.date | 06/23/2025 | ||
| ms.service | sql | ||
| ms.subservice | replication | ||
| ms.topic | reference | ||
| f1_keywords |
|
||
| helpviewer_keywords |
|
||
| dev_langs |
|
[!INCLUDE SQL Server SQL MI]
Adds a Queue Reader agent for a given Distributor. This stored procedure is executed at the Distributor on the distribution database or at the Publisher on the publication database.
:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions
sp_addqreader_agent
[ [ @job_login = ] N'job_login' ]
[ , [ @job_password = ] N'job_password' ]
[ , [ @job_name = ] N'job_name' ]
[ , [ @frompublisher = ] frompublisher ]
[ ; ]
The login for the Windows account under which the agent runs. @job_login is nvarchar(257), with a default of NULL. This Windows account is always used for agent connections to the Distributor.
The password for the Windows account under which the agent runs. @job_password is sysname, with no default.
Important
Don't store authentication information in script files. For best security, login names and passwords should be supplied at runtime.
The name of an existing agent job. @job_name is sysname, with a default of NULL. This parameter is only specified when the agent is created using an existing job instead of a newly created job (the default).
Specifies whether the procedure is being executed at the Publisher. @frompublisher is bit, with a default of 0.
A value of 1 means that the procedure is being executed from the Publisher on the publication database.
0 (success) or 1 (failure).
sp_addqreader_agent is used in transactional replication.
sp_addqreader_agent must be executed at least once at a Distributor that supports queued updating after sp_adddistributiondb but before sp_addpublication.
The Queue Reader Agent job is removed when you execute sp_dropdistributiondb.
Only members of the sysadmin fixed server role can execute sp_addqreader_agent.