PublisherMonitor.EnumMergeAgentSessionDetails(String, String) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Returns detailed information about a Merge Agent session.
public:
System::Data::DataSet ^ EnumMergeAgentSessionDetails(System::String ^ agentName, System::String ^ sessionId);
public System.Data.DataSet EnumMergeAgentSessionDetails (string agentName, string sessionId);
member this.EnumMergeAgentSessionDetails : string * string -> System.Data.DataSet
Public Function EnumMergeAgentSessionDetails (agentName As String, sessionId As String) As DataSet
Parameters
- agentName
- 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
- 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(String, Int32, Boolean) method.
Returns
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 that the session completed. |
comments | String | Descriptive text. |
duration | Int32 | Elapsed time of the logged session activity, in seconds. |
delivery_rate | Single | Average number of rows delivered per second. |
download_inserts | Int32 | The number of inserts applied at the Subscriber. |
download_updates | Int32 | The number of updates applied at the Subscriber. |
download_deletes | Int32 | The number of deletes applied at the Subscriber. |
download_conflicts | Int32 | The number of conflicts that occurred while applying changes at the Subscriber. |
upload_inserts | Int32 | The number of inserts applied at the Publisher. |
upload_updates | Int32 | The number of updates applied at the Publisher. |
upload_deletes | Int32 | The number of deletes applied at the Publisher. |
upload_conflicts | Int32 | The number of conflicts that occurred while applying changes at the Publisher. |
error_id | Int32 | The ID of the error in the [MSrepl_errors (Transact-SQL)](http://msdn.microsoft.com/library/c6e023c1-2c32-4269-8d76-e442ea309e4b) system table. Use the EnumErrorRecords(Int32) 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.