Unified.Data.Tables.InMemory
0.3.0
See the version list below for details.
dotnet add package Unified.Data.Tables.InMemory --version 0.3.0
NuGet\Install-Package Unified.Data.Tables.InMemory -Version 0.3.0
<PackageReference Include="Unified.Data.Tables.InMemory" Version="0.3.0" />
<PackageVersion Include="Unified.Data.Tables.InMemory" Version="0.3.0" />
<PackageReference Include="Unified.Data.Tables.InMemory" />
paket add Unified.Data.Tables.InMemory --version 0.3.0
#r "nuget: Unified.Data.Tables.InMemory, 0.3.0"
#:package Unified.Data.Tables.InMemory@0.3.0
#addin nuget:?package=Unified.Data.Tables.InMemory&version=0.3.0
#tool nuget:?package=Unified.Data.Tables.InMemory&version=0.3.0
Unified.Data.Tables
A small, reusable Azure Table Storage data layer for .NET: a generic IStorage<T> repository with
configurable in-memory caching, optimistic concurrency, upserts and batch transactions, bounded
prefix queries, builder-driven partial updates, role-gated properties, legacy-column aliases, and a
reflection-based object-graph serializer that transparently handles nested types and the 64 KB
per-cell limit — plus a semantically faithful in-memory backend for tests.
It exists so the same battle-tested storage primitives can be shared across projects instead of being copy-pasted into each one.
Features
- Generic repository —
IStorage<T>over Azure Tables, one table per entity type (typeof(T).Name), created lazily on first use (EnsureCreatedAsync()for fail-fast hosts). - Reflection-based serializer — flattens nested objects into
Parent_Childcolumns, stores enums as strings and money-styledecimals as doubles, and falls back to JSON (then GZip) for collections and complex graphs. Oversized cells are compressed — and, as a last resort, truncated — so a single large property can never blow the 64 KB limit and lose the whole row. - Configurable caching — reads are served from
IMemoryCacheper a registration-timeCachePolicy(Sliding,Absolute, orDisabled— per entity type or globally); writes keep the entity cache coherent and invalidate the relevant query caches automatically. - Optimistic concurrency (ETag) — a caller-supplied
ETagenforces strict concurrency (a conflict surfaces asRequestFailedException412 → map to 409); explicitConcurrencyMode.Strict/LastWriterWinsoverloads make intent greppable. - Upsert & batches —
UpsertAsync(single round-trip insert-or-replace),CreateBatchAsync/UpsertBatchAsync(partition-grouped 100-row transactions),CountAsync(keys-only projection). - Bounded queries —
QueryAsync(QueryOptions)and streamingQueryStreamAsyncwith partition scope, canonical RowKey-prefix ranges, andTake— never cached, never a disguised full scan. - Partial (Merge) updates —
UpdateAsync(id, builder)writes only the columns you declare, leaving the rest of the row untouched with no read required. - Legacy column aliases —
[ColumnAlias]reads old column names (e.g. after a property rename) when the canonical column is absent; writes stay canonical, so rows converge without a migration job. - Protected properties — mark a property
[ProtectedProperty("admin,...")]and role-gate writes through a pluggableIProtectedPropertyAuthorizer(the package itself has no ASP.NET Core dependency). - Faithful in-memory backend —
Unified.Data.Tables.InMemoryround-trips rows through the REAL serializer with 409/412/404 and ETag semantics, so tests exercise production behaviour. - Composite id convention —
Idis"{PartitionKey}|{RowKey}"(shared helpers inEntityId); row keys may themselves contain|.
Installation
dotnet add package Unified.Data.Tables
This is shipped as three packages:
| Package | Contents | Use it in |
|---|---|---|
| Unified.Data.Tables | TableStorage<T>, the serializer, cache policies, DI helpers (Azure dependencies) |
server / host projects |
| Unified.Data.Tables.Abstractions | Entity, IStorage<T>, QueryOptions, ConcurrencyMode, UpdateBuilder<T>, EntityId, [ColumnAlias], [ProtectedProperty] — no Azure/hosting deps |
shared/domain & Blazor WebAssembly projects |
| Unified.Data.Tables.InMemory | InMemoryStorage<T> — serializer-faithful in-memory IStorage<T> |
test projects, dev/offline mode |
Unified.Data.Tables references the abstractions transitively, so most apps just install it. In a browser-safe shared library that only defines entities and repository contracts, reference the abstractions alone.
Requires .NET 10 and an Azure Storage account (or the local Azurite emulator).
Quick start
1. Define an entity
Derive from Entity. Id is the composite "{PartitionKey}|{RowKey}"; CreatedAt, UpdatedAt,
ETag and the service-managed Timestamp are maintained for you.
using Unified.Data.Tables;
public sealed class Customer : Entity
{
public string Name { get; set; } = "";
public string Email { get; set; } = "";
public decimal Balance { get; set; }
}
2. Register it
using Azure.Data.Tables;
using Unified.Data.Tables;
// Option A — from a connection string:
builder.Services.AddUnifiedTableStorage(connectionString);
// Option B — managed identity:
builder.Services.AddUnifiedTableStorage(
new Uri("https://myaccount.table.core.windows.net"), new DefaultAzureCredential());
// Option C — you already register a TableServiceClient yourself:
builder.Services.AddSingleton(_ => new TableServiceClient(connectionString));
builder.Services.AddUnifiedTableStorage();
// Cache policy is a DEPLOYMENT concern — configure it per host:
builder.Services.AddUnifiedTableStorage(connectionString, o =>
{
o.Cache = CachePolicy.Absolute(TimeSpan.FromSeconds(30)); // bound cross-process staleness
o.CacheFor<ChatMessage>(CachePolicy.Disabled); // huge partitions — don't cache
});
All overloads register IMemoryCache, the configured options, and the open-generic
IStorage<T> → TableStorage<T> mapping as singletons.
Sharing tables across processes? A second process (worker, subprocess, sidecar) writing to the same tables makes
Slidingcaching unbounded-stale in the readers. UseCachePolicy.Disabledin secondary processes andAbsolutewith a short TTL in the primary.
3. Use it
public sealed class CustomerService(IStorage<Customer> storage)
{
public Task<Customer> Add(Customer c) => storage.CreateAsync(c);
public Task<Customer> Save(Customer c) => storage.UpsertAsync(c);
public Task<Customer?> Get(string id) => storage.OneAsync(id);
public Task<bool> Exists(string id) => storage.ExistsAsync(id);
public Task<IEnumerable<Customer>> InRegion(string region) => storage.QueryAsync(region);
public Task Remove(string id) => storage.DeleteAsync(id);
}
// PartitionKey = "eu", RowKey = "alice@example.com"
var customer = new Customer
{
Id = "eu|alice@example.com",
Name = "Alice",
Email = "alice@example.com",
Balance = 100m
};
await storage.CreateAsync(customer); // ids are normalized: trim → spaces to '-' → lower-case
var loaded = await storage.OneAsync("eu|alice@example.com");
var euOnes = await storage.QueryAsync("eu"); // scope to a partition (omit for the whole table)
IStorage<T>
| Method | Description |
|---|---|
CreateAsync(entity) |
Insert a new row (409 when it exists); returns it with its populated ETag. |
UpsertAsync(entity) |
Insert-or-replace in one round trip. Unconditional by design (last writer wins); preserves a caller-supplied CreatedAt. |
OneAsync(id) |
Fetch one row by composite id, or null. |
ExistsAsync(id) |
Whether a row exists (cache-aware). |
QueryAsync(partition?) |
All rows, or just one partition (the cached read path). |
QueryAsync(options) |
Bounded query: partition + RowKey prefix + Take. Never cached. |
QueryStreamAsync(options?) |
Streaming variant — never caches, never buffers. |
UpdateAsync(entity) |
Full replace with adaptive (Auto) ETag concurrency. |
UpdateAsync(entity, mode) |
Full replace with explicit ConcurrencyMode. |
UpdateAsync(id, builder) |
Partial Merge — writes only the declared columns. |
CreateBatchAsync(entities) |
Transactional inserts, grouped by partition, 100 per transaction. |
UpsertBatchAsync(entities) |
Transactional insert-or-replace, same chunking. |
CountAsync(partition?) |
Row count via keys-only projection (Tables has no server-side count). |
DeleteAsync(id) |
Delete one row (idempotent). |
DeletePartitionAsync(partition) |
Batch-delete a whole partition; returns the count. |
Bounded queries
// Chat messages for one vision, bounded by RowKey prefix:
var messages = await storage.QueryAsync(new QueryOptions
{
Partition = visionId,
RowKeyPrefix = "msg_",
Take = 100,
});
// Stream a huge partition without buffering:
await foreach (var run in storage.QueryStreamAsync(new QueryOptions { Partition = visionId }))
Process(run);
Results arrive in lexical (PartitionKey, RowKey) order — encode any other order into your RowKeys.
RowKeyPrefix requires Partition (a cross-partition RowKey range would be a full table scan).
Partial updates
Only the properties you set are written; everything else on the row is preserved, and no read is needed.
await storage.UpdateAsync("eu|alice@example.com", b => b
.SetProperty(x => x.Balance, 250m)
.SetProperty(x => x.Name, "Alice A."));
Optimistic concurrency
OneAsync/QueryAsync populate Entity.ETag. Pass it back on UpdateAsync(entity) for a strict
check — a concurrent modification throws RequestFailedException with status 412.
var c = await storage.OneAsync(id);
c!.Balance += 100;
await storage.UpdateAsync(c); // 412 if the row changed since it was read
Pick semantics explicitly when it matters:
- Disjoint-field mutation →
UpdateAsync(id, builder)— Merge, race-safe by construction. - Read-modify-write of the whole object →
UpdateAsync(entity)—Auto: strict when the ETag round-tripped, cached-ETag with one retry otherwise. - Deliberate overwrite →
UpdateAsync(entity, ConcurrencyMode.LastWriterWins)— explicit and greppable. (Don't null the ETag to "turn off" concurrency; that silently selects the cached-ETag path, which is neither strict nor last-writer-wins.) - Mandatory round-trip →
UpdateAsync(entity, ConcurrencyMode.Strict)— throwsInvalidOperationExceptionwhen no ETag is present instead of degrading.
Entity.Timestamp mirrors the service-managed last-write time: populated on every read, reset to
null on writes (write responses don't carry it), never stored as a column. Unlike UpdatedAt it is
bumped by ANY storage write — including migrations — and cannot be set by clients.
Legacy column aliases
Renamed a property (or adopted this package with pre-existing rows)? Declare the old column name and reads fall back to it whenever the canonical column is absent — writes always use the property name, so rows converge to the canonical schema as they are rewritten. No migration job.
// Property you own:
public sealed class Customer : Entity
{
[ColumnAlias("FullName")] // rows written before the rename
public string Name { get; set; } = "";
}
// Inherited property (e.g. the Entity base timestamps, pre-0.3 names):
[ColumnAlias(nameof(Entity.CreatedAt), "Created")]
[ColumnAlias(nameof(Entity.UpdatedAt), "Modified")]
public sealed class LegacyCustomer : Entity { }
The canonical column wins unconditionally when both exist. Aliases cover the __Json/__GZip cell
variants and are validated eagerly (collisions and unknown targets throw on first use of the type).
Protected properties
Gate sensitive columns behind roles. Enforcement runs on the whole-entity update/upsert paths and
needs an IProtectedPropertyAuthorizer; if none is registered, changing a protected value is denied.
public sealed class Employee : Entity
{
public string Name { get; set; } = "";
[ProtectedProperty("admin,accountant")]
public decimal Salary { get; set; }
}
Provide an authorizer from your host (this is where the ClaimsPrincipal lives — kept out of the package
so it stays dependency-light):
public sealed class RoleAuthorizer(IHttpContextAccessor accessor) : IProtectedPropertyAuthorizer
{
public bool IsAllowed(string roles) =>
roles.Split(',', StringSplitOptions.TrimEntries | StringSplitOptions.RemoveEmptyEntries)
.Any(role => accessor.HttpContext?.User.IsInRole(role) == true);
}
builder.Services.AddHttpContextAccessor();
builder.Services.AddSingleton<IProtectedPropertyAuthorizer, RoleAuthorizer>();
For the builder path, protected properties are rejected unless you opt in after verifying authorization:
await storage.UpdateAsync(id, b => b.AllowProtected().SetProperty(x => x.Salary, 5000m));
Batch writes bypass protected-property enforcement (per-row reads would defeat the batch) — treat them as trusted server-side paths.
Serialization
TableStorage<T> uses TableEntitySerializer under the hood, but you can call it directly:
TableEntity row = customer.ToTableEntity(partitionKey, rowKey);
Customer back = row.FromTableEntity<Customer>();
- Scalars map to native cells; enums become strings;
decimalis stored asdouble. - Nested objects fan out to
Parent_Childcolumns. - Collections / complex graphs serialize to JSON (
__Jsoncolumn suffix), GZip-compressed (__GZip) when they exceed the cell limit. - Legacy tolerance — a stored date surfaced by the SDK as a
DateTimeor astringstill deserializes into aDateTimeOffset(orDateTime) property without throwing. - Set
persistType: trueto embed the type name and use the late-boundFromTableEntity()overload. TableEntitySerializer.FlattenPropertyis public for alternativeIStorage<T>implementations.
Id convention
Entity.Id is a composite string split on the first | (helpers: EntityId.Normalize,
EntityId.Split, EntityId.Combine):
Id |
PartitionKey | RowKey |
|---|---|---|
"eu|alice" |
eu |
alice |
"vision|exec|agent" |
vision |
exec|agent |
"single" |
single |
single |
Ids are normalized on write (trim → replace spaces with '-' → ToLowerInvariant). Id is also stored as
a data column, so the full composite id is preserved on read.
Testing with Unified.Data.Tables.InMemory
// In tests (or a dev/offline host):
services.AddUnifiedInMemoryStorage(); // open-generic IStorage<> → InMemoryStorage<>
var store = new InMemoryStorage<Customer>(); // or construct directly
await store.CreateAsync(new Customer { Id = "eu|alice" });
Assert.Equal(1, store.Count); // + Clear(), Snapshot() conveniences
The fake is deliberately faithful: rows round-trip through the REAL serializer (decimal-as-double,
enum-as-string, flattening, __Json/__GZip, 64 KB handling), duplicate CreateAsync throws 409,
updating a missing row throws 404, stale ETags throw 412 per ConcurrencyMode, deletes are idempotent,
and results arrive in lexical key order — so a green test against the fake means the same code holds
against Azure Tables.
Building & testing
dotnet build Unified.Data.Tables.slnx -c Release
dotnet test Unified.Data.Tables.slnx -c Release
The test suite mixes fast unit tests (Azure SDK mocked with NSubstitute) with integration tests that run
against a local Azurite emulator. The integration tests self-skip when Azurite is not reachable, so
dotnet test is safe to run anywhere.
License
Licensed under the MIT License. Copyright © Serhii Seletskyi.
| 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
- Unified.Data.Tables (>= 0.3.0)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.