Replication Queue Reader Agent Utility

Command Prompt Utilities

Command Prompt Utilities

Replication Queue Reader Agent Utility

The Replication Queue Reader Agent utility configures and begins the Queue Reader Agent, which reads messages stored in a SQL Server queue or a Microsoft Message Queue and then applies those messages to the Publisher. Queue Reader Agent is used with snapshot and transactional publications that allow queued updating.

Syntax

queueread [-?]
-Publisher server_name[\instance_name]
-PublisherDB publisher_database
[-Distributor server_name[\instance_name]]

[-DistributionDB distribution_database]
[-DistributorLogin distributor_login]
[-DistributorPassword distributor_password]
[-DistributorSecurityMode [0|1]]

[-ResolverState [1|2|3]]
[-HistoryVerboseLevel [1|2]]

[-PollingInterval polling_interval]

[-Continuous]
[-Output output_path_and_file_name]
[-OutputVerboseLevel [0|1|2]]

[-LoginTimeOut login_time_out_seconds]
[-QueryTimeOut query_time_out_seconds]

[-DefinitionFile definition_file]

Note  Parameters can be specified in any order. When optional parameters are not specified, values from predefined registry settings on the local computer are used.

Arguments

-?

Displays usage information.

-Publisher server_name[\instance_name]

Is the name of the Publisher. Specify server_name for the default instance of Microsoft® SQL Server™ 2000 on that server. Specify server_name\instance_name for a named instance of SQL Server 2000 on that server.

-PublisherDB publisher_database

Is the name of the Publisher database.

-Distributor server_name[\instance_name]

Is the Distributor name. Specify server_name for the default instance of SQL Server on that server. Specify server_name\instance_name for a named instance of SQL Server 2000 on that server. For Distributor (push) distribution, the name defaults to the name of the default instance of SQL Server on the local computer.

-DistributionDB distribution_database

Is the distribution database.

-DistributorLogin distributor_login

Is the Distributor login name.

-DistributorPassword distributor_password

Is the Distributor password.

-DistributorSecurityMode [0|1]

Specifies the security mode of the Distributor. A value of 0 indicates SQL Server Authentication Mode (default), and a value of 1 indicates Windows Authentication Mode.

-ResolverState [1|2|3]

Specifies how conflicts will be resolved. A value of 1 indicates the Publisher wins the conflict and the subscription will be reinitialized. A value of 2 indicates that the Publisher wins the conflict and the subscription will not be reinitialized. A value of 3 indicates the Subscriber wins the conflict.

-HistoryVerboseLevel [1|2]

Specifies the amount of history logged during a queue reader operation. You can minimize the performance affect of history logging by selecting 1.

HistoryVerboseLevel value
Description
1 Default. Always update a previous history message of the same status (startup, progress, success, and so forth). If no previous record with the same status exists, insert a new record.
2 Insert new history records unless the record is for such things as idle messages or long-running job messages, in which case update the previous records.

-PollingInterval polling_interval

Is how often, in seconds, the log is queried for replicated transactions. The default is 10 seconds. The value can be between 0 and 240 seconds.

-Continuous

Specifies whether the agent attempts to poll replicated transactions continually. If specified, the agent polls replicated transactions from the source at polling intervals even if there are no transactions pending.

-Output output_path_and_file_name

Is the path of the agent output file. If the file name is not provided, the output is sent to the console. If the specified file name exists, the output is appended to the file.

-OutputVerboseLevel [0|1|2]

Specifies whether the output should be verbose. If the verbose level is 0, only error messages are printed. If the verbose level is 1, all the progress report messages are printed. If the verbose level is 2 (default), all error messages and progress report messages are printed, which is useful for debugging.

-LoginTimeOut login_time_out_seconds

Is the number of seconds before the login times out. The default is 15 seconds.

-QueryTimeOut query_time_out_seconds

Is the number of seconds before the query times out. The default is 300 seconds.

-DefinitionFile def_path_and_file_name

Is the path of the agent definition file. An agent definition file contains command prompt arguments for the agent. The content of the file is parsed as an executable file. Double quotation marks (") can be used to specify argument values containing arbitrary characters.

For information about where to find or how to run this utility, see Getting Started with Command Prompt Utilities.

See Also

Queue Reader Agents

Replication Agents