PublisherMonitor.EnumMergeAgentSessionDetails2 Method
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
'Usage
Dim instance As PublisherMonitor
Dim sessionId As Integer
Dim returnValue As DataSet
returnValue = instance.EnumMergeAgentSessionDetails2(sessionId)
public DataSet EnumMergeAgentSessionDetails2(
int sessionId
)
public:
DataSet^ EnumMergeAgentSessionDetails2(
int sessionId
)
member EnumMergeAgentSessionDetails2 :
sessionId:int -> DataSet
public function EnumMergeAgentSessionDetails2(
sessionId : int
) : DataSet
Parameters
- sessionId
Type: System.Int32
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
Type: System.Data.DataSet
A DataSet object that contains the following columns.
Column |
Data type |
Description |
---|---|---|
PhaseID |
Is the phase of the synchronization session, which can be one of the following: 0 = Initialization or summary row 1 = Upload 2 = Download |
|
ArticleName |
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 |
Indicates the percentage of the total changes applied in a given article detail row for currently running or failed sessions. |
|
RelativeCost |
Indicates the percentage of the total changes applied in a given article detail row for currently running or failed sessions. |
|
Duration |
Length of the agent session. |
|
Inserts |
Number of inserts in a session. |
|
Updates |
Number of updates in a session. |
|
Deletes |
Number of deletes in a session. |
|
Conflicts |
Number of conflicts that occurred in a session. |
|
ErrorID |
ID of a session error. |
|
SeqNo |
Order of sessions in the result set. |
|
RowType |
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 |
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.