PublisherMonitor.EnumDistributionAgentSessions(String, Int32, Boolean) Метод

Определение

Возвращает информацию о сеансах агента распространителя.

public:
 System::Data::DataSet ^ EnumDistributionAgentSessions(System::String ^ agentName, int sessionDuration, bool returnOnlyErrorSessions);
public System.Data.DataSet EnumDistributionAgentSessions (string agentName, int sessionDuration, bool returnOnlyErrorSessions);
member this.EnumDistributionAgentSessions : string * int * bool -> System.Data.DataSet
Public Function EnumDistributionAgentSessions (agentName As String, sessionDuration As Integer, returnOnlyErrorSessions As Boolean) As DataSet

Параметры

agentName
String

Значение String, указывающее имя задания агента распространителя. Для получения этого значения можно использовать свойство SynchronizationAgentName объекта TransSubscription.

sessionDuration
Int32

Значение типа Int32, указывающее число прошлых часов, которым ограничиваются результаты. Например, если задать значение 24, будут возвращены сведения о сеансах агента распространителя за последние 24 часа. Если задать значение -1, возвращаются сведения за последние 100 сеансов, а если задать значение 0, возвращаются сведения обо всех сеансах.

returnOnlyErrorSessions
Boolean

Значение типа Boolean, которое указывает, возвращаются ли данные только для сеансов, в которых произошла ошибка, или для всех сеансов. Если задано значение true, возвращаются только сеансы с ошибками. Если задано значение false, возвращаются все сеансы.

Возвращаемое значение

Объект DataSet, содержащий следующие столбцы.

Столбец Тип данных Описание
runstatusInt32 Состояние выполнения:

1 = выполнение начато;

2 = успешное выполнение;

3 = выполняется;

4 = бездействует;

5 = повтор;

6 = ошибка.

start_timeString Дата и время последнего выполнения агента.
timeString Дата и время регистрации сеанса.
commentsString Текст сообщения, зарегистрированный агентом.
длительностьInt32 Истекшее время сеанса, в секундах.
delivery_rateSingle Среднее число доставленных команд в секунду.
delivery_latencyInt32 Задержка (в миллисекундах) между вводом транзакции в базу данных распространителя и применением транзакции на подписчике.
(Нет имени столбца) Неприменимо Только для внутреннего использования.
delivered_transactionsInt32 Общее число транзакций, доставленных в течение сеанса.
delivered_commandsInt32 Общее число команд, доставленных за время сеанса.
average_commandsInt32 Среднее число команд на транзакцию, переданных за время сеанса.
action_countInt32 Число сообщений журнала агента, записанных в ходе сеанса.
error_idInt32 Идентификатор ошибки в системной таблице [MSrepl_errors (Transact-SQL)](http://msdn.microsoft.com/library/c6e023c1-2c32-4269-8d76-e442ea309e4b) Метод EnumErrorRecords(Int32) позволяет возвращать подробные сведения об ошибке.

Комментарии

Перед вызовом PublisherMonitor этого метода необходимо зафиксировать любые изменения свойств объекта, так как свойства этого объекта, возможно, потребуется загрузить, если они еще не загружены.

Метод EnumDistributionAgentSessions может вызываться только членами db_owner или replmonitor предопределенных ролей базы данных в базе данных распространителя.

Применяется к

См. также раздел