PlatenReports.Sql 0.0.0

There is a newer prerelease version of this package available.
See the version list below for details.
dotnet add package PlatenReports.Sql --version 0.0.0
                    
NuGet\Install-Package PlatenReports.Sql -Version 0.0.0
                    
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="PlatenReports.Sql" Version="0.0.0" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="PlatenReports.Sql" Version="0.0.0" />
                    
Directory.Packages.props
<PackageReference Include="PlatenReports.Sql" />
                    
Project file
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 PlatenReports.Sql --version 0.0.0
                    
#r "nuget: PlatenReports.Sql, 0.0.0"
                    
#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 PlatenReports.Sql@0.0.0
                    
#: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=PlatenReports.Sql&version=0.0.0
                    
Install as a Cake Addin
#tool nuget:?package=PlatenReports.Sql&version=0.0.0
                    
Install as a Cake Tool

Platen Reports

JSON-defined, SQL-driven PDF reporting for .NET, with a graphical designer.

Named for the platen — the plate in a press that pushes paper against the type.

Status: 0.x, pre-release. Nothing here is stable yet. Minor versions may break. See docs/versioning.md.

What it is

A report is a JSON definition: a tree of containers, rows, columns, tables and fields, bound to data. The engine loads a definition, pulls its data through a provider, and renders a PDF. The designer is a React component that edits those definitions visually.

Data reaches the engine through one port — IReportDataProvider.LoadAsync, returning a nested Dictionary<string, object?>. The engine itself touches no database, no ORM, and no SQL. Whatever can fill that dictionary can drive a report.

Package Registry What
PlatenReports.Core NuGet Definition model, binding, rendering pipeline
PlatenReports.Sql NuGet SQL data provider
PlatenReports.Pdf NuGet PDF layout + output
@platen-reports/designer npm React report designer

All packages in this repository share one version and are released in lockstep. Equal versions are conformant — pin both sides to the same number.

Non-goals

These are out of scope by decision, not by omission. Scope creep into a general reporting product is this project's top risk, and the list exists so that "couldn't we also…" has a standing answer.

  • No charts. No bar, line, or pie rendering. Reports are documents.
  • No banded reports. No report/group/detail band model — the layout is a container tree, not a banded canvas, and the two do not merge cleanly.
  • No scheduler. Nothing here runs reports on a timer, queues them, or mails them. That is the host's job, and every host already has one.
  • No free-positioning canvas. The designer edits a flow layout. Absolute x/y placement is not coming; it makes definitions unmaintainable across page sizes and locales.
  • No joins in definitions. A definition names a query; it does not compose one. Relational work belongs in SQL, authored in files, reviewed like code.

A feature request that needs one of these is not a small change to Platen Reports — it is a different product.

Licence

Apache-2.0. See LICENSE, NOTICE, and THIRD-PARTY-NOTICES.md.

Extracted from the Uptimiq CMMS codebase and relicensed by the copyright holder — see PROVENANCE.md.

Documentation

Product 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

    • No dependencies.

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-alpha.6 43 8/21/2026
0.1.0-alpha.5 56 8/19/2026
0.0.0 88 8/12/2026