Share via

PublisherMonitor.EnumMergeAgentSessionDetails2 Method

  • Article

Returns additional detailed information about a Merge Agent session.

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

Syntax

'Declaration
Public Function EnumMergeAgentSessionDetails2 ( _
    sessionId As Integer _
) As DataSet

public DataSet EnumMergeAgentSessionDetails2 (
    int sessionId
)

public:
DataSet^ EnumMergeAgentSessionDetails2 (
    int sessionId
)

public DataSet EnumMergeAgentSessionDetails2 (
    int sessionId
)

public function EnumMergeAgentSessionDetails2 (
    sessionId : int
) : DataSet

Parameters

  • sessionId
    An Int32 value that represents ID of the session for which details are returned. This value can be obtained from the Session_id column returned by the EnumMergeAgentSessions2 method.

Return Value

A DataSet object that contains the following columns.

Column

Data type

Description

PhaseID

Int32

Is the phase of the synchronization session, which can be one of the following:

0 = Initialization or summary row

1 = Upload

2 = Download

ArticleName

String

Is the name of the article being synchronized. ArticleName also contains summary information for rows in the result set that do not represent article details.

PercentComplete

Decimal

Indicates the percentage of the total changes applied in a given article detail row for currently running or failed sessions.

RelativeCost

Decimal

Indicates the percentage of the total changes applied in a given article detail row for currently running or failed sessions.

Duration

Int32

Length of the agent session.

Inserts

Int32

Number of inserts in a session.

Updates

Int32

Number of updates in a session.

Deletes

Int32

Number of deletes in a session.

Conflicts

Int32

Number of conflicts that occurred in a session.

ErrorID

Int32

ID of a session error.

SeqNo

Int32

Order of sessions in the result set.

RowType

Int32

Indicates what type of information each row in the result set represents.

0 = Initialization

1 = Upload summary

2 = Article upload detail

3 = Download summary

4 = Article download detail

SchemaChanges

Int32

Number of schema changes in a session.

Remarks

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 EnumMergeAgentSessionDetails2 method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.

Calling EnumMergeAgentSessionDetails2 is equivalent to executing sp_replmonitorhelpmergesessiondetail.

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

PublisherMonitor Class
PublisherMonitor Members
Microsoft.SqlServer.Replication Namespace
PublisherMonitor.EnumMergeAgentSessionDetails Method
EnumMergeAgentSessions2

Other Resources

How to: Programmatically Monitor Replication (RMO Programming)