sp_MSchange_logreader_agent_properties (Transact-SQL)

Applies to: SQL Server

Changes the properties of a Log Reader Agent job that runs at a SQL Server 2005 (9.x) or later version Distributor. This stored procedure is used to change properties when the Publisher runs on an instance of SQL Server 2000 (8.x). This stored procedure is executed at the Distributor on the distribution database.

Transact-SQL syntax conventions

Syntax

sp_MSchange_logreader_agent_properties
    [ @publisher = ] N'publisher'
    , [ @publisher_db = ] N'publisher_db'
    , [ @publisher_security_mode = ] publisher_security_mode
    , [ @publisher_login = ] N'publisher_login'
    , [ @publisher_password = ] N'publisher_password'
    , [ @job_login = ] N'job_login'
    , [ @job_password = ] N'job_password'
    , [ @publisher_type = ] N'publisher_type'
[ ; ]

Arguments

[ @publisher = ] N'publisher'

The name of the Publisher. @publisher is sysname, with no default.

[ @publisher_db = ] N'publisher_db'

The name of the publication database. @publisher_db is sysname, with no default.

[ @publisher_security_mode = ] publisher_security_mode

The security mode used by the agent when connecting to the Publisher. @publisher_security_mode is int, with no default.

  • 0 specifies SQL Server authentication
  • 1 specifies Windows authentication

[ @publisher_login = ] N'publisher_login'

The login used when connecting to the Publisher. @publisher_login is sysname, with no default. @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 nvarchar(524), with no default.

[ @job_login = ] N'job_login'

The login for the Windows account under which the agent runs. @job_login is nvarchar(257), with no default. This property can't be changed for a non-SQL Server Publisher.

[ @job_password = ] N'job_password'

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

[ @publisher_type = ] N'publisher_type'

Specifies the Publisher type when the Publisher isn't running in an instance of SQL Server. @publisher_type is sysname, and can be one of the following values.

Value Description
MSSQLSERVER Specifies a SQL Server Publisher.
ORACLE Specifies a standard Oracle Publisher.
ORACLE GATEWAY Specifies an Oracle Gateway Publisher.

For more information about the differences between an Oracle Publisher and an Oracle Gateway Publisher, see Oracle Publishing Overview.

Remarks

sp_MSchange_logreader_agent_properties is used in transactional replication.

You must specify all parameters when executing sp_MSchange_logreader_agent_properties. Execute sp_helplogreader_agent to return the current properties of the Log Reader Agent job.

After changing an agent login or password, you must stop and restart the agent before the change takes effect.

You can use sp_changelogreader_agent on the Publisher to change properties of the Log Reader Agent.

Permissions

Only members of the sysadmin fixed server role at the Distributor can execute sp_MSchange_logreader_agent_properties.