DtPipe.Core
1.1.1
dotnet add package DtPipe.Core --version 1.1.1
NuGet\Install-Package DtPipe.Core -Version 1.1.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="DtPipe.Core" Version="1.1.1" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="DtPipe.Core" Version="1.1.1" />
<PackageReference Include="DtPipe.Core" />
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 DtPipe.Core --version 1.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: DtPipe.Core, 1.1.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 DtPipe.Core@1.1.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=DtPipe.Core&version=1.1.1
#tool nuget:?package=DtPipe.Core&version=1.1.1
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
DtPipe.Core
The core pipeline engine for DtPipe. Contains all abstractions, models, and pipeline logic with no external dependencies beyond Microsoft.Extensions.Logging.Abstractions.
Suitable for use as a standalone NuGet package in custom ETL pipelines.
Package
<PackageReference Include="DtPipe.Core" Version="1.0.0" />
What's Inside
DtPipe.Core/
├── Abstractions/ # Core interfaces
├── Models/ # Shared data models (PipeColumnInfo, etc.)
├── Options/ # IOptionSet, IQueryAwareOptions, IKeyAwareOptions, OptionsRegistry
├── Attributes/ # [CliOption] attribute
├── Dialects/ # ISqlDialect, SQL generation helpers
├── Helpers/ # Shared utility helpers
├── Pipelines/ # TransformerPipelineBuilder
├── Resilience/ # Retry policy
├── Security/ # SQL query validator
└── PipelineEngine.cs # Main export orchestration engine
Key Abstractions
| Interface | Purpose |
|---|---|
IStreamReader |
Reads rows as async batches from a source |
IStreamReaderFactory |
Creates IStreamReader instances |
IDataWriter |
Writes rows to a destination |
IDataWriterFactory |
Creates IDataWriter instances |
IDataTransformer |
Transforms a batch of rows in the pipeline |
IDataTransformerFactory |
Creates IDataTransformer instances |
IProviderDescriptor<T> |
Describes a provider: name, options type, factory method |
ISchemaInspector |
Introspects target schema |
ISchemaMigrator |
Applies schema migrations (auto-migrate) |
ISqlDialect |
Generates provider-specific DDL/DML SQL |
ITypeMapper |
Maps CLR types to provider-specific column types |
Key Options Interfaces
| Interface | Purpose |
|---|---|
IOptionSet |
Base contract for all Options classes |
IQueryAwareOptions |
Implement on reader options to receive the global --query |
IKeyAwareOptions |
Implement on writer options to receive the global --key |
Implementing a Custom Reader
// 1. Define options
public record MyReaderOptions : IProviderOptions, IQueryAwareOptions
{
public static string Prefix => "mydb";
public static string DisplayName => "MyDB Reader";
public string? Query { get; set; }
}
// 2. Implement IStreamReader
public class MyStreamReader : IStreamReader
{
public IReadOnlyList<PipeColumnInfo>? Columns { get; private set; }
public Task OpenAsync(CancellationToken ct) { ... }
public IAsyncEnumerable<ReadOnlyMemory<object?[]>> ReadBatchesAsync(int batchSize, CancellationToken ct) { ... }
public ValueTask DisposeAsync() { ... }
}
// 3. Implement IProviderDescriptor<IStreamReader>
public class MyReaderDescriptor : IProviderDescriptor<IStreamReader>
{
public string ProviderName => "mydb";
public Type OptionsType => typeof(MyReaderOptions);
public bool RequiresQuery => true;
public bool CanHandle(string cs) => cs.StartsWith("mydb:");
public IStreamReader Create(string cs, object options, IServiceProvider sp)
=> new MyStreamReader(cs, ((MyReaderOptions)options).Query!);
}
Running the Pipeline Directly
var engine = new PipelineEngine(loggerFactory);
await engine.RunExportAsync(options, ct, transformers, readerFactory, writerFactory, registry);
License
MIT
| 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. |
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.
-
net10.0
- Microsoft.Extensions.Logging.Abstractions (>= 10.0.3)
NuGet packages (1)
Showing the top 1 NuGet packages that depend on DtPipe.Core:
| Package | Downloads |
|---|---|
|
DtPipe.Adapters
Database and file adapters for DtPipe.Core (PostgreSQL, Oracle, SQL Server, SQLite, DuckDB, CSV, Parquet, JsonL, Apache Arrow). |
GitHub repositories
This package is not used by any popular GitHub repositories.