SqlCeSyncStoreMetadataUpgrade Class
Upgrades the metadata format of the database to the current version.
Inheritance Hierarchy
System.Object
Microsoft.Synchronization.Data.SqlServerCe.SqlCeSyncStoreMetadataUpgrade
Namespace: Microsoft.Synchronization.Data.SqlServerCe
Assembly: Microsoft.Synchronization.Data.SqlServerCe (in Microsoft.Synchronization.Data.SqlServerCe.dll)
Syntax
'Declaration
Public Class SqlCeSyncStoreMetadataUpgrade
'Usage
Dim instance As SqlCeSyncStoreMetadataUpgrade
public class SqlCeSyncStoreMetadataUpgrade
public ref class SqlCeSyncStoreMetadataUpgrade
type SqlCeSyncStoreMetadataUpgrade = class end
public class SqlCeSyncStoreMetadataUpgrade
The SqlCeSyncStoreMetadataUpgrade type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
SqlCeSyncStoreMetadataUpgrade(SqlCeConnection) | Initializes a new instance of the SqlCeSyncStoreMetadataUpgrade class with the specified connection. |
|
SqlCeSyncStoreMetadataUpgrade(SqlCeConnection, String) | Initializes a new instance of the SqlCeSyncStoreMetadataUpgrade class with the specified connection and object prefix. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Connection | Gets or sets the database connection over which the upgrade is performed. |
|
ObjectPrefix | Gets or sets the optional prefix that is used to identify objects that Sync Framework creates. |
Top
Methods
| Name | Description | |
|---|---|---|
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
Finalize | (Inherited from Object.) |
|
GetHashCode | (Inherited from Object.) |
|
GetType | (Inherited from Object.) |
|
MemberwiseClone | (Inherited from Object.) |
|
NeedsUpgrade | Indicates whether the metadata format of the database needs to be upgraded. |
|
ToString | (Inherited from Object.) |
|
UpgradeSyncSchema | Upgrades the metadata format to the current version. |
Top
Remarks
The metadata format for the database providers changed in Sync Framework 2.1. The new metadata format is incompatible with previous versions of the database providers. Components in the Microsoft.Synchronization.Data.SqlServerCe namespace automatically upgrade the metadata format of a SQL Server Compact database. This upgrade occurs the first time a component in this namespace connects to the database. The SqlCeSyncStoreMetadataUpgrade class is used to manually upgrade the metadata to the new format. Be aware that the upgrade to the new metadata format cannot be undone, and when you try to use an earlier version of the database providers to synchronize a database that is in the 2.1 format, Sync Framework throws an exception.
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.