PublisherMonitor.EnumLogReaderAgentSessionDetails Method

Returns detailed information about a Log Reader Agent session.

命名空间: Microsoft.SqlServer.Replication
程序集: Microsoft.SqlServer.Rmo (in microsoft.sqlserver.rmo.dll)

语法

声明
Public Function EnumLogReaderAgentSessionDetails ( _
    agentName As String, _
    sessionId As String _
) As DataSet
public DataSet EnumLogReaderAgentSessionDetails (
    string agentName,
    string sessionId
)
public:
DataSet^ EnumLogReaderAgentSessionDetails (
    String^ agentName, 
    String^ sessionId
)
public DataSet EnumLogReaderAgentSessionDetails (
    String agentName, 
    String sessionId
)
public function EnumLogReaderAgentSessionDetails (
    agentName : String, 
    sessionId : String
) : DataSet

参数

  • agentName
    A String value that specifies the name of the Log Reader Agent. You can obtain this value from the LogReaderAgentName property of the published database.
  • sessionId
    A String value that represents the data and time of the session for which details are returned. This value can be obtained from the time column returned by the EnumLogReaderAgentSessions method.

返回值

A DataSet object that contains the following columns.

Column

Data type

Description

runstatus

Int32

The running status:

1 = Start

2 = Succeed

3 = In progress

4 = Idle

5 = Retry

6 = Fail

time

String

Time of logging for session detail.

comments

String

Descriptive text.

duration

Int32

Elapsed time of the logged session activity, in seconds.

delivery_rate

Single

Average number of commands delivered per second.

delivery_latency

Int32

The time, in milliseconds, between a command being committed to the published database and being committed to the distribution database.

delivery_time

Int32

Time the first transaction is delivered.

delivered_transactions

Int32

Total number of transactions delivered in the session.

delivered_commands

Int32

Total number of commands delivered in the session.

average_commands

Int32

Average number of commands per transaction delivered in the session.

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.

备注

You should commit any property changes to the PublisherMonitor object before calling this method because properties of this object may need to be loaded if they have not been loaded already.

The EnumLogReaderAgentSessionDetails 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.

线程安全

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.

平台

开发平台

有关支持的平台列表,请参阅安装 SQL Server 2005 的硬件和软件要求。

目标平台

有关支持的平台列表,请参阅安装 SQL Server 2005 的硬件和软件要求。

请参阅

参考

PublisherMonitor Class
PublisherMonitor Members
Microsoft.SqlServer.Replication Namespace

其他资源

How to: Programmatically Monitor Replication (RMO Programming)