SqlSyncStoreMetadataUpgrade Class

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

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

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

'Declaration
Public Class SqlSyncStoreMetadataUpgrade
'Usage
Dim instance As SqlSyncStoreMetadataUpgrade

The SqlSyncStoreMetadataUpgrade type exposes the following members.

  NameDescription
Public methodSqlSyncStoreMetadataUpgrade(SqlConnection)Initializes a new instance of the SqlSyncStoreMetadataUpgrade class with the specified connection.
Public methodSqlSyncStoreMetadataUpgrade(SqlConnection, String)Initializes a new instance of the SqlSyncStoreMetadataUpgrade class with the specified connection and object prefix.
Public methodSqlSyncStoreMetadataUpgrade(SqlConnection, String, String)Initializes a new instance of the SqlSyncStoreMetadataUpgrade class with the specified connection, object prefix, and object schema.
Top

  NameDescription
Public propertyConnectionGets or sets the database connection over which the upgrade is performed.
Public propertyObjectPrefixGets or sets the optional prefix that is used to identify objects that Sync Framework creates.
Public propertyObjectSchemaGets or sets the database schema in which Sync Framework creates objects.
Top

  NameDescription
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Protected methodMemberwiseClone (Inherited from Object.)
Public methodNeedsUpgradeIndicates whether the metadata format of the database needs to be upgraded.
Public methodToString (Inherited from Object.)
Public methodUpgradeSyncSchemaUpgrades the metadata format to the current version.
Top

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.

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: