You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/prepare-db-upgrade-downgrade.md
+7-5Lines changed: 7 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,15 +33,17 @@ The `description` field is a textual description of the aim of the step. Describ
33
33
operation in its actual direction: for example, a downgrade that removes a newly added
34
34
table should say that it removes the table.
35
35
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.
37
39
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.
39
41
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.
41
43
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.
43
45
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.
45
47
46
48
Choose compatibility independently for the upgrade and downgrade, because the two directions
0 commit comments