SmartTableSync 0.5.1

There is a newer version of this package available.
See the version list below for details.
dotnet add package SmartTableSync --version 0.5.1
                    
NuGet\Install-Package SmartTableSync -Version 0.5.1
                    
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="SmartTableSync" Version="0.5.1" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="SmartTableSync" Version="0.5.1" />
                    
Directory.Packages.props
<PackageReference Include="SmartTableSync" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add SmartTableSync --version 0.5.1
                    
#r "nuget: SmartTableSync, 0.5.1"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#:package SmartTableSync@0.5.1
                    
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package.
#addin nuget:?package=SmartTableSync&version=0.5.1
                    
Install as a Cake Addin
#tool nuget:?package=SmartTableSync&version=0.5.1
                    
Install as a Cake Tool

SmartTableSync

A self-configuring .NET engine that keeps tables synchronized from one SQL database to another (parent to child). Give it table names: it inspects each table's schema, picks how to detect changes and how to merge them, and keeps the child up to date on the schedule your host chooses.

Built for Azure SQL Database, where it runs in production, and works with Azure SQL Managed Instance and SQL Server (on-premises or in a VM) in any combination.

What it does

  • Syncs the tables you list, one way: inserts, updates and deletes.
  • Chooses per table how to find changed rows: SQL Server Change Tracking, a rowversion column, a timestamp column, or a full re-scan for small tables.
  • Copies a new table in full once, then only what changed, and resumes where it stopped.
  • Needs no DDL rights at run time and signs in with managed identities or any SQL Server sign-in.
  • Notices schema changes in the parent; in Auto mode it adds new columns to the child by itself.

Install

dotnet add package SmartTableSync

That's the only package you need: it includes every sign-in method, from SQL logins and Windows authentication to managed identities and other Microsoft Entra methods (Authentication=Active Directory ... in the connection string).

Use it

Register the engine and run it on your own schedule, here every 5 minutes in a background service:

using SmartTableSync.Abstractions;
using SmartTableSync.Hosting;

var builder = Host.CreateApplicationBuilder(args);
builder.Services.AddSmartTableSync();
builder.Services.AddHostedService<SyncWorker>();
builder.Build().Run();

public sealed class SyncWorker(ISyncOrchestrator orchestrator) : BackgroundService
{
    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
    {
        using var timer = new PeriodicTimer(TimeSpan.FromMinutes(5));
        do
        {
            await orchestrator.RunAsync(stoppingToken);
        }
        while (await timer.WaitForNextTickAsync(stoppingToken));
    }
}

appsettings.json:

{
  "ParentDbConnectionString": "Server=tcp:myserver.database.windows.net,1433;Database=ParentDb;Authentication=Active Directory Managed Identity;User Id=<client id>;Encrypt=True",
  "ChildDbConnectionString": "Server=tcp:myserver.database.windows.net,1433;Database=ChildDb;Authentication=Active Directory Managed Identity;User Id=<client id>;Encrypt=True",
  "SmartTableSync": {
    "TableList": "Product,Customer,sales.Order",
    "Mode": "Manual"
  }
}

The child database needs a table, a table type and a merge procedure for every synced table. In Manual mode (the default) you create them from the scripts of the SmartTableSync.Scaffold tool; in Auto mode the engine creates them itself with a separate provisioning connection (ChildProvisioningConnectionString).

Hangfire, Quartz.NET and other hosts work the same way: call ISyncOrchestrator.RunAsync from your scheduler. Overlapping runs are safe, also across several instances.

How changes are found

Strategy Used when Deletes reach the child
Change Tracking SQL Server Change Tracking is on for the table on every run
RowVersion the table has a rowversion column at the delete check, hourly by default
Timestamp the table has a UTC datetime column updated on every change (default LastUpdate) at the delete check
Full re-scan none of the above, and the table has up to 50,000 rows at the delete check

Documentation

License

Apache License 2.0. See LICENSE and NOTICE.

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
0.5.4 120 10/22/2026
0.5.3 103 10/20/2026
0.5.2 101 10/20/2026
0.5.1 96 10/20/2026
0.5.0 117 10/20/2026
0.5.0-preview.1 76 10/19/2026

The quick start now comes from NuGet: a new template package creates the Azure Function and the
deploy script as a project of your own, so there's no need to clone the repository. The library
and the scaffold tool are unchanged apart from the version.

### Added

- **SmartTableSync.Templates**, a `dotnet new` template package. `dotnet new install
 SmartTableSync.Templates`, then `dotnet new smarttablesync-azure -n MySync`, creates a project
 of your own with the Azure Function (using the SmartTableSync package), the quick start script
 and its Terraform, and the scaffold tool as a local tool, all in the template's version. The
 quick start no longer needs a clone of the repository.

### Changed

- `quickstart/deploy.ps1` runs the scaffold tool from NuGet (the project's
 `.config/dotnet-tools.json`) when it runs in a project created from the template, and from
 source in the repository, as before.
- The Manual mode guide and the setup guide install the scaffold tool from NuGet instead of running
 it from the repository.

### Upgrading

Nothing to change: no new settings, rights or schema scripts. Update with
`dotnet add package SmartTableSync` and `dotnet tool update --global SmartTableSync.Scaffold`.

### Tested

- Unit and integration tests (298 and 72) pass.
- A project created from the template builds against the release's SmartTableSync package with no
 warnings, and runs the release's scaffold tool through its tool manifest; the release workflow
 checks this before publishing.
- The quick start script's scaffold step runs both in a project created from the template and in
 the repository.


Full changelog: https://github.com/Sidorus/SmartTableSync/blob/main/CHANGELOG.md