Realizar el seguimiento del proceso de sincronización
En este tema se muestra cómo utilizar la infraestructura de seguimiento y la clase de seguimiento en Sync Framework. Los ejemplos de este tema se centran en los tipos y eventos siguientes de Sync Framework:
El evento ApplyChangeFailed de DbServerSyncProvider y ApplyChangeFailedEventArgs.
Para obtener información acerca de cómo se ejecuta el código de ejemplo, vea "Aplicaciones de ejemplo en los temas sobre procedimientos" en Programar tareas comunes de sincronización de cliente y servidor.
Descripción del seguimiento en Synchronization Services
El seguimiento implica el registro de operaciones, datos y metadatos de aplicación y el suministro de esta información a un agente de escucha. Un agente de escucha escribe frecuentemente información de seguimiento en un archivo, pero también puede administrar la información de otras maneras. Sync Framework incluye un seguimiento para los proveedores de sincronización de cliente y servidor. En aplicaciones distribuidas, el seguimiento puede ser muy importante porque permite solucionar problemas que, de otro modo, serían difíciles de detectar.
El seguimiento en Sync Framework está formado por los componentes siguientes:
Una infraestructura de seguimiento que está basada en la implementación de seguimiento de .NET Framework, concretamente la clase TraceListener. Se realiza el seguimiento de las operaciones más importantes de los proveedores de servidor y cliente, y se proporcionan los metadatos clave a uno o más agentes de escucha.
El objeto SyncTracer, que permite determinar qué nivel de seguimiento está habilitado y escribir mensajes en los resultados del seguimiento basados en eventos de aplicación.
Además de los componentes de seguimiento que Sync Framework proporciona, la solución de problemas implica normalmente a otras herramientas, como un depurador o SQL Server Profiler. Por ejemplo, los resultados del seguimiento podrían incluir información sobre una base de datos de SQL Server y, a continuación, se utilizaría SQL Server Profiler para obtener más detalles sobre la actividad de base de datos generada por el proveedor de sincronización del servidor.
Utilizar la infraestructura de seguimiento
De forma predeterminada, el seguimiento no está habilitado para aplicaciones de Sync Framework. Para configurar un agente de escucha de seguimiento, modifique el archivo app.config para la aplicación. Para obtener más información sobre este archivo, vea la documentación de Visual Studio. En este archivo, puede agregar un agente de escucha, establecer su tipo y parámetros relacionados, quitar un agente de escucha, o borrar todos los agentes de escucha establecidos previamente por la aplicación. Para obtener más información, vea la documentación de .NET Framework acerca del seguimiento. El archivo de configuración debe asemejarse al del ejemplo siguiente.
<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>
Los nodos XML siguientes se incluyen en el código de ejemplo:
Un agente de escucha de tipo
System.Diagnostics.TextWriterTraceListener(TextWriterTraceListener), con la ruta de acceso a:c:\TraceSample.txt.Un modificador denominado
SyncTracer. cuyo valor es3. En la tabla siguiente se muestran todos los valores y cómo se relacionan con los resultados del seguimiento.Valor de modificador Nivel de seguimiento Resultados 0offNingún mensaje a los agentes de escucha de seguimiento.
1errorSólo mensajes de error a los agentes de escucha de seguimiento.
2warningMensajes de error y de advertencia a los agentes de escucha de seguimiento.
3infoMensajes de error, de advertencia e informativos a los agentes de escucha de seguimiento.
4verboseTodos los mensajes a los agentes de escucha de seguimiento.
El seguimiento tiene realmente alguna sobrecarga. Por consiguiente, se debe mantener un equilibrio entre el seguimiento y los requisitos de rendimiento de la aplicación. En la mayoría de los casos, los valores
verboseeinfosolo son adecuados durante el desarrollo y la solución de problemas de la aplicación.
El archivo de configuración siguiente muestra un ejemplo para dispositivos.
<configuration>
<traceSettings>
<add key ="FileLocation" value="TraceSample.txt"/>
<add key ="LogLevel" value="4"/>
</traceSettings>
</configuration>
El archivo debe llamarse trace.config.txt y debe estar ubicado en el directorio de aplicación en el dispositivo. Si incluye en archivo en una solución de Visual Studio, se puede implementar con la aplicación.
El segmento del archivo siguiente corresponde a un seguimiento que se configuró utilizando un valor SyncTracer de 3. Cada línea comienza con el tipo de resultado. En este caso, el resultado siempre es INFO. Si se produjera un error, las líneas pertinentes comenzarían con 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, ----- Cambios de enumeración del servidor en el cliente para el grupo "Cliente" -----
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, ----- Enumerando inserciones para la tabla 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, --- Fin de enumeración de inserciones para la tabla Customer ---
Usar el objeto SyncTracer
El objeto SyncTracer permite escribir datos de seguimiento específicos de la aplicación en el archivo de seguimiento. De este modo se puede proporcionar información contextual sobre lo que una aplicación está realizando en un momento concreto. Este objeto permite realizar las tareas siguientes:
Determinar el nivel de seguimiento habilitado, usando los métodos siguientes:
Escribir mensajes en los resultados del seguimiento basados en los eventos de la aplicación, usando los métodos siguientes, y otras sobrecargas para cada método:
Por ejemplo, para generar un mensaje informativo, puede utilizar el código siguiente:
SyncTracer.Info("Informational message")Si el nivel Info está habilitado, el mensaje se escribe en los resultados; de lo contrario, se omite.
También se pueden formar mensajes más complejos, como el siguiente. Los números que se especifican establecen el nivel de sangría en el archivo de resultados.
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)Los resultados son los siguientes:
Processing table t1Applying Deletes7 Rows DeletedApplying Inserts9 Rows inserted
En el ejemplo de código siguiente se escribe información en la consola sobre qué niveles de seguimiento están habilitados. El archivo de configuración especifica un valor de 3 para el modificador SyncTracer. Esto corresponde a Info. Por consiguiente, Error, Warning e Info devuelven True, y Verbose devuelve 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())
En el ejemplo de código siguiente se muestra cómo escribir mensajes de advertencia con formato sobre conflictos de datos en los resultados del seguimiento. Para obtener más información sobre conflictos, vea Controlar conflictos de datos y errores. El seguimiento detallado incluye información sobre conflictos. En esta aplicación el seguimiento detallado está deshabilitado y, en su lugar, la aplicación marca los conflictos con una advertencia.
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
La comprobación de qué niveles de seguimiento están habilitados puede ayudar a evitar que el procesamiento sea potencialmente costoso. En el código de ejemplo, la aplicación evita un procesamiento adicional si el seguimiento detallado ya está habilitado. A la inversa, la aplicación sólo puede generar resultados cuando está habilitado un determinado nivel de seguimiento.
Consideraciones de seguridad para el seguimiento
Los archivos de seguimiento pueden incluir información sobre los equipos cliente y servidor, los datos de la aplicación y los inicios de sesión. No se escriben contraseñas en el archivo de seguimiento. Si está habilitado el seguimiento detallado, cada fila modificada de la base de datos se escribe en el archivo de seguimiento. Contribuya a proteger el archivo de seguimiento usando las listas de control de acceso adecuadas.
Ejemplo de código completo
En el ejemplo de código completo siguiente se incluyen los ejemplos de código descritos anteriormente en este tema y un código adicional para realizar la sincronización. Antes de ejecutar la aplicación, realice los pasos siguientes:
Cree un proyecto en Visual Studio.
Agregue referencias a las DLL de Sync Framework y a la clase
Utilityque está disponible en Clase de utilidad para los temas de procedimientos del proveedor de bases de datos.Cree un archivo de configuración y copie el código XML del ejemplo mostrado anteriormente en este tema.
Tenga en cuenta las dos llamadas a métodos en la clase Utility:
util.MakeFailingChangesOnClient()Realiza una modificación en el cliente que produce un error cuando se aplica en el servidor. La infracción de restricción y la excepción de aplicación relacionada se escriben automáticamente en el archivo de seguimiento como advertencias.util.MakeConflictingChangesOnClientAndServer()Realiza modificaciones en el cliente y en el servidor que entran en conflicto cuando se sincronizan. Los conflictos se escriben en el archivo de seguimiento en el controlador de eventosSampleServerSyncProvider_ApplyChangeFailed.
Después de ejecutar la aplicación, abra el archivo de resultados del seguimiento para ver los mensajes que se escriben automáticamente, y las advertencias de conflicto, que son consecuencia del código de la aplicación.
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
Vea también
Conceptos
Programar tareas comunes de sincronización de cliente y servidor