Skip to content

Commit ee3a225

Browse files
committed
Clarify compatibility for downgrade scripts
1 parent c76ba59 commit ee3a225

1 file changed

Lines changed: 7 additions & 5 deletions

File tree

docs/prepare-db-upgrade-downgrade.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,17 @@ The `description` field is a textual description of the aim of the step. Describ
3333
operation in its actual direction: for example, a downgrade that removes a newly added
3434
table should say that it removes the table.
3535

36-
The `compatibility` field takes one of four values:
36+
The `compatibility` field takes one of four values. In these definitions, the source schema is
37+
`old.dbscheme`, and the target schema is the other `.dbscheme` in the script directory. Thus,
38+
the source is the older schema for an upgrade and the newer schema for a downgrade.
3739

38-
* **full**: results from the upgraded snapshot will be identical to results from a snapshot built with the new version of the toolchain.
40+
* **full**: query results from the transformed database will be identical to results from a database built with the target version of the toolchain.
3941

40-
* **backwards**: the step is safe and preserves the meaning of the old database, but new features may not work correctly on the upgraded snapshot.
42+
* **backwards**: the step is safe and preserves the meaning of the source database, but features provided by the target query and library packs may not work correctly on the transformed database.
4143

42-
* **partial**: the step is safe and preserves the meaning of the old database, but you would get better results if you rebuilt the snapshot with the new version of the toolchain.
44+
* **partial**: the step is safe and preserves the meaning of the source database, but rebuilding the database with the target version of the toolchain would produce better results.
4345

44-
* **breaking**: the step is unsafe and will prevent certain queries from working.
46+
* **breaking**: the step is unsafe and will prevent certain target queries from working.
4547

4648
Choose compatibility independently for the upgrade and downgrade, because the two directions
4749
may preserve different amounts of information.

0 commit comments

Comments
 (0)