sp_helplogreader_agent (Transact-SQL)

Article
02/28/2023
2 minutes to read

Applies to: SQL Server

Returns properties of the Log Reader Agent job for the publication database. This stored procedure is executed at the Publisher on the publication database.

Transact-SQL syntax conventions

Syntax

  
sp_helplogreader_agent [ [ @publisher = ] 'publisher' ]

Arguments

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

Result Sets

Column name	Data type	Description
id	int	ID of the agent.
name	nvarchar(100)	Name of the agent.
publisher_security_mode	smallint	Security mode used by the agent when connecting to the Publisher, which can be one of the following: 0 = SQL Server Authentication 1 = Windows Authentication.
publisher_login	sysname	Login used when connecting to the Publisher.
publisher_password	nvarchar(524)	For security reasons, a value of ********** is always returned.
job_id	uniqueidentifier	Unique ID of the agent job.
job_login	nvarchar(512)	Is the Windows account under which the Log Reader 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)

Remarks

sp_helplogreader_agent is used in transactional replication.

Permissions

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