Share via


PublicationMonitor.EnumQueueReaderAgent Method

Definition

Returns information for the Queue Reader Agent job used by the monitored publication.

public:
 System::Data::DataSet ^ EnumQueueReaderAgent();
public System.Data.DataSet EnumQueueReaderAgent ();
member this.EnumQueueReaderAgent : unit -> System.Data.DataSet
Public Function EnumQueueReaderAgent () As DataSet

Returns

A DataSet object that contains the following columns.

Column Data type Description
name String Replication Agent job name.
status Int32 The running status:

1 = Start

2 = Succeed

3 = In progress

4 = Idle

5 = Retry

6 = Fail

start_time String Date and time of last agent execution.
time String Date and time that the session was logged.
duration Int32 Elapsed time of the session, in seconds.
comments String Message text logged by the agent.
transactions_processed Int32 Total number of transactions processed in the session.
commands_processed Int32 Total number of commands processed in the session.
average_commands Int32 Average number of commands per transaction delivered in the session.
delivery_rate Single Average number of commands delivered per second.
delivery_latency Int32 The time, in milliseconds, between a command being read from the queue at the Subscriber and being committed to the publication database.
error_id Int32 The ID of the error in the [MSrepl_errors (Transact-SQL)](http://msdn.microsoft.com/library/c6e023c1-2c32-4269-8d76-e442ea309e4b) system table. Use the EnumErrorRecords(Int32) method to return detailed information about an error.
job_id Byte **[16]** Identifier of the SQL Server Agent job starting the replication agent.
local_job Boolean When true, the agent job is available at the Distributor.
profile_id Int32 Profile identifier.
agent_id Int32 Agent job identifier.
local_timestamp Byte **[8]** Timestamp of the most recent agent run.

Remarks

The EnumQueueReaderAgent method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.

Applies to

See also