retrofit
0.14.0
retrofit.sh

Consents

A consent is an input that clears a refusal a verb would otherwise raise. Every consent is one spelling, naming one fact, in one kind, and the spelling is the same token on every verb that takes the fact. There are two kinds:

  • apply context: a standing fact about where the script runs. The flag takes no value.
  • sealed history: operations a Seal attested are rewritten. The side-effect arm (reconcile, import --force) is attested one Seal at a time, by opid: --allow-sealed-rewrite=<seal opid>, repeatable and comma-separated. A value attests the Seal it names and selects nothing; a Seal left unnamed refuses seal-removal-refused. The same kind, as the command’s own named act, is taken by op unseal, op truncate --drop-seals and schema remove (unless --keep-oplog), which take no spelling: the command is the attestation.

No consent is needed to emit an authored drop, whatever it drops. No consent is asked, either, for rows a rendered step loses (a down that drops a column written since, or narrows a type and rounds) or for a rule a rendered step re-imposes for PostgreSQL to check at apply; the render’s report and script name each.

The table below holds every consent and every outside row, each with its class. An outside row clears a refusal, or answers a warning as --allow-unnamed-label does, but accepts no fact of a kind above. The code holds the same table; a test checks this one against it.

Kind or classFact or what it doesSpellingVerbs
missing inputsupplies what the request left open; clears only the refusal naming it missing[directory_scope]config key
resource bounda project property bounding what a run readsdata_band_max_bytesconfig key
missing inputsupplies what the request left open; clears only the refusal naming it missingdefault_schemaconfig key
apply-context declarationdeclares where the script runs, selecting what the render emits; not a fact acceptedengine_versionconfig key
apply-context declarationdeclares where the script runs, selecting what the render emits; not a fact acceptedenvelopeconfig key
inverse polarityan opt-in refusal; turning it on adds a refusallock_timeoutconfig key
missing inputsupplies what the request left open; clears only the refusal naming it missingEDITORenvironment variable
starting-state attestationattests the cut the database is at, from which apply-risk is judged in place of the latest Seal; clears no refusalRETROFIT_DATABASE_ATenvironment variable
missing inputsupplies what the request left open; clears only the refusal naming it missingRETROFIT_NOEDITORenvironment variable
inverse polarityan opt-in refusal; turning it on adds a refusalRETROFIT_REQUIRE_EXPLICIT_SCHEMAenvironment variable
missing inputsupplies what the request left open; clears only the refusal naming it missingVISUALenvironment variable
missing inputsupplies what the request left open; clears only the refusal naming it missing--chdirevery verb (root flag)
missing inputsupplies what the request left open; clears only the refusal naming it missing--schemaevery verb that resolves a schema
ingest coveragecovers DDL retrofit cannot represent on ingest--allow-capability-gapsdrift
readers movedattests that the readers of the renamed table or column a value names are handled by the time the rename applies; answers the apply-risk-rename-in-use warning for that name, clears no refusal--allow-readers-moveddrift
starting-state attestationattests the cut the database is at, from which apply-risk is judged in place of the latest Seal; clears no refusal--database-atdrift
mode or selectorselects a mode or a subset of the run--ignore-dropsdrift
missing inputsupplies what the request left open; clears only the refusal naming it missing--interactivedrift
mode or selectorselects a mode or a subset of the run--on-questiondrift
ingest coveragecovers DDL retrofit cannot represent on ingest--allow-capability-gapsimport
readers movedattests that the readers of the renamed table or column a value names are handled by the time the rename applies; answers the apply-risk-rename-in-use warning for that name, clears no refusal--allow-readers-movedimport
starting-state attestationattests the cut the database is at, from which apply-risk is judged in place of the latest Seal; clears no refusal--database-atimport
mode or selectorselects a mode or a subset of the run--forceimport
corpus disposition at oplog replacementremoves the corpus records a replaced oplog orphans; attests no Seal--purge-orphaned-corpusimport
mode or selectorselects a mode or a subset of the run--forceinit
apply contextthe apply context owns atomicity--allow-external-atomicitymigrate
authored data-corpus contentaccepts authored data-corpus content, as shipped--allow-reading-replace-bodymigrate
authored data-corpus contentaccepts authored data-corpus content, as shipped--allow-stale-dmlmigrate
authored data-corpus contentaccepts authored data-corpus content, as shipped--allow-unclassified-dmlmigrate
dataset left unnamedattests that a labelled dataset is left out of the run on purpose; answers the not-named warning, clears no refusal--allow-unnamed-labelmigrate
authored data-corpus contentaccepts authored data-corpus content, as shipped--allow-unscreened-dmlmigrate
apply-context declarationdeclares where the script runs, selecting what the render emits; not a fact accepted--envelopemigrate
inverse polarityan opt-in refusal; turning it on adds a refusal--lock-timeoutmigrate
apply-context declarationdeclares where the script runs, selecting what the render emits; not a fact accepted--usingmigrate
readers movedattests that the readers of the renamed table or column a value names are handled by the time the rename applies; answers the apply-risk-rename-in-use warning for that name, clears no refusal--allow-readers-movedop add
starting-state attestationattests the cut the database is at, from which apply-risk is judged in place of the latest Seal; clears no refusal--database-atop add
readers movedattests that the readers of the renamed table or column a value names are handled by the time the rename applies; answers the apply-risk-rename-in-use warning for that name, clears no refusal--allow-readers-movedop revert
missing inputsupplies what the request left open; clears only the refusal naming it missing--interactiveop revise
mode or selectorselects a mode or a subset of the run--accept-dirtyreconcile
authored data-corpus contentaccepts authored data-corpus content, as shipped--allow-reading-replace-bodysnapshot
authored data-corpus contentaccepts authored data-corpus content, as shipped--allow-stale-dmlsnapshot
dataset left unnamedattests that a labelled dataset is left out of the run on purpose; answers the not-named warning, clears no refusal--allow-unnamed-labelsnapshot
mode or selectorselects a mode or a subset of the run--include-dropsnapshot
apply-context declarationdeclares where the script runs, selecting what the render emits; not a fact accepted--usingsnapshot
apply contextCI applies the range to a database before it lands--allow-database-applyvalidate
read-only gate dispositiona read-only gate reports without failing--allow-unmerged-forkvalidate
inverse polarityan opt-in refusal; turning it on adds a refusal--fail-on-apply-riskvalidate
sealed historyoperations a seal attested are rewritten--allow-sealed-rewritereconcile
sealed historyoperations a seal attested are rewritten--allow-sealed-rewriteimport
sealed historythe same, as the command’s named actnone: the commandop unseal, op truncate --drop-seals, schema remove (unless --keep-oplog)

Before 1.0, any release may change behavior; the release notes list what changed.

Published .