Shardis.Migration
0.1.0-prerelease0082
This is a prerelease version of Shardis.Migration.
There is a newer prerelease version of this package available.
See the version list below for details.
See the version list below for details.
dotnet add package Shardis.Migration --version 0.1.0-prerelease0082
NuGet\Install-Package Shardis.Migration -Version 0.1.0-prerelease0082
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="Shardis.Migration" Version="0.1.0-prerelease0082" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="Shardis.Migration" Version="0.1.0-prerelease0082" />
<PackageReference Include="Shardis.Migration" />
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 Shardis.Migration --version 0.1.0-prerelease0082
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Shardis.Migration, 0.1.0-prerelease0082"
#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 Shardis.Migration@0.1.0-prerelease0082
#: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=Shardis.Migration&version=0.1.0-prerelease0082&prerelease
#tool nuget:?package=Shardis.Migration&version=0.1.0-prerelease0082&prerelease
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
Shardis.Migration
Key migration execution primitives for Shardis. This package contains the executor, planner abstractions, checkpoint store contracts, and reference in-memory implementations used for tests and prototypes.
Install
dotnet add package Shardis.Migration --version 0.1.*
When to use
- You need a deterministic, idempotent migration executor for moving keys between topologies.
- You want reference
ICheckpointStore
implementations for tests and local runs.
What’s included
- Planner models:
MigrationPlan<TKey>
,SegmentMove<TKey>
and related helpers. ShardMigrationExecutor<TKey>
— orchestrates copy → verify → swap with checkpoints and metrics hooks.ICheckpointStore
andInMemoryCheckpointStore
reference implementation.
Quick start
// register migration runtime
services.AddShardisMigration<string>();
var planner = services.GetRequiredService<IShardMigrationPlanner<string>>();
var executor = services.GetRequiredService<ShardMigrationExecutor<string>>();
var plan = await planner.CreatePlanAsync(fromSnapshot, toSnapshot, CancellationToken.None);
var result = await executor.ExecuteAsync(plan, progress: null, CancellationToken.None);
Integration notes
- For long-running migrations prefer segmented plans and a durable
ICheckpointStore
(SQL/Cosmos/Redis) to bound memory and enable resume.
Samples & tests
- Docs: https://github.com/veggerby/shardis/blob/main/docs/migration-usage.md
- ADR: https://github.com/veggerby/shardis/blob/main/docs/adr/0004-segmented-planner.md
- Tests: https://github.com/veggerby/shardis/tree/main/test/Shardis.Migration.Tests
Contributing
- PRs that add durable checkpoint store implementations or improve executor observability are welcome. See https://github.com/veggerby/shardis/blob/main/CONTRIBUTING.md
License
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. net9.0 is compatible. net9.0-android was computed. net9.0-browser was computed. net9.0-ios was computed. net9.0-maccatalyst was computed. net9.0-macos was computed. net9.0-tvos was computed. net9.0-windows was computed. net10.0 was computed. 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.
-
net8.0
- Microsoft.Extensions.DependencyInjection (>= 9.0.8)
- Shardis (>= 0.1.0-prerelease0082)
-
net9.0
- Microsoft.Extensions.DependencyInjection (>= 9.0.8)
- Shardis (>= 0.1.0-prerelease0082)
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.1.0-prerelease0084 | 15 | 8/31/2025 |
0.1.0-prerelease0083 | 16 | 8/31/2025 |
0.1.0-prerelease0082 | 152 | 8/28/2025 |
0.1.0-prerelease0075 | 153 | 8/28/2025 |
0.1.0-prerelease0067 | 154 | 8/27/2025 |
Initial release. Full notes: https://github.com/veggerby/shardis/blob/main/CHANGELOG.md#010---2025-08-25