PublisherMonitor.EnumDistributionAgentSessions(String, Int32, Boolean) PublisherMonitor.EnumDistributionAgentSessions(String, Int32, Boolean) PublisherMonitor.EnumDistributionAgentSessions(String, Int32, Boolean) Method

정의

배포 에이전트 세션에 대한 정보를 반환합니다. Returns information about Distribution Agent sessions.

public:
 System::Data::DataSet ^ EnumDistributionAgentSessions(System::String ^ agentName, int sessionDuration, bool returnOnlyErrorSessions);
public System.Data.DataSet EnumDistributionAgentSessions (string agentName, int sessionDuration, bool returnOnlyErrorSessions);
Public Function EnumDistributionAgentSessions (agentName As String, sessionDuration As Integer, returnOnlyErrorSessions As Boolean) As DataSet
매개 변수
agentName
String String String

배포 에이전트 작업의 이름을 지정하는 String 값입니다. A String value that specifies the name of the Distribution Agent job. SynchronizationAgentName 개체의 TransSubscription 속성을 사용하여 이 값을 가져올 수 있습니다. You can use the SynchronizationAgentName property of the TransSubscription object to obtain this value.

sessionDuration
Int32 Int32 Int32

결과를 제한할 현재 시간까지의 시간을 지정하는 Int32 값입니다. An Int32 value that specifies the number of hours before the current time to which to limit the results. 예를 들어 값이 24인 경우 최근 24시간 동안의 배포 에이전트 세션에 대한 정보가 반환됩니다. For example, a value of 24 will return information about Distribution Agent sessions over the last 24 hours. 값이 -1인 경우에는 최근 100개의 세션에 대한 정보가 반환되고 0인 경우에는 모든 세션에 대한 정보가 반환됩니다. A value of -1 returns information on the last 100 sessions, and a value of 0 returns information on all sessions.

returnOnlyErrorSessions
Boolean Boolean Boolean

오류가 발생한 세션에 대한 정보만 반환할지 모든 세션에 대한 정보를 반환할지를 지정하는 Boolean 값입니다. A Boolean value that specifies whether to return information only on sessions that resulted in an error or on all sessions. true이면 오류 세션만 반환되고, If true, only error sessions are returned. false이면 모든 세션이 반환됩니다. If false, all sessions are returned.

반환

다음과 같은 열이 포함된 DataSet 개체입니다. 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
start_time String Date and time of last agent execution.
time String Date and time that the session was logged.
comments String Message text logged by the agent.
duration Int32 Elapsed time of the session, in seconds.
delivery_rate Single Average number of commands delivered per second.
delivery_latency Int32 Latency, in milliseconds, between the transaction entering the distribution database and being applied to the Subscriber.
(No column name) Not applicable Internal use only.
delivered_transactions Int32 Total number of transactions delivered in the session.
delivered_commands Int32 Total number of commands delivered in the session.
average_commands Int32 Average number of commands per transaction delivered in the session.
action_count Int32 Number of agent log messages recorded in the session.
error_id Int32 The ID of the error in the MSrepl_errors (Transact-SQL) system table. 사용 하 여는 EnumErrorRecords(Int32) 메서드는 오류에 대 한 자세한 정보를 반환 합니다.
Column Data type Description
runstatus Int32 The running status: 1 = Start 2 = Succeed 3 = In progress 4 = Idle 5 = Retry 6 = Fail
start_time String Date and time of last agent execution.
time String Date and time that the session was logged.
comments String Message text logged by the agent.
duration Int32 Elapsed time of the session, in seconds.
delivery_rate Single Average number of commands delivered per second.
delivery_latency Int32 Latency, in milliseconds, between the transaction entering the distribution database and being applied to the Subscriber.
(No column name) Not applicable Internal use only.
delivered_transactions Int32 Total number of transactions delivered in the session.
delivered_commands Int32 Total number of commands delivered in the session.
average_commands Int32 Average number of commands per transaction delivered in the session.
action_count Int32 Number of agent log messages recorded in the session.
error_id Int32 The ID of the error in the MSrepl_errors (Transact-SQL) system table. Use the EnumErrorRecords(Int32) method to return detailed information about an error.

설명

모든 속성 변경 내용을 커밋 해야는 PublisherMonitor 이 개체의 속성은 되지 않은 경우 로드 이미 로드 되도록 할 수 있으므로이 메서드를 호출 하기 전에 개체입니다.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.

EnumDistributionAgentSessions 메서드의 구성원만 호출할 수는 db_owner 또는 replmonitor 배포 데이터베이스의 고정 데이터베이스 역할입니다.The EnumDistributionAgentSessions method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.

적용 대상

추가 정보