IF Commons GitHub

sql/typed/models/proof.auto

The typed tables of the proof model, generated by IFC Data from the model. Do not edit: change the model and run bun tools/typed.ts --write.

The proof that a platform can be put right and that its figures are right

Source: commons/data/sql/typed/models/proof.auto.ts

20 of 20 exports are imported by a test of the run. A test that imports an export may not call it or check what it returns.

proofnamespace
namespace proof
proof.DrillRowinterface
interface DrillRow

One drill of a recovery: what was tested (a replay, a rollback or a restore), against which load or scope, how long it took, what it found and the evidence, so that a recovery is shown and not assumed

MemberTypeWhat it is
drillIdstringWhat identifies the drill
kind"replay" | "restore" | "rollback"What it tested
scopestringWhat it was done to: a load id, a table or a store
startedAtTimestampWhen it began
secondsnumberHow long it took, in whole seconds
outcome"abandoned" | "failed" | "passed"What it found
beforeHashstring | nullThe hash of what was there before
afterHashstring | nullThe hash of what was there after
evidencestring | nullWhere the evidence is kept

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.DrillInsertinterface
interface DrillInsert

What an insert into drill takes: what the database fills may be left out.

MemberTypeWhat it is
drillIdstring
kind"replay" | "restore" | "rollback"
scopestring
startedAtTimestamp
secondsnumber
outcome"abandoned" | "failed" | "passed"
beforeHash?string | null
afterHash?string | null
evidence?string | null

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.DrillKeytype
type DrillKey = { readonly drillId: string };

The key of a row of drill.

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.drillconst
const drill: Table<DrillRow, DrillInsert, "drill">

One drill of a recovery: what was tested (a replay, a rollback or a restore), against which load or scope, how long it took, what it found and the evidence, so that a recovery is shown and not assumed

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.CalculationRunRowinterface
interface CalculationRunRow

One run of a calculation: its name and version, the parameters it ran with, the hash of its inputs and of its outputs and how many rows it gave, so that a figure can be reproduced and a change of one shown

MemberTypeWhat it is
calculationRunIdstringWhat identifies the run
calculationstringThe calculation
versionstringIts version
parametersstring | nullThe parameters it ran with, as JSON
inputHashstringThe SHA-256 of its inputs
outputHashstringThe SHA-256 of its outputs
rowsnumberHow many rows it gave
ranAtTimestampWhen
loadIdstring | nullThe load it was run for, where it was

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.CalculationRunInsertinterface
interface CalculationRunInsert

What an insert into calculation_run takes: what the database fills may be left out.

MemberTypeWhat it is
calculationRunIdstring
calculationstring
versionstring
parameters?string | null
inputHashstring
outputHashstring
rowsnumber
ranAtTimestamp
loadId?string | null

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.CalculationRunKeytype
type CalculationRunKey = { readonly calculationRunId: string };

The key of a row of calculation_run.

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.calculationRunconst
const calculationRun: Table<CalculationRunRow, CalculationRunInsert, "calculationRun">

One run of a calculation: its name and version, the parameters it ran with, the hash of its inputs and of its outputs and how many rows it gave, so that a figure can be reproduced and a change of one shown

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.ReferenceCaseRowinterface
interface ReferenceCaseRow

A case with inputs and the value a calculation must give for them, found by hand or from a source that is trusted, with how close it must be: what a calculation is held to

MemberTypeWhat it is
referenceCaseIdstringWhat identifies the case
calculationstringThe calculation it is for
descriptionstringWhat the case shows
inputsstringThe inputs, as JSON
expectedstringThe value it must give, as a number
tolerancestringHow far it may be from the value, as a number: 0 for exact
sourcestringWhere the value comes from

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.ReferenceCaseInsertinterface
interface ReferenceCaseInsert

What an insert into reference_case takes: what the database fills may be left out.

MemberTypeWhat it is
referenceCaseIdstring
calculationstring
descriptionstring
inputsstring
expectedstring
tolerancestring
sourcestring

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.ReferenceCaseKeytype
type ReferenceCaseKey = { readonly referenceCaseId: string };

The key of a row of reference_case.

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.referenceCaseconst
const referenceCase: Table<ReferenceCaseRow, ReferenceCaseInsert, "referenceCase">

A case with inputs and the value a calculation must give for them, found by hand or from a source that is trusted, with how close it must be: what a calculation is held to

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.LineageEdgeRowinterface
interface LineageEdgeRow

A dataset that another is made from, by which transform, so that what a change reaches and what a figure came from can both be found

MemberTypeWhat it is
lineageEdgeIdstringWhat identifies the edge
fromDatasetstringThe dataset it is made from
toDatasetstringThe dataset that is made
viastringThe transform or workload that makes it

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.LineageEdgeInsertinterface
interface LineageEdgeInsert

What an insert into lineage_edge takes: what the database fills may be left out.

MemberTypeWhat it is
lineageEdgeIdstring
fromDatasetstring
toDatasetstring
viastring

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.LineageEdgeKeytype
type LineageEdgeKey = { readonly lineageEdgeId: string };

The key of a row of lineage_edge.

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.lineageEdgeconst
const lineageEdge: Table<LineageEdgeRow, LineageEdgeInsert, "lineageEdge">

A dataset that another is made from, by which transform, so that what a change reaches and what a figure came from can both be found

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.EntityLinkRowinterface
interface EntityLinkRow

A record of one source linked to an entity that other sources also hold, with the rule that found it and the score, so that who is the same person or thing is a fact with a reason and not a guess

MemberTypeWhat it is
entityLinkIdstringWhat identifies the link: the source and the key of its record
entityIdstringThe entity it is linked to
sourcestringThe source
sourceKeystringThe key of the record in the source
rule"confirmed" | "exact" | "normalized" | "similar"How it was found
scorestringHow sure, as a number from 0 to 1

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.EntityLinkInsertinterface
interface EntityLinkInsert

What an insert into entity_link takes: what the database fills may be left out.

MemberTypeWhat it is
entityLinkIdstring
entityIdstring
sourcestring
sourceKeystring
rule"confirmed" | "exact" | "normalized" | "similar"
scorestring

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.EntityLinkKeytype
type EntityLinkKey = { readonly entityLinkId: string };

The key of a row of entity_link.

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

proof.entityLinkconst
const entityLink: Table<EntityLinkRow, EntityLinkInsert, "entityLink">

A record of one source linked to an entity that other sources also hold, with the rule that found it and the score, so that who is the same person or thing is a fact with a reason and not a guess

Imported by 7 tests of the run (7 passed, 0 failed): the library's results

Titles, headings, exports, tables, columns and requirements. Esc closes.