feat: check required form revision rangedatabase-migration

1 files changed, 18 insertions, 0 deletions

diff --git a/src/main/resources/dev/dnpm/oshelper/migration/README.md b/src/main/resources/dev/dnpm/oshelper/migration/README.md
new file mode 100644
index 0000000..14a530b
--- /dev/null
+++ b/src/main/resources/dev/dnpm/oshelper/migration/README.md
@@ -0,0 +1,18 @@
+# Format der Migrationsdateien
+
+Die Migrationsdateien sollen fortlaufend aufsteigend nummeriert sein, mit `.sql` enden.
+
+Zudem sollen sie immer Angaben zum betreffenden Formular und Revision enthalten:
+
+```sql
+-- form: DNPM Beispiel
+-- min-rev: 1
+-- max-rev: 2
+
+ALTER TABLE dk_dnpm_beispiel
+    MODIFY COLUMN langer_text text;
+```
+
+Ist keine Angabe zum Formularnamen angegeben, wird die Migration immer ausgeführt,
+anderenfalls nur für eine entsprechende Revision des angegebenen Formulars.
+Wenn nicht angegeben, ist die minimal erforderliche Revision ist standardmäßig 0, die maximale 99999999999999.
\ No newline at end of file