SmartTableSync 0.5.4
dotnet add package SmartTableSync --version 0.5.4
NuGet\Install-Package SmartTableSync -Version 0.5.4
<PackageReference Include="SmartTableSync" Version="0.5.4" />
<PackageVersion Include="SmartTableSync" Version="0.5.4" />
<PackageReference Include="SmartTableSync" />
paket add SmartTableSync --version 0.5.4
#r "nuget: SmartTableSync, 0.5.4"
#:package SmartTableSync@0.5.4
#addin nuget:?package=SmartTableSync&version=0.5.4
#tool nuget:?package=SmartTableSync&version=0.5.4
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
rowversioncolumn, 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
- Overview and guides
- Manual mode, step by step
- Auto mode, step by step
- Run it in your own app: background service, Hangfire, Quartz.NET
- Every setting, with examples
- Identities, rights and troubleshooting
- How each strategy finds changes
- Known limitations
- Changelog
Feedback
Tried it? Tell me what worked and what didn't: report a bug or ask for a feature, ask a question, or report a security problem privately. Anything else: Ruslan Sidoriako on LinkedIn.
License
| Product | Versions 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. |
-
net10.0
- Microsoft.Data.SqlClient (>= 7.0.2)
- Microsoft.Data.SqlClient.Extensions.Azure (>= 7.0.2)
- Microsoft.Extensions.Configuration.Abstractions (>= 10.0.3)
- Microsoft.Extensions.DependencyInjection.Abstractions (>= 10.0.3)
- Microsoft.Extensions.Options (>= 10.0.3)
- System.Security.Cryptography.Pkcs (>= 10.0.13)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
SmartTableSync now shows up by name in SQL Server, the quick start explains a reused suffix
instead of failing in Terraform, and there are clear ways to give feedback.
### Added
- SmartTableSync's connections show up in SQL Server as `SmartTableSync`, and the scaffold tool's
as `SmartTableSync.Scaffold` (`APP_NAME()`, `sys.dm_exec_sessions.program_name`), so a DBA can
see which sessions are the sync. An `Application Name` in the connection string still wins.
See [connection strings](docs/configuration.md#connection-strings).
- Issue forms for bugs and feature requests, links to Discussions for questions and for sharing a
setup, a [contributing guide](CONTRIBUTING.md), and a feedback section in the README and on the
NuGet package page.
### Changed
- The quick start stops before Terraform, with a clear message, when the suffix's resource group
already exists but another folder or machine created it. Before, Terraform failed at apply with
"a resource with the ID ... already exists". The docs say that `acme1` is only an example.
- A connection string that can't be read now stops the sync at startup with a message naming the
setting (for example *"ChildDbConnectionString isn't a valid connection string"*), instead of at
the first connection.
### Upgrading
Nothing to change. If you filter SQL Server sessions or audit logs by program name, they now show
`SmartTableSync` instead of SqlClient's default; set `Application Name` in the connection strings
to keep a name of your own.
### Tested
- Unit and integration tests (303 and 74) pass, including new ones that check `APP_NAME()` and
`sys.dm_exec_sessions.program_name` on a real SQL Server, with and without an `Application
Name` in the connection string.
- The quick start's suffix check on Azure: it stops for a resource group that exists but isn't in
the folder's Terraform state, and continues for a new suffix, a deleted one, and the folder's own
deployment.
Full changelog: https://github.com/Sidorus/SmartTableSync/blob/main/CHANGELOG.md