ReplicationMonitor.EnumQueueReaderAgents Method
Returns information on Queue Reader Agent jobs at the monitored Distributor.
Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)
Syntax
'Declaration
Public Function EnumQueueReaderAgents As DataSet
public DataSet EnumQueueReaderAgents ()
public:
DataSet^ EnumQueueReaderAgents ()
public DataSet EnumQueueReaderAgents ()
public function EnumQueueReaderAgents () : DataSet
Return Value
A DataSet object that contains the following columns.
Column |
Data type |
Description |
db_name |
Name of the distribution database. |
|
name |
String |
Replication agent job name. |
status |
The running status: 1 = Start 2 = Succeed 3 = In progress 4 = Idle 5 = Retry 6 = Fail |
|
start_time |
String |
Date and time of the 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 delivered in the session. |
commands_processed |
Int32 |
Total number of commands delivered in the session. |
average_commands |
Int32 |
Average number of commands per transaction delivered in the session. |
delivery_rate |
Average number of commands delivered per second. |
|
delivery_latency |
Int32 |
The time, in milliseconds, between a command being added to the queue and being committed to the publication database. |
error_id |
Int32 |
The ID of the error in the MSrepl_errors (Transact-SQL) system table. Use the EnumErrorRecords method to return detailed information about an error. |
job_id |
Byte[16] |
Identifier of the SQL Server Agent job starting the replication agent. |
profile_id |
Int32 |
Profile identifier. |
agent_id |
Int32 |
Agent job identifier. |
local_timestamp |
Byte[8] |
Timestamp of the most recent agent run. |
Remarks
You should commit any property changes to the ReplicationMonitor object before calling this method because properties of this object may need to be loaded if they have not been loaded already.
The EnumQueueReaderAgents method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.
This namespace, class, or member is supported only in version 2.0 of the .NET Framework.
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms
Development Platforms
For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.
Target Platforms
For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.
See Also
Reference
ReplicationMonitor Class
ReplicationMonitor Members
Microsoft.SqlServer.Replication Namespace
Other Resources
How to: Programmatically Monitor Replication (RMO Programming)