RelationalSyncProvider Class

Abstracts a generic synchronization provider that communicates with a database and shields the synchronization agent from the specific implementation of the database.

This API is not CLS-compliant. 

Namespace:  Microsoft.Synchronization.Data
Assembly:  Microsoft.Synchronization.Data (in Microsoft.Synchronization.Data.dll)

[CLSCompliantAttribute(false)]
public abstract class RelationalSyncProvider : KnowledgeSyncProvider, 
	IDisposable

The RelationalSyncProvider type exposes the following members.

  NameDescription
Protected methodRelationalSyncProviderInitializes a new instance of the RelationalSyncProvider class.
Top

  NameDescription
Public propertyBatchingDirectoryGets or sets the directory in which batch files are spooled to disk.
Public propertyCleanupBatchingDirectoryGets or sets whether to clean up batching files after the changes in the files have been applied to the destination.
Public propertyConfigurationNot implemented by RelationalSyncProvider. An exception of type NotSupportedException is thrown if you attempt to access this property.
Public propertyConnectionGets or sets an IDbConnection object that is used to connect to the database.
Public propertyDestinationCallbacksGets an object that a synchronization application can use to register to receive notification of events that occur during synchronization. (Inherited from KnowledgeSyncProvider.)
Public propertyIdFormatsGets a SyncIdFormatGroup object that is used to identify entities in a synchronization session. (Overrides KnowledgeSyncProvider.IdFormats.)
Public propertyMemoryDataCacheSizeGets or sets the maximum amount of memory (in KB) that Sync Framework uses to cache changes before spooling those changes to disk.
Public propertyScopeNameGets or sets the name of the scope to synchronize.
Public propertySyncProviderPositionGets or sets a SyncProviderPosition enumeration value that represents whether a provider is associated with the local or remote database.
Top

  NameDescription
Public methodBeginSessionCalled by the SyncOrchestrator to indicate that a synchronization session has started. (Overrides KnowledgeSyncProvider.BeginSession(SyncProviderPosition, SyncSessionContext).)
Protected methodCreateApplicationTransactionCreates a read-committed transaction over which to apply changes to the database.
Protected methodCreateEnumerationTransactionCreates a read-committed transaction over which to enumerate changes from the database.
Public methodDispose()Releases all resources that are used by the RelationalSyncProvider.
Protected methodDispose(Boolean)Releases the unmanaged resources used by the RelationalSyncProvider and optionally releases the managed resources.
Public methodEndSessionCalled by the SyncOrchestrator object to indicate that a synchronization session has ended. (Overrides KnowledgeSyncProvider.EndSession(SyncSessionContext).)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetChangeBatchGets a batch of changes to synchronize when given batch size, destination knowledge, and change data retriever parameters. (Overrides KnowledgeSyncProvider.GetChangeBatch(UInt32, SyncKnowledge, Object).)
Public methodGetFullEnumerationChangeBatchGets a batch of changes to synchronize when given batch size, lower bound, knowledge, and change data retriever parameters. (Overrides KnowledgeSyncProvider.GetFullEnumerationChangeBatch(UInt32, SyncId, SyncKnowledge, Object).)
Public methodGetHashCode (Inherited from Object.)
Public methodGetSyncBatchParametersGets the number of kilobytes of data that will be included in change batches, and the current knowledge for the synchronization scope. (Overrides KnowledgeSyncProvider.GetSyncBatchParameters(UInt32, SyncKnowledge).)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnApplyChangeFailedRaises the ApplyMetadataFailed event.
Protected methodOnApplyingChangesRaises the ApplyingChanges event.
Protected methodOnApplyMetadataFailedRaises the ApplyMetadataFailed event.
Protected methodOnChangesAppliedRaises the ChangesApplied event.
Protected methodOnChangesSelectedRaises the ChangesSelected event.
Protected methodOnDbConnectionFailureRaises the DbConnectionFailure event.
Protected methodOnPeerOutdatedRaises the SyncPeerOutdated event.
Protected methodOnSelectingChangesRaises the SelectingChanges event.
Protected methodOnSyncProgressRaises the SyncProgress event.
Public methodProcessChangeBatchProcesses a batch of changes when given resolution policy, source changes, change data retriever, callback, and statistics parameters. (Overrides KnowledgeSyncProvider.ProcessChangeBatch(ConflictResolutionPolicy, ChangeBatch, Object, SyncCallbacks, SyncSessionStatistics).)
Public methodProcessFullEnumerationChangeBatchProcesses a batch of changes when given resolution policy, source changes, change data retriever, callback, and statistics parameters. (Overrides KnowledgeSyncProvider.ProcessFullEnumerationChangeBatch(ConflictResolutionPolicy, FullEnumerationChangeBatch, Object, SyncCallbacks, SyncSessionStatistics).)
Public methodToString (Inherited from Object.)
Top

  NameDescription
Public eventApplyChangeFailedOccurs during uploading, after failing to apply a row at a node.
Public eventApplyingChangesOccurs during uploading, after connecting to the database but before applying changes.
Public eventApplyMetadataFailedOccurs during uploading, after failing to apply metadata for a row.
Public eventBatchAppliedOccurs after each batch of changes has been applied to the destination.
Public eventBatchSpooledOccurs after each batch of changes has been written to disk.
Public eventChangesAppliedOccurs during uploading, after applying changes but before disconnecting from the database.
Public eventChangesSelectedOccurs during downloading, after enumerating changes but before disconnecting from the database.
Public eventDbConnectionFailureOccurs when the database connection fails during change application.
Public eventSelectingChangesOccurs during downloading, after connecting to the database but before selecting changes.
Public eventSyncPeerOutdatedOccurs before enumeration of changes if the destination node is outdated.
Public eventSyncProgressOccurs during the selection of changes (per table) and the application of changes (per row).
Top

In most cases, applications will use one of the classes that inherits from this class: SqlSyncProvider, SqlCeSyncProvider, or DbSyncProvider.

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