ReplicationMonitor.EnumQueueReaderAgentSessionDetails 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 Queue Reader Agent session.
public:
System::Data::DataSet ^ EnumQueueReaderAgentSessionDetails(System::String ^ distributionDatabase, int publicationId, System::String ^ sessionId);
public System.Data.DataSet EnumQueueReaderAgentSessionDetails (string distributionDatabase, int publicationId, string sessionId);
member this.EnumQueueReaderAgentSessionDetails : string * int * string -> System.Data.DataSet
Public Function EnumQueueReaderAgentSessionDetails (distributionDatabase As String, publicationId As Integer, sessionId As String) As DataSet
Parameters
- publicationId
- Int32
An Int32 value specifying the ID value that uniquely identifies the publication.
- sessionId
- String
A String value specifying the ID value that uniquely identifies the session. The sessionID
contains the date and time, converted from a System.DataTime system object value, when the session actually occurred.
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 | String | Time of logging for session detail. |
comments | String | Descriptive text. |
transaction_id | String | The transaction ID stored with the message, if applicable. |
transaction_status | Int32 | The status of the transaction. |
commands_processed | Int32 | The total number of commands processed in the session. |
subscriber | String | The name of the Subscriber. |
subscriberdb | String | The name of the subscription database. |
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 ReplicationMonitor object before calling this method because properties of this object may need to be loaded if they have not been loaded already.
The EnumQueueReaderAgentSessionDetails method can only be called by members of the db_owner
or replmonitor
fixed database roles on the distribution database.