sp_addlogreader_agent (Transact-SQL)

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

Security Note

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 Enable Encrypted Connections to the Database Engine (SQL Server Configuration Manager).

Transact-SQL Syntax Conventions

Syntax

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

Arguments

• [ @job_login= ] 'job_login'
  Is the login for the Microsoft Windows account under which the agent runs. job_login is nvarchar(257), with a default value of NULL. This Windows account is always used for agent connections to the Distributor.

  Note

  For non-Microsoft SQL Server Publishers, this must be the same login specified in sp_adddistpublisher (Transact-SQL).

• [ @job_password= ] 'job_password'
  Is the password for the Windows account under which the agent runs. job_password is sysname, with a default value of NULL.

  Security Note
  Do not store authentication information in script files. For best security, login names and passwords should be supplied at runtime.

• [ @job_name= ] 'job_name'
  Is the name of an existing agent job. job_name is sysname, with a default value 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
  Is the security mode used by the agent when connecting to the Publisher. publisher_security_mode is smallint, with a default of 1. 0 specifies SQL Server Authentication, and 1 specifies Windows Authentication. A value of 0 must be specified for non-SQL Server Publishers.

• [ @publisher_login= ] 'publisher_login'
  Is 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 will be used when connecting to the Publisher.

• [ @publisher_password= ] 'publisher_password'
  Is the password used when connecting to the Publisher. publisher_password is sysname, with a default of NULL.

  Security Note
  Do not store authentication information in script files. For best security, login names and passwords should be supplied at runtime.

• [ @publisher= ] 'publisher'
  Is the name of the non-SQL Server Publisher. publisher is sysname, with a default of NULL.

  Note

  You should not specify this parameter for a SQL Server 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 SQL Server 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.

Example

-- To avoid storing the login and password in the script file, the values 
-- are passed into SQLCMD as scripting variables. For information about 
-- how to use scripting variables on the command line and in SQL Server
-- Management Studio, see the "Executing Replication Scripts" section in
-- the topic "Programming Replication Using System Stored Procedures".

DECLARE @publicationDB AS sysname;
DECLARE @publication AS sysname;
DECLARE @login AS sysname;
DECLARE @password AS sysname;
SET @publicationDB = N'AdventureWorks'; 
SET @publication = N'AdvWorksProductTran'; 
-- Windows account used to run the Log Reader and Snapshot Agents.
SET @login = $(Login); 
-- This should be passed at runtime.
SET @password = $(Password); 

-- Enable transactional or snapshot replication on the publication database.
EXEC sp_replicationdboption 
    @dbname=@publicationDB, 
    @optname=N'publish',
    @value = N'true';

-- Execute sp_addlogreader_agent to create the agent job. 
EXEC sp_addlogreader_agent 
    @job_login = @login, 
    @job_password = @password,
    -- Explicitly specify the use of Windows Integrated Authentication (default) 
    -- when connecting to the Publisher.
    @publisher_security_mode = 1;

-- Create a new transactional publication with the required properties. 
EXEC sp_addpublication 
    @publication = @publication, 
    @status = N'active',
    @allow_push = N'true',
    @allow_pull = N'true',
    @independent_agent = N'true';

-- Create a new snapshot job for the publication, using a default schedule.
EXEC sp_addpublication_snapshot 
    @publication = @publication, 
    @job_login = @login, 
    @job_password = @password,
    -- Explicitly specify the use of Windows Integrated Authentication (default) 
    -- when connecting to the Publisher.
    @publisher_security_mode = 1;
GO

See Also

Reference

sp_addpublication (Transact-SQL)

sp_changelogreader_agent (Transact-SQL)

Replication Stored Procedures (Transact-SQL)

Concepts

Create a Publication