PublisherMonitor.EnumMergeAgentSessionDetails Method
Returns detailed information about a Merge Agent session.
Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)
Syntax
'Declaration
Public Function EnumMergeAgentSessionDetails ( _
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.EnumMergeAgentSessionDetails(agentName, _
sessionId)
public DataSet EnumMergeAgentSessionDetails(
string agentName,
string sessionId
)
public:
DataSet^ EnumMergeAgentSessionDetails(
String^ agentName,
String^ sessionId
)
member EnumMergeAgentSessionDetails :
agentName:string *
sessionId:string -> DataSet
public function EnumMergeAgentSessionDetails(
agentName : String,
sessionId : String
) : DataSet
Parameters
- agentName
Type: System.String
A String value that specifies the name of the Merge Agent. You can obtain this value from the SynchronizationAgentName property of the merge subscription.
- sessionId
Type: System.String
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 EnumMergeAgentSessions method.
Return Value
Type: System.Data.DataSet
A DataSet object that contains the following columns.
Column |
Data type |
Description |
---|---|---|
runstatus |
The running status: 1 = Start 2 = Succeed 3 = In progress 4 = Idle 5 = Retry 6 = Fail |
|
time |
Time that the session completed. |
|
comments |
Descriptive text. |
|
duration |
Elapsed time of the logged session activity, in seconds. |
|
delivery_rate |
Average number of rows delivered per second. |
|
download_inserts |
The number of inserts applied at the Subscriber. |
|
download_updates |
The number of updates applied at the Subscriber. |
|
download_deletes |
The number of deletes applied at the Subscriber. |
|
download_conflicts |
The number of conflicts that occurred while applying changes at the Subscriber. |
|
upload_inserts |
The number of inserts applied at the Publisher. |
|
upload_updates |
The number of updates applied at the Publisher. |
|
upload_deletes |
The number of deletes applied at the Publisher. |
|
upload_conflicts |
The number of conflicts that occurred while applying changes at the Publisher. |
|
error_id |
The ID of the error in the MSrepl_errors (Transact-SQL) system table. Use the EnumErrorRecords method to return detailed information about an error. |
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 EnumMergeAgentSessionDetails 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.