IF Commons GitHub

sql/typed/models/meaning.auto

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

What a value means and what its absence means

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

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

meaningnamespace
namespace meaning
meaning.MappingRowinterface
interface MappingRow

A source system's value mapped to the canonical value, with how the two relate, the rule it follows, who approved it and the dates between which it holds

MemberTypeWhat it is
mappingIdstringWhat identifies the mapping
sourceSystemstringThe system the value is from
sourceFieldstringThe field the value is of
sourceValuestringThe value as the source gives it
targetFieldstringThe canonical field
targetValuestring | nullThe canonical value; none where the relationship is unmapped
relationshipType"broader" | "equivalent" | "narrower" | "related" | "unmapped"How the two relate
rulestring | nullThe rule it follows, where it is more than a lookup
status"approved" | "draft" | "retired"Where it is in its approval
approvedBystring | nullWho approved it
approvedAtTimestamp | nullWhen it was approved
validFromTimestampFrom when it holds
validToTimestamp | nullUntil when it holds, where it ends

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

meaning.MappingInsertinterface
interface MappingInsert

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

MemberTypeWhat it is
mappingIdstring
sourceSystemstring
sourceFieldstring
sourceValuestring
targetFieldstring
targetValue?string | null
relationshipType"broader" | "equivalent" | "narrower" | "related" | "unmapped"
rule?string | null
status"approved" | "draft" | "retired"
approvedBy?string | null
approvedAt?Timestamp | null
validFromTimestamp
validTo?Timestamp | null

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

meaning.MappingKeytype
type MappingKey = { readonly mappingId: string };

The key of a row of mapping.

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

meaning.mappingconst
const mapping: Table<MappingRow, MappingInsert, "mapping">

A source system's value mapped to the canonical value, with how the two relate, the rule it follows, who approved it and the dates between which it holds

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

meaning.VarianceRowinterface
interface VarianceRow

A known difference between a source and the canonical form, with who decided to live with it and when that ends: a variance is accepted for a time and then expires

MemberTypeWhat it is
varianceIdstringWhat identifies the variance
subjectstringThe source and field it is about
descriptionstringWhat differs, in a sentence
status"accepted" | "expired" | "open" | "resolved"Where it is
ownerstringWho answers for it
decidedBystring | nullWho decided to accept it
decidedAtTimestamp | nullWhen it was decided
expiresAtTimestamp | nullWhen the acceptance ends

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

meaning.VarianceInsertinterface
interface VarianceInsert

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

MemberTypeWhat it is
varianceIdstring
subjectstring
descriptionstring
status"accepted" | "expired" | "open" | "resolved"
ownerstring
decidedBy?string | null
decidedAt?Timestamp | null
expiresAt?Timestamp | null

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

meaning.VarianceKeytype
type VarianceKey = { readonly varianceId: string };

The key of a row of variance.

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

meaning.varianceconst
const variance: Table<VarianceRow, VarianceInsert, "variance">

A known difference between a source and the canonical form, with who decided to live with it and when that ends: a variance is accepted for a time and then expires

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

meaning.NullRuleRowinterface
interface NullRuleRow

What a missing value is allowed to be for one field, the kind of absence it stands for and the default where it is replaced: the null policy of a field

MemberTypeWhat it is
nullRuleIdstringWhat identifies the rule: its table and column
subjectstringThe table and column it is about
policy"allow_absent" | "default_to" | "reject"What is done with a missing value
absence"invalid" | "not_applicable" | "not_collected" | "not_yet_known" | "refused" | "suppressed" | "unknown" | nullThe kind of absence a missing value is taken to be
defaultValuestring | nullThe default, where the policy is to replace
rationalestringWhy

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

meaning.NullRuleInsertinterface
interface NullRuleInsert

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

MemberTypeWhat it is
nullRuleIdstring
subjectstring
policy"allow_absent" | "default_to" | "reject"
absence?"invalid" | "not_applicable" | "not_collected" | "not_yet_known" | "refused" | "suppressed" | "unknown" | null
defaultValue?string | null
rationalestring

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

meaning.NullRuleKeytype
type NullRuleKey = { readonly nullRuleId: string };

The key of a row of null_rule.

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

meaning.nullRuleconst
const nullRule: Table<NullRuleRow, NullRuleInsert, "nullRule">

What a missing value is allowed to be for one field, the kind of absence it stands for and the default where it is replaced: the null policy of a field

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

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