reportArtifactsfunctionfunction reportArtifacts(input: ReportInput): readonly Artifact[]The report as files: Markdown and JSON.
| Parameter | What it is |
|---|---|
input | what the report is made from |
Returns: the two files
The plan report (commons data 0016-sql-plan-report): what a plan does, in the words of governance. It is made from a plan and the logical schemas before and after it, and is the same text every time: a summary, a table of steps with the lock each takes, what governance says of what each step touches, what governance itself changes, who has to approve and why, and what is new.
reportArtifactsfunctionfunction reportArtifacts(input: ReportInput): readonly Artifact[]The report as files: Markdown and JSON.
| Parameter | What it is |
|---|---|
input | what the report is made from |
Returns: the two files
reportDatafunctionfunction reportData(input: ReportInput): ReportDataThe report of a plan, as data.
| Parameter | What it is |
|---|---|
input | the plan, the schemas, the dialect and the settings |
Returns: the report
reportMarkdownfunctionfunction reportMarkdown(d: ReportData): stringThe report as Markdown.
Approverinterfaceno test imports itinterface ApproverA role that has to approve a step, and why.
| Member | Type | What it is |
|---|---|---|
role | string | |
because | string |
ElementGovernanceinterfaceno test imports itinterface ElementGovernanceWhat governance says of one element a step is made from.
| Member | Type | What it is |
|---|---|---|
element | string | |
personal? | { readonly category?: string | undefined; readonly class?: string | undefined; readonly purposes: readonly string[]; } | |
classification? | string | |
access? | { readonly read: readonly string[]; readonly write: readonly string[]; } | |
scope? | string | |
mask? | string | |
retentionDays? | number | |
cites | readonly string[] |
GovernanceChangeinterfaceno test imports itinterface GovernanceChangeA change of what governance says.
| Member | Type | What it is |
|---|---|---|
element | string | |
annotation | string | |
change | "added" | "changed" | "removed" | |
before? | unknown | |
after? | unknown |
ReportDatainterfaceno test imports itinterface ReportDataThe report as data.
| Member | Type | What it is |
|---|---|---|
domain | string | |
dialect | string | |
from | string | |
to | string | |
counts | { readonly steps: number; readonly byClass: Readonly<Record<string, number>>; readonly byReversibility: Readonly<Record<string, number>>; readonly byIdempotency: Readonly<Record<string, number>>; } | |
steps | readonly StepReport[] | |
governanceChanges | readonly GovernanceChange[] | null | What governance changes between the schemas; none where the schema before was not given. |
added | readonly { readonly element: string; readonly description: string; }[] | |
approvals | readonly { readonly role: string; readonly steps: readonly number[]; }[] |
ReportInputinterfaceno test imports itinterface ReportInputWhat a report is made from.
| Member | Type | What it is |
|---|---|---|
plan | Plan | |
before? | LogicalSchema | The logical schema the database was made from; none for an empty database or where it is not known. |
after | LogicalSchema | |
dialect | Dialect | |
naming? | Naming | |
settings? | ReportSettings |
StepReportinterfaceno test imports itinterface StepReportWhat the report says of one step.
| Member | Type | What it is |
|---|---|---|
number | number | |
name | string | |
kind | string | |
key | string | |
class | string | |
why? | string | |
reversibility | string | |
idempotency? | string | |
lock | string | |
elements | readonly ElementGovernance[] | |
approvers | readonly Approver[] |