Share via

Microsoft.Synchronization.Data Namespace

  • Article

This namespace contains types that are used for client and server and peer-to-peer database synchronization in Sync Framework. The following namespaces are used in client and server synchronization: Microsoft.Synchronization, Microsoft.Synchronization.Data, Microsoft.Synchronization.Data.Server, and Microsoft.Synchronization.Data.SqlServerCe. The following namespaces are used in peer-to-peer synchronization: Microsoft.Synchronization, Microsoft.Synchronization.Data, Microsoft.Synchronization.Data.SqlServer, and Microsoft.Synchronization.Data.SqlServerCe.

Classes

  Class Description
Public class AnchorException The exception that is thrown for errors related to anchors, including the failure to return an anchor.
Public class ApplyChangeFailedEventArgs Provides data for the client ApplyChangeFailed event and the server ApplyChangeFailed event.
Public class ApplyingChangesEventArgs Provides data for the client ApplyingChanges event and the server ApplyingChanges event.
Public class ApplyMetadataFailedEventArgs Provides data for the ApplyMetadataFailed event.
Public class ChangesAppliedEventArgs Provides data for the client ChangesApplied event and the server ChangesApplied event.
Public class ChangesSelectedEventArgs Provides data for the client ChangesSelected event and the server ChangesSelected event.
Public class ClientSyncProvider Abstracts a client synchronization provider that communicates with the client data store and shields the synchronization agent from the specific implementation of the data store.
Public class CreatingSchemaEventArgs Provides data for the CreatingSchema event.
Public class DataColumnSurrogate Represents a surrogate of a DataColumn object, which Sync Framework uses during custom binary serialization.
Public class DataSetSurrogate Represents a surrogate of a DataSet object, which Sync Framework uses during custom binary serialization.
Public class DataSyncException The base class for exceptions that are thrown during synchronization.
Public class DataTableSurrogate Represents a surrogate of a DataTable object, which Sync Framework uses during custom binary serialization.
Public class DbApplyChangeFailedEventArgs Provides data for the ApplyChangeFailed event.
Public class DbApplyingChangesEventArgs Provides data for the ApplyingChanges event.
Public class DbBatchAppliedEventArgs Provides data for the BatchApplied event.
Public class DbBatchSpooledEventArgs Provides data for the BatchSpooled event.
Public class DbBeginSnapshotInitializationEventArgs Provides data for the BeginSnapshotInitialization event.
Public class DbChangesAppliedEventArgs Provides data for the ChangesApplied event.
Public class DbChangesSelectedEventArgs Provides data for the ChangesSelected event.
Public class DbEndSnapshotInitializationEventArgs Provides data for the EndSnapshotInitialization event.
Public class DbMetadataSyncException The exception that is thrown for errors that occur while creating or reading table metadata.
Public class DbMissingCommandException The exception that is thrown if a required command for a provider or an adapter is missing.
Public class DbOutdatedEventArgs Provides data for the SyncPeerOutdated event.
Public class DbOutdatedSyncException The exception that is thrown for errors that occur when trying to synchronize a peer that has outdated metadata.
Public class DbProvisioningException The exception that is thrown for errors that occur when attempting to provision a database to participate in synchronization.
Public class DbSchemaException The exception that is thrown for errors that occur while creating or reading table schema.
Public class DbSelectingChangesEventArgs Provides data for the SelectingChanges event.
Public class DbSnapshotInitializationStatistics Represents a set of session-level statistics about the snapshot initialization of a client database.
Public class DbSnapshotInitializationTableStatistics Represents a set of table-level statistics about the snapshot initialization of a client database.
Public class DbSyncAdapter Represents a set of commands that are used to retrieve and apply data and metadata changes at the local peer database.
Public class DbSyncAdapterCollection A collection of DbSyncAdapter objects.
Public class DbSyncBatchInfo Represents a batch header file that contains metadata about the data contained in a synchronization batch.

This class is not CLS-compliant.
Public class DbSyncColumnDescription Represents the schema of a column that is included in the Columns list of a DbSyncTableDescription object. This is used during database provisioning.
Public class DbSyncColumnDescriptionCollection Represents a collection of DbSyncColumnDescription objects.
Public class DbSyncColumnMapping Maps a column in the local database to a column in the remote database.
Public class DbSyncColumnMappingCollection Represents a collection of DbSyncColumnMapping objects.
Public class DbSyncConflict Represents a synchronization conflict at the row level.
Public class DbSyncContext Encapsulates data changes and metadata for a synchronization session.
Public class DbSyncException The base class for exceptions that are thrown during peer database synchronization.
Public class DbSyncForeignKeyConstraint Represents a foreign key relationship between two tables that are involved in synchronization.
Public class DbSyncForeignKeyConstraintCollection Represents a collection of DbSyncForeignKeyConstraint objects.
Public class DbSyncProgressEventArgs Provides data for the SyncProgress event.
Public class DbSyncProvider Encapsulates a peer synchronization provider that communicates with a peer database and shields the synchronization agent from the specific implementation of the database.

This class is not CLS-compliant.
Public class DbSyncScope Represents a logical grouping of objects to be synchronized.
Public class DbSyncScopeDescription Represents a synchronization scope, which is a logical grouping of tables (optionally filtered) that are synchronized as a unit.
Public class DbSyncScopeMetadata Represents the metadata for a DbSyncScope object, such as the knowledge that is associated with a particular scope.
Public class DbSyncScopeProgress Represents a set of synchronization progress statistics for the objects in a DbSyncScope.
Public class DbSyncSession Represents a synchronization session. The DbSyncSession object exists for the duration of the synchronization session.
Public class DbSyncSessionProgressEventArgs Provides data for the SessionProgress event.

This class is not CLS-compliant.
Public class DbSyncTableDescription Represents the schema of a table that is included in the Tables list of a DbSyncScopeDescription object. This is used during database provisioning.
Public class DbSyncTableDescriptionCollection Represents a collection of DbSyncTableDescription objects.
Public class DbSyncTableProgress Represents a set of synchronization progress statistics for a table that is involved in peer synchronization.
Public class MetadataException The exception that is thrown for errors that occur while creating, reading, or writing table metadata.
Public class RelationalSyncProvider Abstracts a generic synchronization provider that communicates with a database and shields the synchronization agent from the specific implementation of the database.

This class is not CLS-compliant.
Public class SchemaCreatedEventArgs Provides data for the SchemaCreated event.
Public class SchemaException The exception that is thrown for errors that occur while creating or reading table schema.
Public class SelectingChangesEventArgs Provides data for the client SelectingChanges event and the server SelectingChanges event.
Public class ServerSyncProvider Abstracts a generic server synchronization provider that communicates with the server data store and shields the synchronization agent from the specific implementation of that data store.
Public class ServerSyncProviderProxy Provides a wrapper for the ServerSyncProvider.
Public class SessionVariableException The exception that is thrown for errors that occur while reading or writing session variables.
Public class SyncAnchor Encapsulates a synchronization anchor. An anchor provides a reference point to determine which changes to synchronize for a synchronization group.
Public class SyncConfiguration Maintains the collections of tables and parameters that are required to configure the client and server synchronization providers.
Public class SyncConflict Represents a synchronization conflict at the row level.
Public class SyncConflictResolver Represents the actions to take when any conflicts occur during synchronization.
Public class SyncContext Encapsulates data changes and anchor values and other metadata for a synchronization session.
Public class SyncGroup Represents a group of SyncTable objects and provides a mechanism to ensure consistent application of changes for those tables.
Public class SyncGroupMetadata Represents the metadata for a SyncGroup object, such as the new anchor value.
Public class SyncGroupProgress Represents a set of synchronization progress statistics for the tables in a SyncGroup.
Public class SyncParameter Encapsulates information sent from the client to the server.
Public class SyncParameterCollection A collection of SyncParameter objects.
Public class SyncProgressEventArgs Provides data for the client SyncProgress event and the server SyncProgress event.
Public class SyncSchema Represents the schema information that is required to create tables that are involved in synchronization.
Public class SyncSchemaColumn Represents the schema of a column in a SyncSchemaTable.
Public class SyncSchemaColumns Represents a collection of SyncSchemaColumn objects.
Public class SyncSchemaForeignKey Represents a foreign key relationship between two tables that are involved in synchronization.
Public class SyncSchemaForeignKeys Represents a collection of SyncSchemaForeignKey objects.
Public class SyncSchemaTable Represents the schema of a table that is involved in synchronization.
Public class SyncSchemaTables Represents a collection of SyncSchemaTable objects.
Public class SyncSession Represents a synchronization session. The SyncSession object exists for the duration of the synchronization session.
Public class SyncStatistics Represents a summary of a SyncSession with regard to the total number of operations that occurred on the client and server.
Public class SyncTable Represents the client settings for a table involved in synchronization.
Public class SyncTableCollection Represents a collection of SyncTable objects.
Public class SyncTableInfo Encapsulates information about table settings and metadata. This information is available through GetServerInfo.
Public class SyncTableMetadata Encapsulates the metadata that is associated with a SyncTable, such as the direction of synchronization.
Public class SyncTableProgress Represents a set of synchronization progress statistics for a SyncTable object.
Public class SyncTracer Provides tracing for a synchronization session, with four levels of output: errors, warnings, informational, and verbose.

Structures

  Structure Description
Public structure SyncServerInfo Encapsulates information about server-side settings and metadata. This information is available through GetServerInfo.

Enumerations

  Enumeration Description
Public enumeration ApplyAction Specifies the options for processing a row when the row cannot be applied during synchronization.
Public enumeration ChangeTrackingModel This enumeration is deprecated. Defines the way in which changes are tracked in the peer database.
Public enumeration ConflictType Defines the types of conflicts that can occur during synchronization.
Public enumeration DbConflictType Defines the types of conflicts that can occur during synchronization.
Public enumeration DbOutdatedSyncAction Defines the options for processing a synchronization request from a peer that has outdated metadata.
Public enumeration DbResolveAction Specifies the options for resolving any conflicts that occur during synchronization.
Public enumeration DbSyncCreationOption Represents the actions that Sync Framework can take when creating synchronization-related objects during database provisioning.
Public enumeration DbSyncStage Defines the different phases of synchronization from the perspective of the local peer.
Public enumeration ResolveAction Specifies the options for resolving any conflicts that occur at the client during synchronization.
Public enumeration SyncDirection Defines the direction that data changes flow, from the perspective of the client.
Public enumeration SyncErrorNumber Defines a list of errors that can occur during synchronization.
Public enumeration SyncSchemaForeignKeyRule Indicates the action that occurs when a FOREIGN KEY constraint, which is defined through a SyncSchemaForeignKeyRule object, is enforced during a delete or update operation.
Public enumeration TableCreationOption Defines the options that are available for creating a table in the client database.