In addition to synchronizing data, DbSyncKit allows you to generate SQL queries based on the changes detected during synchronization. This feature is valuable for understanding the exact SQL statements that will be executed in the destination database.

Prerequisites

Before generating SQL queries, ensure that you have:

Performed a synchronization operation using DbSyncKit (Refer to Basic Synchronization).
Received a synchronization result (Result<T>) object.

Generate SQL Queries

Once you have the synchronization result, you can generate SQL queries using the GetSqlQueryForSyncData method. Replace YourEntity with the appropriate entity type.

// A method to filter out the result data before creating a hashset (optional or you can pass null instead)
private List<YourEntity> FilterData(List<T> data)
{
    // filter your data here
    return data;
}

// Perform synchronization
Result<YourEntity> syncResult = Sync.SyncData<YourEntity>(SourceDatabase, DestinationDatabase,FilterData);

// Generate SQL queries
string sqlQueries = Sync.QueryBuilder.GetSqlQueryForSyncData<YourEntity>(syncResult,Sync.ContractFetcher.DestinationQueryGenerationManager);

Console.WriteLine(sqlQueries);

The GetSqlQueryForSyncData method takes the synchronization result as input and returns a list of SQL queries corresponding to the changes detected during synchronization.

Understanding Generated SQL Queries

The generated SQL queries fall into three categories:

Insert Queries: SQL statements for adding new records to the destination database.
Update Queries: SQL statements for modifying existing records in the destination database.
Delete Queries: SQL statements for removing records from the destination database.

By examining these queries, you gain insights into the exact modifications that will be applied to the destination database.

Continue exploring other topics in the Usage Guide.

Query Generation Process Updates

DbSyncKit.Templates Package

The DbSyncKit.Templates package provides a collection of templates for various database providers to streamline your development process.

Available Templates

Templating Engine: Fluid

To facilitate the templating process, we've integrated the Fluid templating engine (https://github.com/sebastienros/fluid) into the DbSyncKit.Templates package. Fluid provides a flexible and expressive way to define templates, enhancing the readability and maintainability of the code.

Improved Readability and Flexibility

With the introduction of templating, the query generation process has seen improvements in terms of code readability and flexibility. The templating approach allows for clearer and more maintainable templates, ensuring a smooth and user-friendly experience.

Explore these updates as you continue to use DbSyncKit. If you have any questions or feedback, refer to the Support and Contact section.