sp_MSchange_logreader_agent_properties (Transact-SQL)

THIS TOPIC APPLIES TO:yesSQL Server (starting with 2008)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

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

Topic link icon Transact-SQL Syntax Conventions

Syntax


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

Arguments

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

[ @publisher_db= ] 'publisher_db'
Is the name of the publication database. publisher_db is sysname, with no 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 no default.

0 specifies SQL Server Authentication.

1 specifies Windows Authentication.

[ @publisher_login= ] 'publisher_login'
Is 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 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 no default.

[ @job_login= ] 'job_login'
Is the login for the Windows account under which the agent runs. job_login is nvarchar(257), with no default. This cannot be changed for a non- SQL Server publisher.

[ @job_password= ] 'job_password'
Is the password for the Windows account under which the agent runs. job_password is sysname, with no default.

[ @publisher_type= ] 'publisher_type'
Specifies the Publisher type when the Publisher is not 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 (Transact-SQL) 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.

When the Publisher runs on an instance of SQL Server 2005 or later version, you should use sp_changelogreader_agent 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.

See Also

sp_addlogreader_agent (Transact-SQL)