Export (0) Print
Expand All

PublisherMonitor.EnumSnapshotAgentSessions Method

Returns information about Snapshot Agent sessions.

Namespace:  Microsoft.SqlServer.Replication
Assembly:  Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)

public DataSet EnumSnapshotAgentSessions(
	string agentName,
	int sessionDuration,
	bool returnOnlyErrorSessions
)

Parameters

agentName
Type: String
A String value that specifies the name of the Log Reader Agent. You can obtain this value from the LogReaderAgentName property of the published database.
sessionDuration
Type: Int32
An Int32 value that specifies the number of hours before the current time to which to limit the results. For example, a value of 24 will return information about agent sessions over the last 24 hours. A value of -1 returns information on the last 100 sessions, and a value of 0 returns information on all sessions.
returnOnlyErrorSessions
Type: Boolean
A Boolean value that specifies whether to return information only on sessions that resulted in an error or on all sessions. If true, only error sessions are returned. If false, all sessions are returned.

Return Value

Type: 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 the 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.

delivered_commands

Int32

Total number of commands 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 method to return detailed information about an error.

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 EnumSnapshotAgentSessions method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft