Share via


SqlSyncStoreMetadataUpgrade Class

Upgrades the metadata format of the database to the current version.

Inheritance Hierarchy

System.Object
  Microsoft.Synchronization.Data.SqlServer.SqlSyncStoreMetadataUpgrade

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

Syntax

'Declaration
Public Class SqlSyncStoreMetadataUpgrade
'Usage
Dim instance As SqlSyncStoreMetadataUpgrade
public class SqlSyncStoreMetadataUpgrade
public ref class SqlSyncStoreMetadataUpgrade
type SqlSyncStoreMetadataUpgrade =  class end
public class SqlSyncStoreMetadataUpgrade

The SqlSyncStoreMetadataUpgrade type exposes the following members.

Constructors

  Name Description
Public method SqlSyncStoreMetadataUpgrade(SqlConnection) Initializes a new instance of the SqlSyncStoreMetadataUpgrade class with the specified connection.
Public method SqlSyncStoreMetadataUpgrade(SqlConnection, String) Initializes a new instance of the SqlSyncStoreMetadataUpgrade class with the specified connection and object prefix.
Public method SqlSyncStoreMetadataUpgrade(SqlConnection, String, String) Initializes a new instance of the SqlSyncStoreMetadataUpgrade class with the specified connection, object prefix, and object schema.

Top

Properties

  Name Description
Public property Connection Gets or sets the database connection over which the upgrade is performed.
Public property ObjectPrefix Gets or sets the optional prefix that is used to identify objects that Sync Framework creates.
Public property ObjectSchema Gets or sets the database schema in which Sync Framework creates objects.

Top

Methods

  Name Description
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Protected method MemberwiseClone (Inherited from Object.)
Public method NeedsUpgrade Indicates whether the metadata format of the database needs to be upgraded.
Public method ToString (Inherited from Object.)
Public method 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. The SqlSyncStoreMetadataUpgrade class is used to 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.

See Also

Reference

Microsoft.Synchronization.Data.SqlServer Namespace

Other Resources

Upgrading the Database Synchronization Community