EnumLogReaderAgentView Method
This feature will be removed in a future version of Microsoft SQL Server. Avoid using this feature in new development work, and plan to modify applications that currently use this feature.
The EnumLogReaderAgentView method returns a QueryResults object that enumerates execution state for Log Reader Agents used by the referenced distribution publication.
Syntax
object
.EnumLogReaderAgentView( )
as
QueryResults
Parts
- object
Expression that evaluates to an object in the Applies To list.
Prototype (C/C++)
HRESULT EnumLogReaderAgentView(
LPSQLDMOQUERYRESULTS* ppResults);
Returns
A QueryResults object that contains one result set defined by these columns.
Column |
Data type |
Description |
|---|---|---|
agent_id |
integer |
Agent identifier. |
average_commands |
integer |
Average number of commands. |
comments |
nvarchar(256) |
Descriptive text. |
dbname |
nvarchar(129) |
Distribution database name. |
delivered_commands |
integer |
Cumulative number of commands. |
delivered_/transactions |
integer |
Cumulative number of transactions. |
delivery_latency |
integer |
Latency, in milliseconds, between the Publisher committing a transaction and that transaction entering the distribution database. |
delivery_rate |
integer |
Average number of commands per transaction delivered per second. |
delivery_time |
integer |
Cumulative time spent delivering transactions in seconds. |
duration |
integer |
Elapsed time of the logged session activity in seconds. |
error_id |
integer |
When nonzero, the Microsoft SQL Server error message number of the most recent error. |
job_id |
binary(22) |
Identifier of the SQL Server Agent job starting the replication agent. |
last_timestamp |
binary(14) |
Timestamp. |
local_job |
bit |
When TRUE, the SQL Server Agent job executes at the Distributor. When FALSE, the SQL Server Agent job executes at the Subscriber. |
name |
nvarchar(101) |
Replication agent name. |
profile_id |
integer |
Profile identifier. |
publisher |
nvarchar(129) |
Publisher name. |
publisher_db |
nvarchar(129) |
Name of published database. |
start_time |
nvarchar(25) |
Date and time at which agent session started. |
status |
integer |
Agent status. Interpret using SQLDMO_TASKSTATUS_TYPE. |
time |
nvarchar(25) |
Date and time of last message log. |
Remarks
In the result set, date and time data returned in start_time and timeis formatted as YYYYMMDD hh:mm:ss.fff.
Date part |
Description |
|---|---|
YYYY |
Represents the year in four digits. |
MM |
Represents the month in two digits (zero padded). |
DD |
Represents the day of the month in two digits (zero padded). |
hh |
Represents the hour using two digits, a twenty-four hour clock (zero padded). |
mm |
Represents the minute in two digits (zero padded). |
ss |
Represents the second in two digits (zero padded). |
fff |
Represents the fractional part of the second in three digits. |
For example, the value 20040512 18:12:00.000 is interpreted as 6:12 P.M., May 12, 2004.