ReplicationMonitor.EnumDistributionAgents Method

Returns information on Distribution Agent jobs at the monitored Distributor.

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

Syntax

'Declaration
Public Function EnumDistributionAgents As DataSet

public DataSet EnumDistributionAgents ()

public:
DataSet^ EnumDistributionAgents ()

public DataSet EnumDistributionAgents ()

public function EnumDistributionAgents () : DataSet

Return Value

A DataSet object that contains the following columns.

Column

Data type

Description

db_name

String

Name of the distribution database.

name

String

Name of the replication agent job.

status

Int32

The running status:

1 = Start

2 = Succeed

3 = In progress

4 = Idle

5 = Retry

6 = Fail

publisher

String

Publisher name.

publisher_db

String

Name of the publication database.

publication

String

Publication name.

subscriber

String

Subscriber name.

subscriber_db

String

Name of the subscription database.

subscription_type

Int32

The type of subscription:

0 = Push

1 = Pull

2 = Anonymous

start_time

String

Date and time of the last agent execution.

time

String

Date and time that the session was logged.

duration

Int32

Elapsed time of the session, in seconds.

comments

String

Message text logged by the agent.

delivery_time

Int32

The time the first transaction is delivered.

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.

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.

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.

job_id

Byte[16]

Identifier of the SQL Server Agent job starting the replication agent.

local_job

Boolean

When true, the agent job is available at the Distributor.

profile_id

Int32

Profile identifier.

agent_id

Int32

Agent job identifier.

local_timestamp

Byte[8]

Timestamp of the most recent agent run.

offload_enabled

Boolean

If true, the subscription supports remote agent activation.

Note:

Remote agent activation has been discontinued. For more information, see Discontinued Functionality in SQL Server 2005 Replication.

offload_server

Boolean

Name of the server used with remote agent activation.

Note:

Remote agent activation has been discontinued. For more information, see Discontinued Functionality in SQL Server 2005 Replication.

subscriber_type

Byte

The data source type at the Subscriber:

0 = SQL Server Subscriber.

1 = Open Database Connectivity (ODBC) data source.

Remarks

The EnumDistributionAgents method can only be called by members of the db_owner or replmonitor fixed database roles on a distribution database at the Distributor.

The EnumDistributionAgents method is available with SQL Server 2000 and SQL Server 2005.

This namespace, class, or member is supported only in version 2.0 of the .NET Framework.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

See Also

Reference

ReplicationMonitor Class
ReplicationMonitor Members
Microsoft.SqlServer.Replication Namespace

Other Resources

How to: Programmatically Monitor Replication (RMO Programming)