同期プロセスをトレースする方法
このトピックでは、Sync Framework のトレース インフラストラクチャおよびトレース クラスの使用方法について説明します。このトピックの例では、次に示す Sync Framework の型とイベントを中心に説明します。
サンプル コードを実行する方法については、「一般的なクライアントとサーバーの同期タスクのプログラミング」の「操作方法に関するトピックのサンプル アプリケーション」を参照してください。
Synchronization Services のトレースについて
トレースには、アプリケーションの処理、データ、およびメタデータを記録する操作と、この情報をリスナーに提供する操作が必要になります。リスナーは、トレース情報を繰り返しファイルに書き込みますが、この情報を別の方法で処理することもできます。Sync Framework には、クライアント同期プロバイダーとサーバー同期プロバイダーのトレースが含まれています。分散アプリケーションでは、発見が困難な問題のトラブルシューティングを可能にするトレースがきわめて重要になります。
Sync Framework のトレースは、次のコンポーネントから構成されます。
トレースの .NET Framework 実装に基づいたトレース インフラストラクチャ (具体的には TraceListener クラス)。クライアント プロバイダーとサーバー プロバイダーの最も重要な処理がトレースされ、キー メタデータが 1 つまたは複数のリスナーに提供されます。
SyncTracer オブジェクト。有効になっているトレース レベルを判定したり、アプリケーション イベントに基づいてメッセージをトレース出力に書き込んだりすることを可能にします。
Sync Framework から提供されるトレース コンポーネントに加えて、一般的なトラブルシューティングでは、デバッガーや SQL Server Profiler などの他のツールも使用します。たとえば、トレース出力には SQL Server データベースに関する情報が含まれている場合があります。SQL Server Profiler を使用すると、サーバー同期プロバイダーによって生成されたデータベースの利用状況に関する詳細な情報を取得できます。
トレース インフラストラクチャの使用
既定では、Sync Framework アプリケーションに対してトレースは有効になっていません。トレース リスナーを構成するには、アプリケーションの app.config ファイルを編集します。このファイルの詳細については、Visual Studio のドキュメントを参照してください。このファイルを使用して、リスナーの追加、種類や関連パラメーターの設定、リスナーの削除、アプリケーションによって以前に設定されたすべてのリスナーのクリアなどの操作を指定できます。詳細については、.NET Framework のドキュメントのトレースに関する説明を参照してください。構成ファイルの例を次に示します。
<configuration>
<system.diagnostics>
<switches>
<!-- 0-off, 1-error, 2-warn, 3-info, 4-verbose. -->
<add name="SyncTracer" value="3" />
</switches>
<trace autoflush="true">
<listeners>
<add name="TestListener" type="System.Diagnostics.TextWriterTraceListener" initializeData="c:\TraceSample.txt"/>
</listeners>
</trace>
</system.diagnostics>
</configuration>
コード例には、次の XML ノードが含まれています。
System.Diagnostics.TextWriterTraceListener(TextWriterTraceListener) 型のリスナー (パスはc:\TraceSample.txt)。SyncTracerという名前のスイッチ。値は3に設定されています。すべての値とそれに対応するトレース出力を次の表に示します。スイッチの値 トレース レベル 出力 0offメッセージはトレース リスナーに送信されません。
1errorエラー メッセージのみがトレース リスナーに送信されます。
2warningエラー メッセージおよび警告メッセージがトレース リスナーに送信されます。
3info情報メッセージ、警告メッセージ、およびエラー メッセージがトレース リスナーに送信されます。
4verboseすべてのメッセージがトレース リスナーに送信されます。
トレースを行うと、一定のオーバーヘッドが発生します。したがって、トレースと、アプリケーションのパフォーマンス要件とのバランスをとる必要があります。ほとんどの場合、
infoとverboseの設定が適切なのは、アプリケーション開発時やトラブルシューティングを行うときだけです。
次の構成ファイルは、デバイスの例を示します。
<configuration>
<traceSettings>
<add key ="FileLocation" value="TraceSample.txt"/>
<add key ="LogLevel" value="4"/>
</traceSettings>
</configuration>
ファイル名は trace.config.txt で、デバイスのアプリケーション ディレクトリに配置する必要があります。ファイルを Visual Studio ソリューションに含めるとアプリケーションと一緒に展開できます。
次のファイル セグメントは、SyncTracer 値 3 を使用して構成されたトレースの出力です。それぞれの行は、出力の種類で開始されています。このケースでは、出力はすべて INFO です。エラーが発生した場合、該当する行は ERROR で開始されます。
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:027, Connecting to server using string: Data Source=localhost;Initial Catalog=SyncSamplesDb;Integrated Security=True
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:027, ----- Server Enumerating Changes to Client for Group "Customer" -----
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:027, Client Id: bc5610f6-bf9c-4ccd-8599-839e54e953e2
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:027, Mapped Originator Id: 0
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:042,
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:042, ----- Enumerating Inserts for Table Customer -----
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:058, Changes Enumerated: 5
INFO, MyApp.vshost, 10, 03/20/2008 17:43:03:058, --- End Enumerating Inserts for Table Customer ---
SyncTracer オブジェクトの使用
SyncTracer オブジェクトを使用すると、アプリケーションに固有のトレース データをトレース ファイルに書き込むことができます。これにより、アプリケーションがある時点で行っている処理に関するコンテキスト情報を取得できます。このオブジェクトを使用すると、次のタスクを実行できます。
次のメソッドを使用して、有効になっているトレース レベルを判定する。
次のメソッド、および各メソッドの他のオーバーロードを使用して、アプリケーション イベントに基づいてトレース出力にメッセージを書き込む。
たとえば、情報メッセージを出力するには、次のコードを使用します。
SyncTracer.Info("Informational message")Info レベルが有効な場合、情報メッセージは出力に書き込まれます。それ以外の場合、情報メッセージは無視されます。
次のように、さらに複雑なメッセージを構成することもできます。数値を指定することで、出力ファイルにおけるインデントのレベルを設定します。
SyncTracer.Verbose("Processing table t1")SyncTracer.Verbose(1, "Applying Deletes")SyncTracer.Verbose(2, "{0} rows deleted", numDeleted)SyncTracer.Verbose(1, "Applying Inserts")SyncTracer.Verbose(2, "{0} rows inserted", numInserted)出力は次のとおりです。
Processing table t1Applying Deletes7 Rows DeletedApplying Inserts9 Rows inserted
次のコード例では、有効になっているトレース レベルに関する情報をコンソールに書き込みます。構成ファイルでは、SyncTracer スイッチの値として 3 を指定しています。これは、Info に対応します。したがって、Error、Warning、および Info は True を返し、Verbose は False を返します。
Console.WriteLine("** Tracing Levels Enabled for this Application **");
Console.WriteLine("Error: " + SyncTracer.IsErrorEnabled().ToString());
Console.WriteLine("Warning: " + SyncTracer.IsWarningEnabled().ToString());
Console.WriteLine("Info: " + SyncTracer.IsInfoEnabled().ToString());
Console.WriteLine("Verbose: " + SyncTracer.IsVerboseEnabled().ToString());
Console.WriteLine("** Tracing Levels Enabled for this Application **")
Console.WriteLine("Error: " + SyncTracer.IsErrorEnabled().ToString())
Console.WriteLine("Warning: " + SyncTracer.IsWarningEnabled().ToString())
Console.WriteLine("Info: " + SyncTracer.IsInfoEnabled().ToString())
Console.WriteLine("Verbose: " + SyncTracer.IsVerboseEnabled().ToString())
次のコード例は、データ競合に関する警告メッセージを書式設定してトレース出力に書き込む方法を示しています。競合の詳細については、「データの競合とエラーを処理する方法」を参照してください。詳細トレースには、競合に関する情報が含まれます。このアプリケーションでは、詳細トレースが無効になっています。アプリケーションは、競合を警告として報告します。
if (SyncTracer.IsVerboseEnabled() == false && e.Conflict.ConflictType != ConflictType.ErrorsOccurred)
{
DataTable conflictingServerChange = e.Conflict.ServerChange;
DataTable conflictingClientChange = e.Conflict.ClientChange;
int serverColumnCount = conflictingServerChange.Columns.Count;
int clientColumnCount = conflictingClientChange.Columns.Count;
StringBuilder clientRowAsString = new StringBuilder();
StringBuilder serverRowAsString = new StringBuilder();
for (int i = 0; i < clientColumnCount; i++)
{
clientRowAsString.Append(conflictingClientChange.Rows[0][i] + " | ");
}
for (int i = 0; i < serverColumnCount; i++)
{
serverRowAsString.Append(conflictingServerChange.Rows[0][i] + " | ");
}
SyncTracer.Warning(1, "CONFLICT DETECTED FOR CLIENT {0}", e.Session.ClientId);
SyncTracer.Warning(2, "** Client change **");
SyncTracer.Warning(2, clientRowAsString.ToString());
SyncTracer.Warning(2, "** Server change **");
SyncTracer.Warning(2, serverRowAsString.ToString());
}
If SyncTracer.IsVerboseEnabled() = False AndAlso e.Conflict.ConflictType <> ConflictType.ErrorsOccurred Then
Dim conflictingServerChange As DataTable = e.Conflict.ServerChange
Dim conflictingClientChange As DataTable = e.Conflict.ClientChange
Dim serverColumnCount As Integer = conflictingServerChange.Columns.Count
Dim clientColumnCount As Integer = conflictingClientChange.Columns.Count
Dim clientRowAsString As New StringBuilder()
Dim serverRowAsString As New StringBuilder()
Dim i As Integer
For i = 1 To clientColumnCount - 1
clientRowAsString.Append(conflictingClientChange.Rows(0)(i).ToString() & " | ")
Next i
For i = 1 To serverColumnCount - 1
serverRowAsString.Append(conflictingServerChange.Rows(0)(i).ToString() & " | ")
Next i
SyncTracer.Warning(1, "CONFLICT DETECTED FOR CLIENT {0}", e.Session.ClientId)
SyncTracer.Warning(2, "** Client change **")
SyncTracer.Warning(2, clientRowAsString.ToString())
SyncTracer.Warning(2, "** Server change **")
SyncTracer.Warning(2, serverRowAsString.ToString())
End If
有効になっているトレース レベルを調べることは、潜在的にコストのかかる処理を回避するのに役立ちます。このコード例において、アプリケーションは、詳細トレースが既に有効になっている場合に追加の処理を回避します。逆に、特定のトレース レベルが有効になっているときだけ出力を生成することもできます。
トレースのセキュリティに関する考慮事項
トレース ファイルには、サーバー コンピューター、クライアント コンピューター、アプリケーション データ、およびログインに関する情報が記録されます (パスワードはトレース ファイルに書き込まれません)。詳細トレースが有効な場合、データベース内の変更された行がトレース ファイルに書き込まれます。適切なアクセス制御リストを使用してトレース ファイルを保護するようにしてください。
完全なコード例
次の完全なコード例には、このトピックで既に説明したコード例に加え、同期を実行するためのコードが含まれています。このアプリケーションを実行する前に、次の手順を実行します。
Visual Studio でプロジェクトを作成します。
Sync Framework DLL および「データベース プロバイダーの Utility クラスに関するトピック」で説明されている
Utilityクラスへの参照を追加します。構成ファイルを作成し、このトピックの前半で示した例の XML コードをコピーします。
Utility クラスのメソッドに対する 2 つの呼び出しに注意してください。
util.MakeFailingChangesOnClient(): サーバー側で適用されたときには失敗する変更をクライアント側で加えます。制約違反および関連するアプリケーション例外が、警告として自動的にトレース ファイルに書き込まれます。util.MakeConflictingChangesOnClientAndServer(): 同期時に競合する変更をクライアント側とサーバー側で加えます。競合は、SampleServerSyncProvider_ApplyChangeFailedイベント ハンドラーによってトレース ファイルに書き込まれます。
アプリケーションを実行した後、トレース出力ファイルを開き、アプリケーション コードの結果としてメッセージと競合警告が自動的に書き込まれていることを確認します。
using System;
using System.IO;
using System.Text;
using System.Data;
using System.Data.SqlClient;
using System.Data.SqlServerCe;
using Microsoft.Synchronization;
using Microsoft.Synchronization.Data;
using Microsoft.Synchronization.Data.Server;
using Microsoft.Synchronization.Data.SqlServerCe;
namespace Microsoft.Samples.Synchronization
{
class Program
{
static void Main(string[] args)
{
//The SampleStats class handles information from the SyncStatistics
//object that the Synchronize method returns.
SampleStats sampleStats = new SampleStats();
//Delete and re-create the database. The client synchronization
//provider also enables you to create the client database
//if it does not exist.
Utility.SetPassword_SqlCeClientSync();
Utility.DeleteAndRecreateCompactDatabase(Utility.ConnStr_SqlCeClientSync, true);
//Write to the console which tracing levels are enabled. The app.config
//file specifies a value of 3 for the SyncTracer switch, which corresponds
//to Info. Therefore, Error, Warning, and Info return True, and Verbose
//returns False.
Console.WriteLine("");
Console.WriteLine("** Tracing Levels Enabled for this Application **");
Console.WriteLine("Error: " + SyncTracer.IsErrorEnabled().ToString());
Console.WriteLine("Warning: " + SyncTracer.IsWarningEnabled().ToString());
Console.WriteLine("Info: " + SyncTracer.IsInfoEnabled().ToString());
Console.WriteLine("Verbose: " + SyncTracer.IsVerboseEnabled().ToString());
//Initial synchronization. Instantiate the SyncAgent
//and call Synchronize.
SampleSyncAgent sampleSyncAgent = new SampleSyncAgent();
SyncStatistics syncStatistics = sampleSyncAgent.Synchronize();
sampleStats.DisplayStats(syncStatistics, "initial");
//Make a change at the client that fails when it is
//applied at the server. The constraint violation
//is automatically written to the trace file as a warning.
Utility.MakeFailingChangeOnClient();
//Make changes at the client and server that conflict
//when they are synchronized. The conflicts are written
//to the trace file in the SampleServerSyncProvider_ApplyChangeFailed
//event handler.
Utility.MakeConflictingChangesOnClientAndServer();
//Subsequent synchronization.
syncStatistics = sampleSyncAgent.Synchronize();
sampleStats.DisplayStats(syncStatistics, "subsequent");
//Return server data back to its original state.
Utility.CleanUpServer();
//Exit.
Console.Write("\nPress Enter to close the window.");
Console.ReadLine();
}
}
//Create a class that is derived from
//Microsoft.Synchronization.SyncAgent.
public class SampleSyncAgent : SyncAgent
{
public SampleSyncAgent()
{
//Instantiate a client synchronization provider and specify it
//as the local provider for this synchronization agent.
this.LocalProvider = new SampleClientSyncProvider();
//Instantiate a server synchronization provider and specify it
//as the remote provider for this synchronization agent.
this.RemoteProvider = new SampleServerSyncProvider();
//Add the Customer table: specify a synchronization direction of
//DownloadOnly.
SyncTable customerSyncTable = new SyncTable("Customer");
customerSyncTable.CreationOption = TableCreationOption.DropExistingOrCreateNewTable;
customerSyncTable.SyncDirection = SyncDirection.Bidirectional;
this.Configuration.SyncTables.Add(customerSyncTable);
}
}
//Create a class that is derived from
//Microsoft.Synchronization.Server.DbServerSyncProvider.
public class SampleServerSyncProvider : DbServerSyncProvider
{
public SampleServerSyncProvider()
{
//Create a connection to the sample server database.
Utility util = new Utility();
SqlConnection serverConn = new SqlConnection(Utility.ConnStr_DbServerSync);
this.Connection = serverConn;
//Create a command to retrieve a new anchor value from
//the server. In this case, we use a timestamp value
//that is retrieved and stored in the client database.
//During each synchronization, the new anchor value and
//the last anchor value from the previous synchronization
//are used: the set of changes between these upper and
//lower bounds is synchronized.
//
//SyncSession.SyncNewReceivedAnchor is a string constant;
//you could also use @sync_new_received_anchor directly in
//your queries.
SqlCommand selectNewAnchorCommand = new SqlCommand();
string newAnchorVariable = "@" + SyncSession.SyncNewReceivedAnchor;
selectNewAnchorCommand.CommandText = "SELECT " + newAnchorVariable + " = min_active_rowversion() - 1";
selectNewAnchorCommand.Parameters.Add(newAnchorVariable, SqlDbType.Timestamp);
selectNewAnchorCommand.Parameters[newAnchorVariable].Direction = ParameterDirection.Output;
selectNewAnchorCommand.Connection = serverConn;
this.SelectNewAnchorCommand = selectNewAnchorCommand;
//Create a SyncAdapter for the Customer table by using
//the SqlSyncAdapterBuilder:
// * Specify the base table and tombstone table names.
// * Specify the columns that are used to track when
// and where changes are made.
// * Specify bidirectional synchronization.
// * Call ToSyncAdapter to create the SyncAdapter.
// * Specify a name for the SyncAdapter that matches the
// the name specified for the corresponding SyncTable.
// Do not include the schema names (Sales in this case).
SqlSyncAdapterBuilder customerBuilder = new SqlSyncAdapterBuilder(serverConn);
customerBuilder.TableName = "Sales.Customer";
customerBuilder.TombstoneTableName = customerBuilder.TableName + "_Tombstone";
customerBuilder.SyncDirection = SyncDirection.Bidirectional;
customerBuilder.CreationTrackingColumn = "InsertTimestamp";
customerBuilder.UpdateTrackingColumn = "UpdateTimestamp";
customerBuilder.DeletionTrackingColumn = "DeleteTimestamp";
customerBuilder.CreationOriginatorIdColumn = "InsertId";
customerBuilder.UpdateOriginatorIdColumn = "UpdateId";
customerBuilder.DeletionOriginatorIdColumn = "DeleteId";
SyncAdapter customerSyncAdapter = customerBuilder.ToSyncAdapter();
customerSyncAdapter.TableName = "Customer";
this.SyncAdapters.Add(customerSyncAdapter);
//Handle the ApplyChangeFailed event. This allows us to write
//information to the trace file about any conflicts that occur.
this.ApplyChangeFailed += new EventHandler<ApplyChangeFailedEventArgs>(SampleServerSyncProvider_ApplyChangeFailed);
}
private void SampleServerSyncProvider_ApplyChangeFailed(object sender, ApplyChangeFailedEventArgs e)
{
//Verbose tracing includes information about conflicts. In this application,
//Verbose tracing is disabled, and we have decided to flag conflicts with a
//warning.
//Check if Verbose tracing is enabled and if the conflict is an error.
//If the conflict is not an error, we write a warning to the trace file
//with information about the conflict.
if (SyncTracer.IsVerboseEnabled() == false && e.Conflict.ConflictType != ConflictType.ErrorsOccurred)
{
DataTable conflictingServerChange = e.Conflict.ServerChange;
DataTable conflictingClientChange = e.Conflict.ClientChange;
int serverColumnCount = conflictingServerChange.Columns.Count;
int clientColumnCount = conflictingClientChange.Columns.Count;
StringBuilder clientRowAsString = new StringBuilder();
StringBuilder serverRowAsString = new StringBuilder();
for (int i = 0; i < clientColumnCount; i++)
{
clientRowAsString.Append(conflictingClientChange.Rows[0][i] + " | ");
}
for (int i = 0; i < serverColumnCount; i++)
{
serverRowAsString.Append(conflictingServerChange.Rows[0][i] + " | ");
}
SyncTracer.Warning(1, "CONFLICT DETECTED FOR CLIENT {0}", e.Session.ClientId);
SyncTracer.Warning(2, "** Client change **");
SyncTracer.Warning(2, clientRowAsString.ToString());
SyncTracer.Warning(2, "** Server change **");
SyncTracer.Warning(2, serverRowAsString.ToString());
}
}
}
//Create a class that is derived from
//Microsoft.Synchronization.Data.SqlServerCe.SqlCeClientSyncProvider.
//You can just instantiate the provider directly and associate it
//with the SyncAgent, but you could use this class to handle client
//provider events and other client-side processing.
public class SampleClientSyncProvider : SqlCeClientSyncProvider
{
public SampleClientSyncProvider()
{
//Specify a connection string for the sample client database.
Utility util = new Utility();
this.ConnectionString = Utility.ConnStr_SqlCeClientSync;
this.SchemaCreated += new EventHandler<SchemaCreatedEventArgs>(SampleClientSyncProvider_SchemaCreated);
}
private void SampleClientSyncProvider_SchemaCreated(object sender, SchemaCreatedEventArgs e)
{
string tableName = e.Table.TableName;
Utility util = new Utility();
//Call ALTER TABLE on the client. This must be done
//over the same connection and within the same
//transaction that Sync Framework uses
//to create the schema on the client.
Utility.MakeSchemaChangesOnClient(e.Connection, e.Transaction, "Customer");
}
}
//Handle the statistics that are returned by the SyncAgent.
public class SampleStats
{
public void DisplayStats(SyncStatistics syncStatistics, string syncType)
{
Console.WriteLine(String.Empty);
if (syncType == "initial")
{
Console.WriteLine("****** Initial Synchronization ******");
}
else if (syncType == "subsequent")
{
Console.WriteLine("***** Subsequent Synchronization ****");
}
Console.WriteLine("Start Time: " + syncStatistics.SyncStartTime);
Console.WriteLine("Total Changes Downloaded: " + syncStatistics.TotalChangesDownloaded);
Console.WriteLine("Total Changes Uploaded: " + syncStatistics.TotalChangesUploaded);
Console.WriteLine("Complete Time: " + syncStatistics.SyncCompleteTime);
Console.WriteLine(String.Empty);
}
}
}
Imports System
Imports System.IO
Imports System.Text
Imports System.Data
Imports System.Data.SqlClient
Imports System.Data.SqlServerCe
Imports Microsoft.Synchronization
Imports Microsoft.Synchronization.Data
Imports Microsoft.Synchronization.Data.Server
Imports Microsoft.Synchronization.Data.SqlServerCe
Class Program
Shared Sub Main(ByVal args() As String)
'The SampleStats class handles information from the SyncStatistics
'object that the Synchronize method returns.
Dim sampleStats As New SampleStats()
'Delete and re-create the database. The client synchronization
'provider also enables you to create the client database
'if it does not exist.
Utility.SetPassword_SqlCeClientSync()
Utility.DeleteAndRecreateCompactDatabase(Utility.ConnStr_SqlCeClientSync, True)
'Write to the console which tracing levels are enabled. The app.config
'file specifies a value of 3 for the SyncTracer switch, which corresponds
'to Info. Therefore, Error, Warning, and Info return True, and Verbose
'returns False.
Console.WriteLine("")
Console.WriteLine("** Tracing Levels Enabled for this Application **")
Console.WriteLine("Error: " + SyncTracer.IsErrorEnabled().ToString())
Console.WriteLine("Warning: " + SyncTracer.IsWarningEnabled().ToString())
Console.WriteLine("Info: " + SyncTracer.IsInfoEnabled().ToString())
Console.WriteLine("Verbose: " + SyncTracer.IsVerboseEnabled().ToString())
'Initial synchronization. Instantiate the SyncAgent
'and call Synchronize.
Dim sampleSyncAgent As New SampleSyncAgent()
Dim syncStatistics As SyncStatistics = sampleSyncAgent.Synchronize()
sampleStats.DisplayStats(syncStatistics, "initial")
'Make a change at the client that fails when it is
'applied at the server. The constraint violation
'is automatically written to the trace file as a warning.
Utility.MakeFailingChangeOnClient()
'Make changes at the client and server that conflict
'when they are synchronized. The conflicts are written
'to the trace file in the SampleServerSyncProvider_ApplyChangeFailed
'event handler.
Utility.MakeConflictingChangesOnClientAndServer()
'Subsequent synchronization.
syncStatistics = sampleSyncAgent.Synchronize()
sampleStats.DisplayStats(syncStatistics, "subsequent")
'Return server data back to its original state.
Utility.CleanUpServer()
'Exit.
Console.Write(vbLf + "Press Enter to close the window.")
Console.ReadLine()
End Sub 'Main
End Class 'Program
'Create a class that is derived from
'Microsoft.Synchronization.SyncAgent.
Public Class SampleSyncAgent
Inherits SyncAgent
Public Sub New()
'Instantiate a client synchronization provider and specify it
'as the local provider for this synchronization agent.
Me.LocalProvider = New SampleClientSyncProvider()
'Instantiate a server synchronization provider and specify it
'as the remote provider for this synchronization agent.
Me.RemoteProvider = New SampleServerSyncProvider()
'Add the Customer table: specify a synchronization direction of
'DownloadOnly.
Dim customerSyncTable As New SyncTable("Customer")
customerSyncTable.CreationOption = TableCreationOption.DropExistingOrCreateNewTable
customerSyncTable.SyncDirection = SyncDirection.Bidirectional
Me.Configuration.SyncTables.Add(customerSyncTable)
End Sub 'New
End Class 'SampleSyncAgent
'Create a class that is derived from
'Microsoft.Synchronization.Server.DbServerSyncProvider.
Public Class SampleServerSyncProvider
Inherits DbServerSyncProvider
Public Sub New()
'Create a connection to the sample server database.
Dim util As New Utility()
Dim serverConn As New SqlConnection(Utility.ConnStr_DbServerSync)
Me.Connection = serverConn
'Create a command to retrieve a new anchor value from
'the server. In this case, we use a timestamp value
'that is retrieved and stored in the client database.
'During each synchronization, the new anchor value and
'the last anchor value from the previous synchronization
'are used: the set of changes between these upper and
'lower bounds is synchronized.
'
'SyncSession.SyncNewReceivedAnchor is a string constant;
'you could also use @sync_new_received_anchor directly in
'your queries.
Dim selectNewAnchorCommand As New SqlCommand()
Dim newAnchorVariable As String = "@" + SyncSession.SyncNewReceivedAnchor
selectNewAnchorCommand.CommandText = "SELECT " + newAnchorVariable + " = min_active_rowversion() - 1"
selectNewAnchorCommand.Parameters.Add(newAnchorVariable, SqlDbType.Timestamp)
selectNewAnchorCommand.Parameters(newAnchorVariable).Direction = ParameterDirection.Output
selectNewAnchorCommand.Connection = serverConn
Me.SelectNewAnchorCommand = selectNewAnchorCommand
'Create a SyncAdapter for the Customer table by using
'the SqlSyncAdapterBuilder:
' * Specify the base table and tombstone table names.
' * Specify the columns that are used to track when
' and where changes are made.
' * Specify bidirectional synchronization.
' * Call ToSyncAdapter to create the SyncAdapter.
' * Specify a name for the SyncAdapter that matches the
' the name specified for the corresponding SyncTable.
' Do not include the schema names (Sales in this case).
Dim customerBuilder As New SqlSyncAdapterBuilder(serverConn)
customerBuilder.TableName = "Sales.Customer"
customerBuilder.TombstoneTableName = customerBuilder.TableName + "_Tombstone"
customerBuilder.SyncDirection = SyncDirection.Bidirectional
customerBuilder.CreationTrackingColumn = "InsertTimestamp"
customerBuilder.UpdateTrackingColumn = "UpdateTimestamp"
customerBuilder.DeletionTrackingColumn = "DeleteTimestamp"
customerBuilder.CreationOriginatorIdColumn = "InsertId"
customerBuilder.UpdateOriginatorIdColumn = "UpdateId"
customerBuilder.DeletionOriginatorIdColumn = "DeleteId"
Dim customerSyncAdapter As SyncAdapter = customerBuilder.ToSyncAdapter()
customerSyncAdapter.TableName = "Customer"
Me.SyncAdapters.Add(customerSyncAdapter)
'Handle the ApplyChangeFailed event. This allows us to write
'information to the trace file about any conflicts that occur.
AddHandler Me.ApplyChangeFailed, AddressOf SampleServerSyncProvider_ApplyChangeFailed
End Sub 'New
Private Sub SampleServerSyncProvider_ApplyChangeFailed(ByVal sender As Object, ByVal e As ApplyChangeFailedEventArgs)
'Verbose tracing includes information about conflicts. In this application,
'Verbose tracing is disabled, and we have decided to flag conflicts with a
'warning.
'Check if Verbose tracing is enabled and if the conflict is an error.
'If the conflict is not an error, we write a warning to the trace file
'with information about the conflict.
If SyncTracer.IsVerboseEnabled() = False AndAlso e.Conflict.ConflictType <> ConflictType.ErrorsOccurred Then
Dim conflictingServerChange As DataTable = e.Conflict.ServerChange
Dim conflictingClientChange As DataTable = e.Conflict.ClientChange
Dim serverColumnCount As Integer = conflictingServerChange.Columns.Count
Dim clientColumnCount As Integer = conflictingClientChange.Columns.Count
Dim clientRowAsString As New StringBuilder()
Dim serverRowAsString As New StringBuilder()
Dim i As Integer
For i = 1 To clientColumnCount - 1
clientRowAsString.Append(conflictingClientChange.Rows(0)(i).ToString() & " | ")
Next i
For i = 1 To serverColumnCount - 1
serverRowAsString.Append(conflictingServerChange.Rows(0)(i).ToString() & " | ")
Next i
SyncTracer.Warning(1, "CONFLICT DETECTED FOR CLIENT {0}", e.Session.ClientId)
SyncTracer.Warning(2, "** Client change **")
SyncTracer.Warning(2, clientRowAsString.ToString())
SyncTracer.Warning(2, "** Server change **")
SyncTracer.Warning(2, serverRowAsString.ToString())
End If
End Sub 'SampleServerSyncProvider_ApplyChangeFailed
End Class 'SampleServerSyncProvider
'Create a class that is derived from
'Microsoft.Synchronization.Data.SqlServerCe.SqlCeClientSyncProvider.
'You can just instantiate the provider directly and associate it
'with the SyncAgent, but you could use this class to handle client
'provider events and other client-side processing.
Public Class SampleClientSyncProvider
Inherits SqlCeClientSyncProvider
Public Sub New()
'Specify a connection string for the sample client database.
Dim util As New Utility()
Me.ConnectionString = Utility.ConnStr_SqlCeClientSync
End Sub 'New
Private Sub SampleClientSyncProvider_SchemaCreated(ByVal sender As Object, ByVal e As SchemaCreatedEventArgs)
Dim tableName As String = e.Table.TableName
Dim util As New Utility()
'Call ALTER TABLE on the client. This must be done
'over the same connection and within the same
'transaction that Sync Framework uses
'to create the schema on the client.
Utility.MakeSchemaChangesOnClient(e.Connection, e.Transaction, "Customer")
End Sub 'SampleClientSyncProvider_SchemaCreated
End Class 'SampleClientSyncProvider
'Handle the statistics that are returned by the SyncAgent.
Public Class SampleStats
Public Sub DisplayStats(ByVal syncStatistics As SyncStatistics, ByVal syncType As String)
Console.WriteLine(String.Empty)
If syncType = "initial" Then
Console.WriteLine("****** Initial Synchronization ******")
ElseIf syncType = "subsequent" Then
Console.WriteLine("***** Subsequent Synchronization ****")
End If
Console.WriteLine("Start Time: " & syncStatistics.SyncStartTime)
Console.WriteLine("Total Changes Downloaded: " & syncStatistics.TotalChangesDownloaded)
Console.WriteLine("Total Changes Uploaded: " & syncStatistics.TotalChangesUploaded)
Console.WriteLine("Complete Time: " & syncStatistics.SyncCompleteTime)
Console.WriteLine(String.Empty)
End Sub 'DisplayStats
End Class 'SampleStats