Primodel.Sdk
4.6.0
dotnet add package Primodel.Sdk --version 4.6.0
NuGet\Install-Package Primodel.Sdk -Version 4.6.0
<PackageReference Include="Primodel.Sdk" Version="4.6.0" />
<PackageVersion Include="Primodel.Sdk" Version="4.6.0" />
<PackageReference Include="Primodel.Sdk" />
paket add Primodel.Sdk --version 4.6.0
#r "nuget: Primodel.Sdk, 4.6.0"
#:package Primodel.Sdk@4.6.0
#addin nuget:?package=Primodel.Sdk&version=4.6.0
#tool nuget:?package=Primodel.Sdk&version=4.6.0
Primodel.Sdk
Write plugins for Primodel — the governed data platform that maps vendor systems to a canonical model.
A plugin is a normal .NET class library. It adds a source, a target, a format, a SQL dialect or a storage engine to a running Primodel instance, and it ships and upgrades on its own schedule: installing one does not mean redeploying the product.
dotnet add package Primodel.Sdk
A minimal plugin
Two pieces: an adapter, and a package that registers it under a key.
using System.Runtime.InteropServices;
using Primodel.Sdk.Adapters;
using Primodel.Sdk.Jobs;
using Primodel.Sdk.Plugins;
using Primodel.Sdk.Records;
// Settings are yours. They arrive as the flow author wrote them, secrets already resolved.
public sealed class GreetingSettings
{
public string Name { get; set; } = "world";
public int Count { get; set; } = 1;
}
public sealed class GreetingSource : IRecordSourceAdapter<GreetingSettings>
{
public async IAsyncEnumerable<RecordBatch> ReadAsync(
GreetingSettings settings, IRecordContextPool pool, IJobContext context)
{
var records = new RecordContext[settings.Count];
for (var i = 0; i < settings.Count; i++)
{
var record = pool.Rent();
record.SetString("greeting", $"hello {settings.Name}".AsMemory());
records[i] = record;
}
yield return new RecordBatch(records, records.Length);
await Task.CompletedTask;
}
}
public sealed class GreetingPlugin : IPluginPackage
{
public string Id => "primodel-greeting"; // must match your assembly name
public string Version => "1.0.0";
public IReadOnlyCollection<Architecture> SupportedArchitectures => []; // empty = fully managed
public PluginActivationMode ActivationMode => PluginActivationMode.Hot;
public void Register(IPluginRegistrationContext context) =>
context.Catalog.RegisterRecordSource<GreetingSource, GreetingSettings>("greeting");
}
A flow step naming "greeting" now runs your adapter.
The package id and the assembly name must match. The loader resolves a package's entry assembly as
{id}.dll, so a mismatch produces a plugin that installs, verifies, activates — and never loads.
What you can contribute
| Register as | You implement | For |
|---|---|---|
RegisterRecordSource |
IRecordSourceAdapter<T> |
reading records from a system |
RegisterRecordTarget |
IRecordTargetAdapter<T> |
writing records to one |
RegisterSource / RegisterTarget |
ISourceAdapter<T> / ITargetAdapter<T> |
moving raw bytes |
RegisterSourceFormat / RegisterTargetFormat |
ISourceFormatAdapter<T> / ITargetFormatAdapter<T> |
parsing and serializing a format |
RegisterRecordTransform / RegisterRawTransform |
the matching transform interface | reshaping records or bytes mid-flow |
Beyond adapters, IPluginRegistrationContext also takes a SQL dialect, a materialize writer, a stream source
provider, a lake provider and a delivery target connection — enough to add a database engine, an object store,
or an outbound event broker the product has never heard of.
What the host gives you
A plugin never calls back into Primodel. It asks, through interfaces the SDK declares and the host implements, and takes them by constructor injection:
IEgressServices— vet and dial any host a flow's settings name. Use it. An endpoint written into a flow is attacker-reachable in a way a registered connection is not, and this is what applies the operator's allowlist and the cloud-metadata exclusion.ISourceFormatCatalog— parse bytes as whatever format is registered under a key, including formats installed after your plugin shipped.ITradingPartnerEnvelopes— resolve a registered trading partner and allocate its next EDI control numbers.IJobContext— cancellation, paging, quarantine for records you cannot parse.
Testing
dotnet add package Primodel.Sdk.TestKit
Test doubles for the host side — a job context, a recording catalog to assert what your package registers, a source harness that drains an adapter, and stubs for the services above. It tracks the SDK version exactly.
Support and versioning
Pre-release. The SDK is at 0.1.0-alpha, and until 1.0 a contract can change between versions. Pin an
exact version and expect to recompile when you move. Semantic versioning applies from 1.0.
Issues and questions: github.com/Wadman-IT/Primodel-SDK. Design notes on what belongs in this contract and why are in docs/design.md.
Licence
Apache-2.0. This SDK is the contract you build against and is deliberately open; Primodel itself and its first-party plugin packages are separately licensed commercial software.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net11.0 is compatible. |
-
net11.0
- CloudMesh.Core (>= 2.0.107)
- CloudMesh.Variant (>= 2.0.107)
- System.IO.Hashing (>= 11.0.0)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on Primodel.Sdk:
| Package | Downloads |
|---|---|
|
Primodel.Sdk.TestKit
Test doubles for authoring Primodel plugins. |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last Updated |
|---|---|---|
| 4.6.0 | 205 | 11/19/2026 |
| 4.5.0 | 59 | 11/19/2026 |
| 4.4.0 | 144 | 11/18/2026 |
| 4.3.0 | 100 | 11/18/2026 |
| 4.2.0 | 156 | 11/17/2026 |
| 4.1.2 | 62 | 11/17/2026 |
| 4.1.1 | 67 | 11/17/2026 |
| 4.1.0 | 126 | 11/17/2026 |
| 4.0.0 | 137 | 11/16/2026 |
| 3.1.2 | 732 | 11/12/2026 |
| 3.1.1 | 207 | 11/9/2026 |
| 3.1.0 | 100 | 11/9/2026 |
| 3.0.0 | 1,159 | 10/31/2026 |
| 2.4.0 | 194 | 10/30/2026 |
| 2.3.0 | 236 | 10/26/2026 |
| 2.2.0 | 199 | 10/26/2026 |
| 2.1.0 | 850 | 10/3/2026 |
| 2.0.0 | 251 | 10/1/2026 |
| 1.1.1 | 196 | 9/25/2026 |