Freigeben über


PublisherMonitor.EnumDistributionAgentSessionDetails-Methode

Returns detailed information about a Distribution Agent session.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

Syntax

'Declaration
Public Function EnumDistributionAgentSessionDetails ( _
    agentName As String, _
    sessionId As String _
) As DataSet
'Usage
Dim instance As PublisherMonitor 
Dim agentName As String 
Dim sessionId As String 
Dim returnValue As DataSet 

returnValue = instance.EnumDistributionAgentSessionDetails(agentName, _
    sessionId)
public DataSet EnumDistributionAgentSessionDetails(
    string agentName,
    string sessionId
)
public:
DataSet^ EnumDistributionAgentSessionDetails(
    String^ agentName, 
    String^ sessionId
)
member EnumDistributionAgentSessionDetails : 
        agentName:string * 
        sessionId:string -> DataSet
public function EnumDistributionAgentSessionDetails(
    agentName : String, 
    sessionId : String
) : DataSet

Parameter

  • agentName
    Typ: System.String
    A String value that specifies the name of the Distribution Agent.

Rückgabewert

Typ: System.Data.DataSet
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

DateTime

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

Latency, in milliseconds, between the transaction entering the distribution database and being applied to the Subscriber.

(No column name)

Not applicable

Internal use only.

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.

Hinweise

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

Siehe auch

Verweis

PublisherMonitor Klasse

Microsoft.SqlServer.Replication-Namespace

Andere Ressourcen

Programmgesteuertes Überwachen der Replikation (RMO-Programmierung)