IF Commons GitHub

sql/extensions/convergence/settings

Written to: 2 requirements: 2 proved, 0 partly, 0 failing, 0 with no test recorded. 0019-sql-convergence FR-008, 0019-sql-convergence FR-011

The settings of the convergence strategy (commons data 0019-sql-convergence FR-008, FR-011): how a plan is approved, what may be applied with no one's approval, the ledger's table and the names the reader leaves out. Each has a default, and the default policy only adds.

Source: commons/data/sql/extensions/convergence/settings.ts

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

Convergenceinterfaceno test imports it
interface Convergence

The settings with every default filled.

MemberTypeWhat it is
approval"autonomous" | "reviewed"
policyPolicy
ledgerTablestring
ignorereadonly string[]
unmanaged"drop" | "hold"
ConvergenceSettingsinterfaceno test imports it
interface ConvergenceSettings

What a project says of convergence; what is not said is the default.

MemberTypeWhat it is
approval?"autonomous" | "reviewed"reviewed (the default) or autonomous.
policy?Partial<Policy>
ledgerTable?stringThe ledger's table; lifecycle_ledger by default.
ignore?readonly string[]The names of tables the reader leaves out, besides the ledger's.
unmanaged?"drop" | "hold"What to do with what is in the database and not in the model (a table, a column, an index or a constraint a person made): drop it, with approval (the default), or hold it, which leaves it alone and says so.
defaultPolicyconst
const defaultPolicy: Policy

The default policy: only what adds, and loses nothing.

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

Policyinterfaceno test imports it
interface Policy

What may be applied on first access with no one's approval.

MemberTypeWhat it is
enabledbooleanWhether autonomous convergence is on at all; where it is off every plan is held.
classesreadonly StepClass[]
reversibilitiesreadonly Reversibility[]
kindsreadonly string[]The kinds of change that may be applied: by default only those that add.

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