IF Commons GitHub

sql/typed/models/operations.auto

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

How a data platform is run and shown to be run

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

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

operations.WaitingRowinterface
interface WaitingRow

A precondition the work waits on, from whom, since when and by when it is needed: the waiting-on ledger, whose status is computed from its dates

MemberTypeWhat it is
waitingIdstringWhat identifies the wait
whatstringWhat is waited on
onWhomstringWho must give it
sinceTimestampSince when it is waited on
neededByTimestamp | nullBy when it is needed
status"cancelled" | "open" | "resolved"Where it is
resolvedAtTimestamp | nullWhen it came

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

operations.WaitingInsertinterface
interface WaitingInsert

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

MemberTypeWhat it is
waitingIdstring
whatstring
onWhomstring
sinceTimestamp
neededBy?Timestamp | null
status"cancelled" | "open" | "resolved"
resolvedAt?Timestamp | null

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

operations.WaitingKeytype
type WaitingKey = { readonly waitingId: string };

The key of a row of waiting.

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

operations.waitingconst
const waiting: Table<WaitingRow, WaitingInsert, "waiting">

A precondition the work waits on, from whom, since when and by when it is needed: the waiting-on ledger, whose status is computed from its dates

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

operations.DecisionRowinterface
interface DecisionRow

A decision that shaped the platform, with its context, what was decided and what follows from it, so that a later person finds out why and not only what

MemberTypeWhat it is
decisionIdstringWhat identifies the decision
titlestringWhat was decided, in a line
contextstringWhat made it necessary
outcomestringWhat was decided
consequencesstring | nullWhat follows from it
status"accepted" | "proposed" | "rejected" | "superseded"Where it is
decidedBystring | nullWho decided
decidedAtTimestamp | nullWhen
supersedesDecisionIdstring | nullThe decision this one replaced

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

operations.DecisionInsertinterface
interface DecisionInsert

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

MemberTypeWhat it is
decisionIdstring
titlestring
contextstring
outcomestring
consequences?string | null
status"accepted" | "proposed" | "rejected" | "superseded"
decidedBy?string | null
decidedAt?Timestamp | null
supersedesDecisionId?string | null

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

operations.DecisionKeytype
type DecisionKey = { readonly decisionId: string };

The key of a row of decision.

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

operations.decisionconst
const decision: Table<DecisionRow, DecisionInsert, "decision">

A decision that shaped the platform, with its context, what was decided and what follows from it, so that a later person finds out why and not only what

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

operations.LimitRowinterface
interface LimitRow

A certificate, key, quota, licence or agreement that runs out or fills, with when and who renews it: the inventory of what will stop the platform if nobody acts

MemberTypeWhat it is
limitIdstringWhat identifies the limit
namestringWhat it is
kind"agreement" | "certificate" | "credential" | "license" | "quota"What kind it is
expiresAtTimestamp | nullWhen it runs out
ownerstringWho renews it
renewalLeadDaysnumberHow many days before it runs out someone must act

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

operations.LimitInsertinterface
interface LimitInsert

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

MemberTypeWhat it is
limitIdstring
namestring
kind"agreement" | "certificate" | "credential" | "license" | "quota"
expiresAt?Timestamp | null
ownerstring
renewalLeadDaysnumber

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

operations.LimitKeytype
type LimitKey = { readonly limitId: string };

The key of a row of limit.

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

operations.limitconst
const limit: Table<LimitRow, LimitInsert, "limit">

A certificate, key, quota, licence or agreement that runs out or fills, with when and who renews it: the inventory of what will stop the platform if nobody acts

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

operations.DataCopyRowinterface
interface DataCopyRow

A copy of a dataset in a place, with why it exists, who answers for it and when it was last refreshed: what makes the copies of the data known and not only the original

MemberTypeWhat it is
dataCopyIdstringWhat identifies the copy
datasetstringThe dataset it is a copy of
locationstringWhere it is
purposestringWhy it exists
ownerstring | nullWho answers for it
classificationstringHow sensitive it is
refreshedAtTimestamp | nullWhen it was last refreshed

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

operations.DataCopyInsertinterface
interface DataCopyInsert

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

MemberTypeWhat it is
dataCopyIdstring
datasetstring
locationstring
purposestring
owner?string | null
classificationstring
refreshedAt?Timestamp | null

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

operations.DataCopyKeytype
type DataCopyKey = { readonly dataCopyId: string };

The key of a row of data_copy.

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

operations.dataCopyconst
const dataCopy: Table<DataCopyRow, DataCopyInsert, "dataCopy">

A copy of a dataset in a place, with why it exists, who answers for it and when it was last refreshed: what makes the copies of the data known and not only the original

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

operations.RuntimeEnvironmentRowinterface
interface RuntimeEnvironmentRow

An environment a release is promoted through, what it is for, whether it holds real data and who answers for it

MemberTypeWhat it is
runtimeEnvironmentIdstringWhat identifies the environment
namestringIts name
kind"development" | "production" | "staging" | "test"What it is for
holdsRealDatabooleanWhether it holds real data
ownerstringWho answers for it

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

operations.RuntimeEnvironmentInsertinterface
interface RuntimeEnvironmentInsert

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

MemberTypeWhat it is
runtimeEnvironmentIdstring
namestring
kind"development" | "production" | "staging" | "test"
holdsRealDataboolean
ownerstring

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

operations.RuntimeEnvironmentKeytype
type RuntimeEnvironmentKey = { readonly runtimeEnvironmentId: string };

The key of a row of runtime_environment.

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

operations.runtimeEnvironmentconst
const runtimeEnvironment: Table<RuntimeEnvironmentRow, RuntimeEnvironmentInsert, "runtimeEnvironment">

An environment a release is promoted through, what it is for, whether it holds real data and who answers for it

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

operations.ReleaseRowinterface
interface ReleaseRow

One version of an artifact (a pipeline, a model, a schema) that was cut for release, with when and what evidence it carries

MemberTypeWhat it is
releaseIdstringWhat identifies the release
artifactstringWhat was released
versionstringIts version
cutAtTimestampWhen it was cut
evidenceRefstring | nullThe test run or report that backs it

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

operations.ReleaseInsertinterface
interface ReleaseInsert

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

MemberTypeWhat it is
releaseIdstring
artifactstring
versionstring
cutAtTimestamp
evidenceRef?string | null

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

operations.ReleaseKeytype
type ReleaseKey = { readonly releaseId: string };

The key of a row of release.

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

operations.releaseconst
const release: Table<ReleaseRow, ReleaseInsert, "release">

One version of an artifact (a pipeline, a model, a schema) that was cut for release, with when and what evidence it carries

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

operations.PromotionRowinterface
interface PromotionRow

A release arriving in an environment, with who promoted it, when and the evidence: the promotion log, only ever added to

MemberTypeWhat it is
promotionIdstringWhat identifies the promotion
promotedBystringWho did it
promotedAtTimestampWhen
evidenceRefstring | nullThe evidence for it
releaseIdstringWhat was promoted
targetRuntimeEnvironmentIdstringWhere it went

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

operations.PromotionInsertinterface
interface PromotionInsert

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

MemberTypeWhat it is
promotionIdstring
promotedBystring
promotedAtTimestamp
evidenceRef?string | null
releaseIdstring
targetRuntimeEnvironmentIdstring

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

operations.PromotionKeytype
type PromotionKey = { readonly promotionId: string };

The key of a row of promotion.

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

operations.promotionconst
const promotion: Table<PromotionRow, PromotionInsert, "promotion">

A release arriving in an environment, with who promoted it, when and the evidence: the promotion log, only ever added to

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

operations.WorkloadRowinterface
interface WorkloadRow

A job, query set or service the platform runs, with who owns it, how often it runs and how critical it is: the register that capacity, cost and recovery are planned from

MemberTypeWhat it is
workloadIdstringWhat identifies the workload
namestringIts name
ownerstringWho owns it
schedulestringWhen it runs, in words or a cron
criticalitynumberHow critical it is, 1 the most

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

operations.WorkloadInsertinterface
interface WorkloadInsert

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

MemberTypeWhat it is
workloadIdstring
namestring
ownerstring
schedulestring
criticalitynumber

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

operations.WorkloadKeytype
type WorkloadKey = { readonly workloadId: string };

The key of a row of workload.

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

operations.workloadconst
const workload: Table<WorkloadRow, WorkloadInsert, "workload">

A job, query set or service the platform runs, with who owns it, how often it runs and how critical it is: the register that capacity, cost and recovery are planned from

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

operations.WorkloadStatementRowinterface
interface WorkloadStatementRow

A read-only statement of a workload with the number of rows and the hash of the rows it gave when it was recorded, to be replayed and compared

MemberTypeWhat it is
workloadStatementIdstringWhat identifies the statement
statementstringThe statement, a single select
baselineRowsnumberHow many rows it gave
baselineHashstringThe SHA-256 of the rows it gave
workloadIdstringThe workload it belongs to

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

operations.WorkloadStatementInsertinterface
interface WorkloadStatementInsert

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

MemberTypeWhat it is
workloadStatementIdstring
statementstring
baselineRowsnumber
baselineHashstring
workloadIdstring

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

operations.WorkloadStatementKeytype
type WorkloadStatementKey = { readonly workloadStatementId: string };

The key of a row of workload_statement.

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

operations.workloadStatementconst
const workloadStatement: Table<WorkloadStatementRow, WorkloadStatementInsert, "workloadStatement">

A read-only statement of a workload with the number of rows and the hash of the rows it gave when it was recorded, to be replayed and compared

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

operations.SignalRowinterface
interface SignalRow

A measurement the platform emits: its name, its kind, its unit and the attributes it carries, so that every emitter and every alert agree on what it is

MemberTypeWhat it is
signalIdstringWhat identifies the signal: its name
kind"counter" | "event" | "gauge" | "histogram"What kind of measurement
unitstringThe unit
attributeNamesstringThe attributes it carries, separated by commas
meaningstringWhat it measures
ownerstringWho answers for it

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

operations.SignalInsertinterface
interface SignalInsert

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

MemberTypeWhat it is
signalIdstring
kind"counter" | "event" | "gauge" | "histogram"
unitstring
attributeNamesstring
meaningstring
ownerstring

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

operations.SignalKeytype
type SignalKey = { readonly signalId: string };

The key of a row of signal.

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

operations.signalconst
const signal: Table<SignalRow, SignalInsert, "signal">

A measurement the platform emits: its name, its kind, its unit and the attributes it carries, so that every emitter and every alert agree on what it is

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

operations.FreshnessRuleRowinterface
interface FreshnessRuleRow

How old the latest load of a source may be before it is stale: the expectation that source freshness is held to

MemberTypeWhat it is
freshnessRuleIdstringWhat identifies the source
sourcestringThe source, as a load names it
maxAgeHoursnumberHow many hours old its latest load may be
ownerstringWho is told when it is stale

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

operations.FreshnessRuleInsertinterface
interface FreshnessRuleInsert

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

MemberTypeWhat it is
freshnessRuleIdstring
sourcestring
maxAgeHoursnumber
ownerstring

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

operations.FreshnessRuleKeytype
type FreshnessRuleKey = { readonly freshnessRuleId: string };

The key of a row of freshness_rule.

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

operations.freshnessRuleconst
const freshnessRule: Table<FreshnessRuleRow, FreshnessRuleInsert, "freshnessRule">

How old the latest load of a source may be before it is stale: the expectation that source freshness is held to

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

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