PublicationMonitor.EnumSnapshotAgent Method
Returns information for the Snapshot Agent job used by the monitored publication.
Namespace: Microsoft.SqlServer.Replication
Assembly: Microsoft.SqlServer.Rmo (in Microsoft.SqlServer.Rmo.dll)
Syntax
'Declaration
Public Function EnumSnapshotAgent As DataSet
'Usage
Dim instance As PublicationMonitor
Dim returnValue As DataSet
returnValue = instance.EnumSnapshotAgent()
public DataSet EnumSnapshotAgent()
public:
DataSet^ EnumSnapshotAgent()
member EnumSnapshotAgent : unit -> DataSet
public function EnumSnapshotAgent() : DataSet
Return Value
Type: System.Data.DataSet
A DataSet object that contains the following columns.
Column |
Data type |
Description |
|---|---|---|
name |
Replication Agent job name. |
|
status |
The running status: 1 = Start 2 = Succeed 3 = In progress 4 = Idle 5 = Retry 6 = Fail |
|
publisher |
Publisher name. |
|
publisher_db |
Name of the database published. |
|
publication |
Publication name. |
|
start_time |
Date and time of last agent execution. |
|
time |
Date and time that the session was logged. |
|
duration |
Elapsed time of the session, in seconds. |
|
comments |
Message text logged by the agent. |
|
delivered_transactions |
Total number of transactions delivered in the session. |
|
delivered_commands |
Total number of commands delivered in the session. |
|
delivery_rate |
Average number of commands delivered per second. |
|
error_id |
The ID of the error in the MSrepl_errors (Transact-SQL) system table. Use the EnumErrorRecords method to return detailed information about an error. |
|
job_id |
Byte[16] |
Identifier of the SQL Server Agent job starting the Replication Agent. |
local_job |
When true, the agent job is available at the Distributor. |
|
profile_id |
Profile identifier. |
|
agent_id |
Agent job identifier. |
|
local_timestamp |
Byte[8] |
Timestamp of the most recent agent run. |
dynamic_filter_login |
The value used for evaluating the SUSER_SNAME (Transact-SQL) function in parameterized filters that define a partition. |
|
dynamic_filter_hostname |
The value used for evaluating the HOST_NAME (Transact-SQL) function in parameterized filters that define a partition. |
Remarks
The EnumSnapshotAgent method can only be called by members of the db_owner or replmonitor fixed database roles on the distribution database.
See Also
Reference
Microsoft.SqlServer.Replication Namespace