Skip to main content

Module quality_export

Module quality_export 

Source
Expand description

A Data Quality report written to a file: the measurements on screen, the setup they were measured with, and the source they were measured on. Built from the results in memory; writing one reads nothing from the data.

Two forms: versioned JSON for tools, with every measurement, and a short Markdown report for people. The JSON schema is documented in docs/reference/data-quality.md; a change that breaks a reader bumps REPORT_VERSION.

Structs§

CheckJson
ColumnCheckJson
ColumnIntentJson
ColumnJson
CoverageJson
DeclaredJson
The declared intent, as Setup holds it.
DuplicatesJson
ExpectedJson
ExportForm
The export dialog: where to write, and which form.
FindingJson
GapRunJson
GapsJson
The expected windows checked against the segments the run counted.
IntentJson
What the declared intent found.
IntervalJson
KeyJson
LocalCopyJson
ReadsJson
ReportFile
The report as JSON: REPORT_FORMAT, version REPORT_VERSION.
RunJson
What the run read and how far its numbers reach.
SampleJson
SegmentJson
SetupJson
The setup the report was measured with: every setting a run takes.
SourceIdentity
What a report was measured on, as far as datui can say without reading it: where the data came from, what the view did to it, and for a local file its size and modification time when the run began. No content hash: that would be a read.
TimeFormatJson
TimeRoleJson
UnavailableJson

Enums§

ReportFormat
Which form of the report to write.

Constants§

REPORT_FORMAT
What the JSON says it is, so a reader can tell it from any other JSON.
REPORT_VERSION
The JSON schema’s version. Fields may be added within a version; one removed, renamed or changed in meaning is a new version.

Functions§

render
The report in format, ready to write.
report_file
The report as ReportFile: built from results, measured with plan on results.source, at exported_at. Nothing here reads the data.
to_json
The JSON report, pretty-printed.
to_markdown
The report for people: what was measured on, the verdict and how far it reaches, the findings with their numbers and evidence, and the setup to run it again. file is the report results and plan make; what it holds as text is read from them, typed.
write
Write the report to path, replacing a file there only under Overwrite::Replace. The results are in memory: this writes, and reads nothing.