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.
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
| Member | Type | What it is |
|---|
waitingId | string | What identifies the wait |
what | string | What is waited on |
onWhom | string | Who must give it |
since | Timestamp | Since when it is waited on |
neededBy | Timestamp | null | By when it is needed |
status | "cancelled" | "open" | "resolved" | Where it is |
resolvedAt | Timestamp | null | When it came |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
interface WaitingInsert
What an insert into waiting takes: what the database fills may be left out.
| Member | Type | What it is |
|---|
waitingId | string | |
what | string | |
onWhom | string | |
since | Timestamp | |
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
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
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
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
| Member | Type | What it is |
|---|
decisionId | string | What identifies the decision |
title | string | What was decided, in a line |
context | string | What made it necessary |
outcome | string | What was decided |
consequences | string | null | What follows from it |
status | "accepted" | "proposed" | "rejected" | "superseded" | Where it is |
decidedBy | string | null | Who decided |
decidedAt | Timestamp | null | When |
supersedesDecisionId | string | null | The decision this one replaced |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
interface DecisionInsert
What an insert into decision takes: what the database fills may be left out.
| Member | Type | What it is |
|---|
decisionId | string | |
title | string | |
context | string | |
outcome | string | |
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
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
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
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
| Member | Type | What it is |
|---|
limitId | string | What identifies the limit |
name | string | What it is |
kind | "agreement" | "certificate" | "credential" | "license" | "quota" | What kind it is |
expiresAt | Timestamp | null | When it runs out |
owner | string | Who renews it |
renewalLeadDays | number | How many days before it runs out someone must act |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
interface LimitInsert
What an insert into limit takes: what the database fills may be left out.
| Member | Type | What it is |
|---|
limitId | string | |
name | string | |
kind | "agreement" | "certificate" | "credential" | "license" | "quota" | |
expiresAt? | Timestamp | null | |
owner | string | |
renewalLeadDays | number | |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
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
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
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
| Member | Type | What it is |
|---|
dataCopyId | string | What identifies the copy |
dataset | string | The dataset it is a copy of |
location | string | Where it is |
purpose | string | Why it exists |
owner | string | null | Who answers for it |
classification | string | How sensitive it is |
refreshedAt | Timestamp | null | When it was last refreshed |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
interface DataCopyInsert
What an insert into data_copy takes: what the database fills may be left out.
| Member | Type | What it is |
|---|
dataCopyId | string | |
dataset | string | |
location | string | |
purpose | string | |
owner? | string | null | |
classification | string | |
refreshedAt? | Timestamp | null | |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
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
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
interface RuntimeEnvironmentRow
An environment a release is promoted through, what it is for, whether it holds real data and who answers for it
| Member | Type | What it is |
|---|
runtimeEnvironmentId | string | What identifies the environment |
name | string | Its name |
kind | "development" | "production" | "staging" | "test" | What it is for |
holdsRealData | boolean | Whether it holds real data |
owner | string | Who answers for it |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
interface RuntimeEnvironmentInsert
What an insert into runtime_environment takes: what the database fills may be left out.
| Member | Type | What it is |
|---|
runtimeEnvironmentId | string | |
name | string | |
kind | "development" | "production" | "staging" | "test" | |
holdsRealData | boolean | |
owner | string | |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
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
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
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
| Member | Type | What it is |
|---|
releaseId | string | What identifies the release |
artifact | string | What was released |
version | string | Its version |
cutAt | Timestamp | When it was cut |
evidenceRef | string | null | The test run or report that backs it |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
interface ReleaseInsert
What an insert into release takes: what the database fills may be left out.
| Member | Type | What it is |
|---|
releaseId | string | |
artifact | string | |
version | string | |
cutAt | Timestamp | |
evidenceRef? | string | null | |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
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
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
interface PromotionRow
A release arriving in an environment, with who promoted it, when and the evidence: the promotion log, only ever added to
| Member | Type | What it is |
|---|
promotionId | string | What identifies the promotion |
promotedBy | string | Who did it |
promotedAt | Timestamp | When |
evidenceRef | string | null | The evidence for it |
releaseId | string | What was promoted |
targetRuntimeEnvironmentId | string | Where it went |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
interface PromotionInsert
What an insert into promotion takes: what the database fills may be left out.
| Member | Type | What it is |
|---|
promotionId | string | |
promotedBy | string | |
promotedAt | Timestamp | |
evidenceRef? | string | null | |
releaseId | string | |
targetRuntimeEnvironmentId | string | |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
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
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
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
| Member | Type | What it is |
|---|
workloadId | string | What identifies the workload |
name | string | Its name |
owner | string | Who owns it |
schedule | string | When it runs, in words or a cron |
criticality | number | How critical it is, 1 the most |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
interface WorkloadInsert
What an insert into workload takes: what the database fills may be left out.
| Member | Type | What it is |
|---|
workloadId | string | |
name | string | |
owner | string | |
schedule | string | |
criticality | number | |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
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
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
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
| Member | Type | What it is |
|---|
workloadStatementId | string | What identifies the statement |
statement | string | The statement, a single select |
baselineRows | number | How many rows it gave |
baselineHash | string | The SHA-256 of the rows it gave |
workloadId | string | The workload it belongs to |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
interface WorkloadStatementInsert
What an insert into workload_statement takes: what the database fills may be left out.
| Member | Type | What it is |
|---|
workloadStatementId | string | |
statement | string | |
baselineRows | number | |
baselineHash | string | |
workloadId | string | |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
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
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
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
| Member | Type | What it is |
|---|
signalId | string | What identifies the signal: its name |
kind | "counter" | "event" | "gauge" | "histogram" | What kind of measurement |
unit | string | The unit |
attributeNames | string | The attributes it carries, separated by commas |
meaning | string | What it measures |
owner | string | Who answers for it |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
interface SignalInsert
What an insert into signal takes: what the database fills may be left out.
| Member | Type | What it is |
|---|
signalId | string | |
kind | "counter" | "event" | "gauge" | "histogram" | |
unit | string | |
attributeNames | string | |
meaning | string | |
owner | string | |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
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
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
interface FreshnessRuleRow
How old the latest load of a source may be before it is stale: the expectation that source freshness is held to
| Member | Type | What it is |
|---|
freshnessRuleId | string | What identifies the source |
source | string | The source, as a load names it |
maxAgeHours | number | How many hours old its latest load may be |
owner | string | Who is told when it is stale |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
interface FreshnessRuleInsert
What an insert into freshness_rule takes: what the database fills may be left out.
| Member | Type | What it is |
|---|
freshnessRuleId | string | |
source | string | |
maxAgeHours | number | |
owner | string | |
Imported by 28 tests of the run (28 passed, 0 failed): the library's results
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
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