Export (0) Print
Expand All

DbSyncProvider Class

Encapsulates a peer synchronization provider that communicates with a peer 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)

public class DbSyncProvider extends RelationalSyncProvider

The DbSyncProvider type exposes the following members.

  NameDescription
Public methodDbSyncProviderInitializes a new instance of the DbSyncProvider class.
Top

  NameDescription
Public propertyApplicationTransactionSizeGets or sets the maximum transaction size used during change application, in kilobytes.
Public propertyBatchingDirectoryGets or sets the directory in which batch files are spooled to disk. (Inherited from RelationalSyncProvider.)
Public propertyChangeTracking Obsolete. Gets or sets a ChangeTrackingModel enumeration value that specifies the type of change tracking that is used in all peer databases.
Public propertyCleanupBatchingDirectoryGets or sets whether to clean up batching files after the changes in the files have been applied to the destination. (Inherited from RelationalSyncProvider.)
Public propertyConfigurationNot implemented by RelationalSyncProvider. An exception of type NotSupportedException is thrown if you attempt to access this property. (Inherited from RelationalSyncProvider.)
Public propertyConnectionGets or sets an IDbConnection object that is used to connect to the database. (Inherited from RelationalSyncProvider.)
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. (Inherited from RelationalSyncProvider.)
Public propertyMemoryDataCacheSizeGets or sets the maximum amount of memory (in KB) that Sync Framework uses to cache changes before spooling those changes to disk. (Inherited from RelationalSyncProvider.)
Protected propertyScopeCleanupTimestampColNameGets or sets the name the column in the scope information table that contains the timestamp value when the most recent tombstone cleanup was performed for this scope.
Protected propertyScopeForgottenKnowledgeColNameGets or sets the name the column in the scope information table that contains a binary representation of the forgotten knowledge for each scope.
Protected propertyScopeIdColNameGets or sets the name the column in the scope information table that contains an identifier for the scope, typically a GUID.
Protected propertyScopeKnowledgeColNameGets or sets the name the column in the scope information table that contains a binary representation of the synchronization knowledge for each scope.
Protected propertyScopeLocalIdColNameGets or sets the name the column in the scope information table that contains an integer identifier for the scope.
Public propertyScopeNameGets or sets the name of the scope to synchronize. (Inherited from RelationalSyncProvider.)
Protected propertyScopeNameColNameGets or sets the name the column in the scope information table that contains the name of the scope.
Protected propertyScopeTimestampColNameGets or sets the name the column in the scope information table that contains the timestamp value when the metadata row was last updated.
Public propertySelectNewTimestampCommandGets or sets an IDbCommand object that contains the query or stored procedure that returns a new timestamp value from the peer database. The timestamp defines the upper bound for the set of changes to be synchronized during the current session.
Public propertySelectOverlappingScopesCommandGets or sets an IDbCommand object that contains the query or stored procedure that returns the scope name and table name for all tables in the specified scope that are also included in other scopes.
Public propertySelectScopeInfoCommandGets or sets an IDbCommand object that contains the query or stored procedure that returns scope metadata from the peer database.
Public propertySelectTableMaxTimestampsCommandGets or sets an IDbCommand object that contains the query or stored procedure that selects the maximum timestamp from each base table or tracking table, to determine whether for each table the destination already has all of the changes from the source.
Public propertySyncAdaptersGets the DbSyncAdapterCollection that is associated with the DbSyncProvider object.
Public propertySyncProviderPositionGets or sets a SyncProviderPosition enumeration value that represents whether a provider is associated with the local or remote database. (Inherited from RelationalSyncProvider.)
Public propertyUpdateScopeCleanupTimestampCommandGets or sets an IDbCommand object that contains the query or stored procedure that updates the scope_cleanup_timestamp column for a particular scope in the scope_info table, to mark the point up to which cleanup has been performed for the scope.
Public propertyUpdateScopeInfoCommandGets or sets an IDbCommand object that contains the query or stored procedure that updates scope metadata in the peer database.
Top

  NameDescription
Public methodBeginSessionCalled by the SyncOrchestrator to indicate that a synchronization session has started. (Inherited from RelationalSyncProvider.)
Public methodCleanupMetadataRemoves change tracking metadata from the database and updates the cleanup knowledge to reflect the point where the cleanup process stopped. This enables outdated nodes to be identified.
Protected methodCreateApplicationTransactionCreates a read-committed transaction over which to apply changes to the database. (Inherited from RelationalSyncProvider.)
Protected methodCreateEnumerationTransactionCreates a read-committed transaction over which to enumerate changes from the database. (Inherited from RelationalSyncProvider.)
Public methodDispose()Releases all resources that are used by the RelationalSyncProvider. (Inherited from RelationalSyncProvider.)
Protected methodDispose(Boolean)Releases the unmanaged resources used by the RelationalSyncProvider and optionally releases the managed resources. (Inherited from RelationalSyncProvider.)
Public methodEndSessionCalled by the SyncOrchestrator object to indicate that a synchronization session has ended. (Overrides RelationalSyncProvider.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. (Inherited from RelationalSyncProvider.)
Public methodGetFullEnumerationChangeBatchGets a batch of changes to synchronize when given batch size, lower bound, knowledge, and change data retriever parameters. (Inherited from RelationalSyncProvider.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetScopeDescriptionReturns a DbSyncScopeDescription object that contains the schema for the tables that are in the SyncAdapters collection.
Public methodGetSyncBatchParametersGets the number of kilobytes of data that will be included in change batches, and the current knowledge for the synchronization scope. (Inherited from RelationalSyncProvider.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnApplyChangeFailedRaises the ApplyMetadataFailed event. (Inherited from RelationalSyncProvider.)
Protected methodOnApplyingChangesRaises the ApplyingChanges event. (Inherited from RelationalSyncProvider.)
Protected methodOnApplyMetadataFailedRaises the ApplyMetadataFailed event. (Inherited from RelationalSyncProvider.)
Protected methodOnChangesAppliedRaises the ChangesApplied event. (Inherited from RelationalSyncProvider.)
Protected methodOnChangesSelectedRaises the ChangesSelected event. (Inherited from RelationalSyncProvider.)
Protected methodOnDbConnectionFailureRaises the DbConnectionFailure event. (Inherited from RelationalSyncProvider.)
Protected methodOnPeerOutdatedRaises the SyncPeerOutdated event. (Inherited from RelationalSyncProvider.)
Protected methodOnSelectingChangesRaises the SelectingChanges event. (Inherited from RelationalSyncProvider.)
Protected methodOnSyncProgressRaises the SyncProgress event. (Inherited from RelationalSyncProvider.)
Public methodProcessChangeBatchProcesses a batch of changes when given resolution policy, source changes, change data retriever, callback, and statistics parameters. (Inherited from RelationalSyncProvider.)
Public methodProcessFullEnumerationChangeBatchProcesses a batch of changes when given resolution policy, source changes, change data retriever, callback, and statistics parameters. (Inherited from RelationalSyncProvider.)
Public methodToString (Inherited from Object.)
Top

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

The principal activities of the peer synchronization provider are as follows:

  • Stores information about tables on the peer that are enabled for synchronization.

  • Enables applications to retrieve changes that occurred in the peer database since the last synchronization.

  • Applies incremental changes to the peer database.

  • Detects conflicting changes.

The following code example instantiates local and remote providers and calls the SetupSyncProvider method in a sample class that was created for this documentation. This method is used so that providers can be configured easily for multiple peers. Several provider commands are specified within this method. For more information about these commands and to view this code in the context of a complete example, see How to: Provision a Server Database for Collaborative Synchronization (Non-SQL Server).

DbSyncProvider localProvider = new DbSyncProvider();
DbSyncProvider remoteProvider = new DbSyncProvider();

//Create a provider by using the SetupSyncProvider on the sample class.             
sampleSyncProvider.SetupSyncProvider(localProviderConnString, localProvider);
localProvider.SyncProviderPosition = SyncProviderPosition.Local;

sampleSyncProvider.SetupSyncProvider(remoteProviderConnString, remoteProvider);
remoteProvider.SyncProviderPosition = SyncProviderPosition.Remote;


Dim localProvider As New DbSyncProvider()
Dim remoteProvider As New DbSyncProvider()

'Create a provider by using the SetupSyncProvider on the sample class.
sampleSyncProvider.SetupSyncProvider(localProviderConnString, localProvider)
localProvider.SyncProviderPosition = SyncProviderPosition.Local

sampleSyncProvider.SetupSyncProvider(remoteProviderConnString, remoteProvider)
remoteProvider.SyncProviderPosition = SyncProviderPosition.Remote


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:
© 2014 Microsoft