Skip to content

Latest commit

 

History

History
117 lines (79 loc) · 5.66 KB

sp-addlogreader-agent-transact-sql.md

File metadata and controls

117 lines (79 loc) · 5.66 KB
title description author ms.author ms.reviewer ms.date ms.service ms.subservice ms.topic f1_keywords helpviewer_keywords dev_langs
sp_addlogreader_agent (Transact-SQL)
Adds a Log Reader agent for a given database.
mashamsft
mathoma
randolphwest
08/21/2024
sql
replication
reference
sp_addlogreader_agent
sp_addlogreader_agent_TSQL
sp_addlogreader_agent
TSQL

sp_addlogreader_agent (Transact-SQL)

[!INCLUDE SQL Server SQL MI]

Adds a Log Reader agent for a given database. This stored procedure is executed at the Publisher on the publication database.

Important

When configuring a Publisher with a remote Distributor, the values supplied for all parameters, including @job_login and @job_password, are sent to the Distributor as plain text. You should encrypt the connection between the Publisher and its remote Distributor before executing this stored procedure. For more information, see Configure SQL Server Database Engine for encrypting connections.

:::image type="icon" source="../../includes/media/topic-link-icon.svg" border="false"::: Transact-SQL syntax conventions

Syntax

sp_addlogreader_agent
    [ [ @job_login = ] N'job_login' ]
    [ , [ @job_password = ] N'job_password' ]
    [ , [ @job_name = ] N'job_name' ]
    [ , [ @publisher_security_mode = ] publisher_security_mode ]
    [ , [ @publisher_login = ] N'publisher_login' ]
    [ , [ @publisher_password = ] N'publisher_password' ]
    [ , [ @publisher = ] N'publisher' ]
[ ; ]

Arguments

[ @job_login = ] N'job_login'

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. On Azure SQL Managed Instance, use a SQL Server account.

Note

For non-[!INCLUDE ssNoVersion] Publishers, this must be the same login specified in sp_adddistpublisher.

[ @job_password = ] N'job_password'

The password for the Windows account under which the agent runs. @job_password is sysname, with a default of NULL.

Important

Don't store authentication information in script files. For best security, login names and passwords should be supplied at runtime.

[ @job_name = ] N'job_name'

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 started using an existing job instead of a newly created job (the default).

[ @publisher_security_mode = ] publisher_security_mode

[!INCLUDE entra-id]

The security mode used by the agent when connecting to the Publisher. @publisher_security_mode is smallint, with a default of 1. A value of 0 must be specified for non-[!INCLUDE ssNoVersion] Publishers. The following values define the security mode:

  • 0 specifies [!INCLUDE ssNoVersion] authentication.
  • 1 specifies Windows authentication.
  • 2 specifies Microsoft Entra password authentication starting with [!INCLUDE sssql22-md] CU 6.
  • 3 specifies Microsoft Entra integrated authentication starting with [!INCLUDE sssql22-md] CU 6.
  • 4 specifies Microsoft Entra token authentication starting with [!INCLUDE sssql22-md] CU 6.

[ @publisher_login = ] N'publisher_login'

The login used when connecting to the Publisher. @publisher_login is sysname, with a default of NULL. @publisher_login must be specified when @publisher_security_mode is 0. If @publisher_login is NULL and @publisher_security_mode is 1, then the Windows account specified in @job_login is used when connecting to the Publisher.

[ @publisher_password = ] N'publisher_password'

The password used when connecting to the Publisher. @publisher_password is sysname, with a default of NULL.

Important

Don't store authentication information in script files. For best security, login names and passwords should be supplied at runtime.

[ @publisher = ] N'publisher'

The name of the non-[!INCLUDE ssNoVersion] Publisher. @publisher is sysname, with a default of NULL.

Note

You shouldn't specify this parameter for a [!INCLUDE ssNoVersion] Publisher.

Return code values

0 (success) or 1 (failure).

Remarks

sp_addlogreader_agent is used in transactional replication.

You must execute sp_addlogreader_agent to add a Log Reader agent if you upgraded a database that was enabled for replication to this version of [!INCLUDE ssNoVersion] before a publication was created that used the database.

Permissions

Only members of the sysadmin fixed server role or the db_owner fixed database role can execute sp_addlogreader_agent.

Examples

:::code language="sql" source="../replication/codesnippet/tsql/sp-addlogreader-agent-tr_1.sql":::

Related content