DbSyncProvider Members

Article
09/29/2009

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

The following tables list the members exposed by the DbSyncProvider type.

Public Constructors

	Name	Description
	DbSyncProvider	Initializes a new instance of the DbSyncProvider class. This constructor is not CLS-compliant.

Top

Public Properties

(see also Protected Properties )

	Name	Description
	BatchingDirectory	Gets or sets the directory in which batch files are spooled to disk. This property is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	ChangeTracking	Gets or sets a ChangeTrackingModel enumeration value that specifies the type of change tracking that is used in all peer databases. This property is not CLS-compliant. Obsolete.
	CleanupBatchingDirectory	Gets or sets whether to clean up batching files after the changes in the files have been applied to the destination. This property is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	Configuration	Not implemented by RelationalSyncProvider. An exception of type NotSupportedException is thrown if you attempt to access this property. This property is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	Connection	Gets or sets an IDbConnection object that is used to connect to the database. This property is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	DestinationCallbacks	Gets an object that a synchronization application can use to register to receive notification of events that occur during synchronization. This property is not CLS-compliant. (Inherited from KnowledgeSyncProvider.)
	IdFormats	Gets a SyncIdFormatGroup object that is used to identify entities in a synchronization session. This property is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	MemoryDataCacheSize	Gets or sets the maximum amount of memory (in KB) that Sync Framework uses to cache changes before spooling those changes to disk. This property is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	ScopeName	Gets or sets the name of the scope to synchronize. This property is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	SelectNewTimestampCommand	Gets 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. This property is not CLS-compliant.
	SelectOverlappingScopesCommand	Gets 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. This property is not CLS-compliant.
	SelectScopeInfoCommand	Gets or sets an IDbCommand object that contains the query or stored procedure that returns scope metadata from the peer database. This property is not CLS-compliant.
	SelectTableMaxTimestampsCommand	Gets 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. This property is not CLS-compliant.
	SyncAdapters	Gets the DbSyncAdapterCollection that is associated with the DbSyncProvider object. This property is not CLS-compliant.
	SyncProviderPosition	Gets or sets a SyncProviderPosition enumeration value that represents whether a provider is associated with the local or remote database. This property is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	UpdateScopeCleanupTimestampCommand	Gets 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. This property is not CLS-compliant.
	UpdateScopeInfoCommand	Gets or sets an IDbCommand object that contains the query or stored procedure that updates scope metadata in the peer database. This property is not CLS-compliant.

Top

Protected Properties

	Name	Description
	ScopeCleanupTimestampColName	Gets 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. This property is not CLS-compliant.
	ScopeForgottenKnowledgeColName	Gets or sets the name the column in the scope information table that contains a binary representation of the forgotten knowledge for each scope. This property is not CLS-compliant.
	ScopeIdColName	Gets or sets the name the column in the scope information table that contains an identifier for the scope, typically a GUID. This property is not CLS-compliant.
	ScopeKnowledgeColName	Gets or sets the name the column in the scope information table that contains a binary representation of the synchronization knowledge for each scope. This property is not CLS-compliant.
	ScopeLocalIdColName	Gets or sets the name the column in the scope information table that contains an integer identifier for the scope. This property is not CLS-compliant.
	ScopeNameColName	Gets or sets the name the column in the scope information table that contains the name of the scope. This property is not CLS-compliant.
	ScopeTimestampColName	Gets or sets the name the column in the scope information table that contains the timestamp value when the metadata row was last updated. This property is not CLS-compliant.

Top

Public Methods

(see also Protected Methods )

	Name	Description
	BeginSession	(Inherited from RelationalSyncProvider.)
	CleanupMetadata	Removes 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. This method is not CLS-compliant.
	Dispose	Overloaded. Releases the resources that are used by the RelationalSyncProvider.(Inherited from RelationalSyncProvider.)
	EndSession	(Inherited from RelationalSyncProvider.)
	Equals	Overloaded. (Inherited from Object.)
	GetChangeBatch	(Inherited from RelationalSyncProvider.)
	GetFullEnumerationChangeBatch	(Inherited from RelationalSyncProvider.)
	GetHashCode	(Inherited from Object.)
	GetScopeDescription	Returns a DbSyncScopeDescription object that contains the schema for the tables that are in the SyncAdapters collection. This method is not CLS-compliant.
	GetSyncBatchParameters	(Inherited from RelationalSyncProvider.)
	GetType	(Inherited from Object.)
	ProcessChangeBatch	(Inherited from RelationalSyncProvider.)
	ProcessFullEnumerationChangeBatch	(Inherited from RelationalSyncProvider.)
	ReferenceEquals	(Inherited from Object.)
	ToString	(Inherited from Object.)

Top

Protected Methods

	Name	Description
	CreateApplicationTransaction	When overridden in a derived class, enables an explicit transaction to be created in which to apply changes to an Oracle database. This method is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	CreateEnumerationTransaction	When overridden in a derived class, enables an explicit transaction to be created in which to enumerate changes from an Oracle database. This method is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	Dispose	Overloaded. (Inherited from RelationalSyncProvider.)
	Finalize	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	OnApplyChangeFailed	(Inherited from RelationalSyncProvider.)
	OnApplyingChanges	(Inherited from RelationalSyncProvider.)
	OnApplyMetadataFailed	(Inherited from RelationalSyncProvider.)
	OnChangesApplied	(Inherited from RelationalSyncProvider.)
	OnChangesSelected	(Inherited from RelationalSyncProvider.)
	OnPeerOutdated	(Inherited from RelationalSyncProvider.)
	OnSelectingChanges	(Inherited from RelationalSyncProvider.)
	OnSyncProgress	(Inherited from RelationalSyncProvider.)

Top

Public Events

	Name	Description
	ApplyChangeFailed	Occurs during uploading, after failing to apply a row at a node. This event is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	ApplyingChanges	Occurs during uploading, after connecting to the database but before applying changes. This event is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	ApplyMetadataFailed	Occurs during uploading, after failing to apply metadata for a row. This event is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	BatchApplied	Occurs after each batch of changes has been applied to the destination. This event is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	BatchSpooled	Occurs after each batch of changes has been written to disk. This event is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	ChangesApplied	Occurs during uploading, after applying changes but before disconnecting from the database. This event is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	ChangesSelected	Occurs during downloading, after enumerating changes but before disconnecting from the database. This event is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	SelectingChanges	Occurs during downloading, after connecting to the database but before selecting changes. This event is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	SyncPeerOutdated	Occurs before enumeration of changes if the destination node is outdated. This event is not CLS-compliant. (Inherited from RelationalSyncProvider.)
	SyncProgress	Occurs during the selection of changes (per table) and the application of changes (per row). This event is not CLS-compliant. (Inherited from RelationalSyncProvider.)

Top

Share via