reporting

package

v2.10.1 Latest Latest Go to latest Published: Oct 9, 2026 License: Apache-2.0 Imports: 2 Imported by: 0

Documentation ¶

Overview ¶

Package reporting is the port for reports: tables over the record for people and BI tools. It is not the core. The engine knows nothing of it, and a deployment chooses an adapter, or none (docs/adr/0014): computed (from the engine's reads, on any store), postgres (views in the deployment's own database), or a distribution's own, such as a columnar warehouse fed from the event log.

Constants ¶

This section is empty.

Variables ¶

View Source

var ErrNoReport = errors.New("no such report")

ErrNoReport is a report the reporter does not answer.

View Source

var Standard = []string{"projects", "kpi-readings", "alignment", "teams"}

Standard names the reports every built-in reporter answers, with the same columns: the contract's list.

Functions ¶

This section is empty.

Types ¶

type Reporter ¶

type Reporter interface {
	// Names lists the reports it answers.
	Names() []string
	// Run computes one. An unknown name is ErrNoReport.
	Run(ctx context.Context, name string) (Table, error)
}

Reporter answers reports by name.

type Table ¶

type Table struct {
	Name    string
	Columns []string
	Rows    [][]any
}

Table is a report: named columns and rows of values in their order.

Source Files ¶

View all Source files

reporting.go

Directories ¶

Path	Synopsis
computed Package computed is the reporting adapter that works out each report when asked, from the engine's reads: no storage of its own, the same on every store (docs/adr/0014).	Package computed is the reporting adapter that works out each report when asked, from the engine's reads: no storage of its own, the same on every store (docs/adr/0014).
conformance Package conformance holds a reporting adapter to another's rows over the same record: every standard report, column for column, row for row, in any order.	Package conformance holds a reporting adapter to another's rows over the same record: every standard report, column for column, row for row, in any order.
postgres Package postgres is the reporting adapter that answers reports from views in the deployment's own Postgres (docs/adr/0014), so SQL and BI tools read the same rows the API serves.	Package postgres is the reporting adapter that answers reports from views in the deployment's own Postgres (docs/adr/0014), so SQL and BI tools read the same rows the API serves.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL