Microsoft.SqlServer.Replication Namespace

This assembly provides managed access to replication agent functionalities.

Classes

AgentApplication
AgentCore
AgentJobHistoryInfo

Returns information about the results of the last run of a replication agent.

AgentProfile

Encapsulates all operations on replication agent profiles, such as creating, deleting, adding, and removing parameters, and assigning specific profiles to certain agents.

AgentProfileParameter

Represents parameters in a replication agent profile.

AgentProfileParameterInfo

Represents a supported parameter used in replication agent profiles.

AlternateSynchronizationPartner

Represents an alternate Publisher to which a subscription can be synchronized if the primary Publisher is not available.

Article

Represents the base class from which the TransArticle class and MergeArticle class are derived.

ArticleConflict

Represents information about a merge replication conflict table.

BusinessLogicHandler

Represents the server registration for the managed code assembly that implements a business logic handler.

ComErrorException

The exception that is thrown when a general error is raised by a replication agent.

ComErrorRecord

Represents information for an error generated by a replication agent.

ConnectionFailureException

The exception that is thrown when a database connection fails when a replication agent is running.

ConnectionSecurityContext

Represents information you use when you connect to Microsoft SQL Server.

CustomResolver

Represents a COM-based resolver registration at a server in a merge replication topology.

DistributionArticle

Represents information about an article published in a transactional or snapshot publication stored at the Distributor.

DistributionArticleCollection

Represents a collection of DistributionArticle objects.

DistributionDatabase

Represents a distribution database at the Distributor.

DistributionDatabaseCollection

Represents a collection of DistributionDatabase objects.

DistributionPublication

Represents information about a transactional or snapshot publication stored at the Distributor.

DistributionPublicationCollection

Represents a collection of DistributionPublication objects.

DistributionPublisher

Represents information about a Publisher registered at the currently connected Distributor.

DistributionPublisherCollection

Represents a collection of DistributionPublisher objects.

DistributionSubscription

Represents information stored at the Distributor about a subscription to a transactional or snapshot publication.

DistributionSubscriptionCollection

Represents a collection of DistributionSubscription objects.

FciException

The exception that is thrown when an error occurs in the File Compression Interface (FCI).

HeterogeneousColumn

Represents a column contained in a table on a non-Microsoft SQL Server Publisher.

HeterogeneousTable

Represents a table on a non-Microsoft SQL Server Publisher.

IdentityRangeInfo

Structure that represents identity range management settings for a published article when the source table contains identity columns.

LastValidationDateTime

Used to return the date and time of the last merge subscription validation.

LightPublication

Represents a light publication.

MergeArticle

Represents an article in a merge publication.

MergeArticleCollection

Represents a collection of MergeArticle objects.

MergeConflictCount

Represents conflict information for a table article in a merge publication.

MergeDynamicSnapshotJob

Contains information about the Snapshot Agent job that generates the data snapshot for a subscription to a merge publication with a parameterized row filter.

MergeJoinFilter

Represents a join filter or logical record relationship between to merge articles.

MergePartition

Represents information about a Subscriber's partition for a merge publication with a parameterized row filter.

MergePublication

Represents a merge publication.

MergePublicationCollection

Represents a collection of MergePublication objects.

MergePullSubscription

Represents a pull subscription to a merge publication.

MergePullSubscriptionCollection

Represents a collection of MergePullSubscription objects.

MergeSessionDetail

Represents detailed information about a step in a Merge Agent session.

MergeSessionError

Represents information on errors that occur during a Merge Agent session.

MergeSessionSummary

Represents Merge Agent session information.

MergeSubscriberMonitor

Enables Subscriber-side monitoring of subscriptions to merge publications.

MergeSubscription

Represents a subscription to a merge publication registered at the Publisher.

MergeSubscriptionCollection

Represents a collection of MergeSubscription objects.

MergeSynchronizationAgent

Provides the functionality of the Replication Merge Agent.

MonitorThreshold

Represents a threshold metric used when monitoring a publication.

NativeSqlConnectionException

The exception that is thrown when an error is raised by an ODBC driver or an OLEDB provider during bulk copy operations.

OciException

The exception that is thrown when an error is raised by the Oracle Call Interface (OCI).

OSException

The exception that is thrown when an error is raised by the operating system during a File Compression Interface (FCI) operation.

ParameterValueOutOfRangeException

The exception that is thrown if a value passed to a parameter is out of range for the data type of the parameter.

PasswordWriteOnlyException

The exception that is thrown when a replication agent password property is accessed.

PendingCommandInfo

Represents information on the number of pending commands for a subscription to a transactional publication and a rough estimate of how much time it takes to process them.

Publication

The Publication class is a base class from which the TransPublication class and the MergePublication class are derived.

PublicationAccess

Represents login information in the publication access list (PAL) for a publication.

PublicationArticle

Represents article information for a published database object.

PublicationMonitor

Monitors a publication.

PublicationMonitorCollection

A collection of PublicationMonitor objects that represents publications at the Distributor.

PublisherConnectionSecurityContext

Represents the login used when connecting to the instance of Microsoft SQL Server that is configured as a Publisher in a replication topology.

PublisherMonitor

Monitors a replication Publisher.

PublisherMonitorCollection

Represents a collection of PublisherMonitor objects.

PullSubscription

Represents information at the Publisher for a subscription to a merge or a transactional publication when the Synchronization Agent runs at the Subscriber. PullSubscription is a base class from which the TransPullSubscription class and the MergePullSubscription class are derived.

RegisteredSubscriber

Represents a Subscriber that has been registered at a Publisher or a Distributor.

RegisteredSubscriberCollection

Represents a collection of RegisteredSubscriber objects.

ReplicationAgentContainerException

The exception that is thrown when one or more errors are generated by a managed code-based replication agent.

ReplicationAgentContainerWithWatsonException

Represents the exception that is thrown when one or more errors are generated by a managed code-based replication agent using Watson.

ReplicationAgentException

The base exception class for exceptions generated during replication agent execution.

ReplicationAgentSchedule

Represents the schedule for a replication agent job.

ReplicationBaseCollection

The base class that is used in the construction of replication object collections. It contains functionality that is common to the replication object collections.

ReplicationColumn

Represents a column object in a table that contains information needed by replication.

ReplicationDatabase

Represents a publication or subscription database in a replication topology.

ReplicationDatabaseCollection

Represents a collection of ReplicationDatabase objects.

ReplicationMonitor

Monitors a replication server.

ReplicationObject

Abstract class that is the base class for all classes in the Replication Management Objects (RMO) programming interface.

ReplicationSchemaBoundView

Represents a schema-bound view and contains information needed by replication.

ReplicationServer

Represents an instance of Microsoft SQL Server that is involved in replication. It can take the role of Distributor, Publisher, Subscriber, or any combination of them.

ReplicationStatusAndWarning

Represents replication agent status information and threshold monitor warnings.

ReplicationStoredProcedure

Represents information on a stored procedure object that is required by replication.

ReplicationTable

Represents information on a table object that is required by replication.

ReplicationUserDefinedAggregate

Represents a user-defined aggregate function and contains information needed by replication.

ReplicationUserDefinedFunction

Represents a user-defined function and contains information needed by replication.

ReplicationView

Represents information on a view object that is required by replication.

ResourceStrings
SnapshotGenerationAgent
StatusEventArgs

Represents status information returned by a replication agent when the Status event occurs.

SubscriberSubscription

Returns information about a subscription.

Subscription

Represents information at the Publisher for a subscription to either a merge or a transactional publication. Subscription is a base class from which the TransSubscription class and the MergeSubscription class are derived.

SubscriptionBackupInformation

Represents information required to initialize a subscription from a backup.

SynchronizationPartner

Represents an alternate Publisher used to synchronize a subscription to a merge publication.

TracerToken

Represents tracer token information.

TransArticle

Represents an article in a transactional publication.

TransArticleCollection

Represents a collection of TransArticle objects.

TransConflictCount

Represents returned conflict information for a table article in a publication that supports queued updating subscriptions.

TransPublication

Represents a transactional publication.

TransPublicationCollection

Represents a collection of TransPublication objects.

TransPullSubscription

Represents a pull subscription to a transactional publication.

TransPullSubscriptionCollection

Represents a collection of TransPullSubscription objects.

TransSubscription

Represents a push subscription to a transactional or snapshot publication.

TransSubscriptionCollection

Represents a collection of TransSubscription objects.

TransSynchronizationAgent

Provides the functionality of the Replication Distribution Agent.

Interfaces

IAlternateSynchronizationPartner
IComErrorRecord
IComStatusEvent
IConnectionSecurityContext

Provides an implementation of the ConnectionSecurityContext class for late-bound COM clients. For information on the members of this interface, see the reference documentation for ConnectionSecurityContext.

IMergeSynchronizationAgent
IProcessSecurityContext

Interface that encapsulates the Microsoft Windows security account information used by Microsoft SQL Server Agent to start a replication agent job.

IReplicationDBObject

Represents replication DB object.

ISnapshotGenerationAgent
IStatusEventData
ITransSynchronizationAgent

Enums

AbortPolicy

Enumerates the options for how running replication agent threads are terminated when an unanticipated shutdown occurs.

AddColumnOption

Enumerates the options for adding a column to a table published in an existing publication.

AgentProfileTypeOption

Indicates whether a replication agent profile is system-defined or user-defined.

AgentType

Enumerates the various types of replication agents.

ArticleDatatypeMappingOptions

Specifies whether the data type mapping between two database management systems (DBMS) for an article has been defined by a user or is the default mapping.

ArticleOptions

Enumerates the type of database objects that can be published by replication.

AuthenticationMethod

Enumerates values that specify the supported HTTP authentication methods for Web synchronization.

AutomaticReinitializationPolicies

Enumerates default behaviors when reinitializing subscriptions to a merge publication.

CheckPermissionOptions

Enumerates the table-level permissions that are verified when the Merge Agent applies changes at the Publisher.

CommandOptions

Enumerates options that control how changes are propagated for transactional articles.

ConflictPolicyOption

Enumerates options for selecting the winning row when conflicts occur during synchronization of an updating subscription to a transactional publication.

CreationScriptOptions

Enumerates schema option values for published articles.

DatabaseCompatibilityLevel

Enumerates the versions of Microsoft SQL Server that are supported for database compatibility with Microsoft SQL Server 2005.

DataSourceType

Enumerates the data sources supported as replication Subscribers.

DdlReplicationOptions

Enumerates whether data definition language (DDL) changes to published tables are replicated.

DeadlockPriority

Enumerates the priorities used to resolve deadlocks that occur during snapshot generation.

DtsPackageLocationOption

Enumerates options for the location of the Data Transformation Services (DTS) package.

FailoverMode

Enumerates the options available for an updating Subscriber to propagate changes back to the Publisher.

FileTransferOption

Enumerates the options for obtaining snapshot files.

FilterTypes

Enumerates values that specify the type of filters used in merge articles.

IdentityRangeManagementOption

Enumerates options for managing identity column range assignments in tables published using merge replication and transactional replication with updating Subscribers.

InitialSyncType

Enumerates the data file formats supported for the initial snapshot.

MergeArticleState

Enumerates the supported status settings for a merge article.

MergeExchangeType

Enumerates options for how the Merge Agent synchronizes data.

MergeSessionDetailType

Enumerates parts of a Merge Agent session being monitored.

MergeSessionPhase

Enumerates the phase of a Merge Agent session.

MergeSessionStatus

Enumerates the status of a Merge Agent session.

MergeSubscriberType

Enumeration additional types of subscriptions supported by merge replication.

MessageStatus

Enumerates replication agent status codes.

MonitorCacheRefreshPolicy

Specifies a monitor cache refresh policy.

NetworkType

Enumerates the supported Net-Libraries used by a replication agent when connecting to a replication server.

PartitionGroupsOption

Enumerates values that determine whether a merge publication uses precomputed partitions.

PartitionOptions

Enumerates the ways in which data in an article is partitioned amongst subscriptions when the merge publication uses a parameterized row filter.

PreCreationOption

Enumerates the commands that are executed prior to subscription initialization when a published table already exists in the subscription database.

PublicationAttributes

Enumerates supported publication properties.

PublicationCompatibilityLevel

Enumerates product version values that are used by merge replication to determine which features can be used by publications in a given database.

PublicationType

Enumerates the supported types of replication used to publish a database.

QueueOption

Enumerates the type of queuing available to a transactional publication with updating Subscribers.

ReplicationSecurityMode

Specifies the supported security modes used by updating Subscribers when connecting to the Publisher.

ReplicationStatus

Specifies the status of a replication agent job.

ReplicationType

Enumerates the type of publication for which a snapshot is generated.

ReplicationWarnings

Enumerates the supported replication threshold monitor warning values.

ResynchronizeType

Enumerates values that specify the changes to apply when a merge subscription is resynchronized.

RetentionPeriodUnits

Enumerates values that specify the units for the retention period.

ScheduleConstant

Enumerates constant values used to set replication schedules.

ScheduleFrequencySubDay

Enumerates values that specify a smaller scheduling unit for specific schedule frequencies.

ScheduleFrequencyType

Enumerates the types of frequencies used when scheduling a replication agent job.

ScheduleRelativeIntervals

Enumerates values that represent the frequency of a replication agent schedule relative to the ScheduleFrequencyType.

ScriptOptions

Enumerates options for generating scripts that are used to create or remove replication objects.

SecurityMode

Enumerates the type of authentication to use when a replication agent connects to a server in a replication topology.

State

Enumerates the values that represent the status of a publication.

SubscriberType

Enumerates the types of data sources that can be a Subscriber to a publication.

SubscriberUploadOptions

Enumerates merge article options for updates made at a Subscriber with a client subscription.

SubscriptionBackupDeviceType

Enumerates backup devices that can be used to initialize a subscription.

SubscriptionOption

Enumerates the type of subscription.

SubscriptionResultOption

Enumerates options for returning monitored subscriptions.

SubscriptionState

Enumerates options for the status of a subscription.

SubscriptionSyncType

Enumerates options for how the initial synchronization is performed for a subscription.

TransSubscriberType

Enumerates the updating behaviors for subscriptions to transactional publications.

ValidateType

Enumerates the types of validation that are performed during synchronization.

ValidationMethod

Enumerates methods supported for rowcount validation of transactional publications.

ValidationOption

Enumerates the types of data validation supported by replication.

VerifyResolverSignatureOption

Enumerates values that specify whether the Merge Agent must verify the digital signature on a Component Object Model (COM)-based conflict resolver to determine if it is from a trusted source.

Delegates

AgentCore.StatusEventHandler

Remarks

The MergeSynchronizationAgent, TransSynchronizationAgent, and SnapshotGenerationAgent classes represent the functionality of the Merge Agent, Distribution Agent, and Snapshot Agent respectively. Use these classes to synchronously start these replication agents from a managed code application. For more information, see Replication Programming Concepts.