SqlSyncStoreRestore Class

Represents operations that must occur after a SQL Server database is restored from a backup.

Inheritance Hierarchy

System.Object
  Microsoft.Synchronization.Data.SqlServer.SqlSyncStoreRestore

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

Syntax

'Declaration
Public Class SqlSyncStoreRestore
'Usage
Dim instance As SqlSyncStoreRestore

public class SqlSyncStoreRestore

public ref class SqlSyncStoreRestore

type SqlSyncStoreRestore =  class end

public class SqlSyncStoreRestore

The SqlSyncStoreRestore type exposes the following members.

Constructors

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

Top

Properties

	Name	Description
	CommandTimeout	Gets or sets the wait time, in seconds, before a restore command is stopped and an error is generated.
	Connection	Gets or sets a SqlConnection object that contains a connection to the database.
	ObjectPrefix	Gets or sets the optional prefix that is used to identify objects that Sync Framework creates.
	ObjectSchema	Gets or sets the database schema in which Sync Framework creates objects.

Top

Methods

	Name	Description
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	PerformPostRestoreFixup	Updates synchronization metadata in a SQL Server database after the database has been restored from a backup.
	ToString	(Inherited from Object.)

Top

Remarks

Use this class after you have restored a SQL Server database that is involved in synchronization. For more information, see How to: Backup and Restore a Database (SQL Server).

Examples

The following code example restores a server database by calling one of the sample Utility methods, and then calls PerformPostRestoreFixup to update metadata. To view this code in the context of a complete application, see How to: Backup and Restore a Database (SQL Server).

Utility.RestoreDatabaseFromBackup();


// Call the API to update synchronization metadata to reflect that the database was
// just restored. The restore stored procedure kills the connection to the
// server, so we must re-establish it.
SqlConnection.ClearPool(serverConn);
serverConn = new SqlConnection(Utility.ConnStr_SqlSync_Server);
SqlSyncStoreRestore databaseRestore = new SqlSyncStoreRestore(serverConn);
databaseRestore.PerformPostRestoreFixup();

Utility.RestoreDatabaseFromBackup()


' Call the API to update synchronization metadata to reflect that the database was 
' just restored. The restore stored procedure kills the connection to the 
' server, so we must re-establish it. 
SqlConnection.ClearPool(serverConn)
serverConn = New SqlConnection(Utility.ConnStr_SqlSync_Server)
Dim databaseRestore As New SqlSyncStoreRestore(serverConn)
databaseRestore.PerformPostRestoreFixup()

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