Add migration functions

python/ribasim/ribasim/__init__.py

@@ -1,6 +1,6 @@
 __version__ = "2025.1.0"
 # Keep synced write_schema_version in ribasim_qgis/core/geopackage.py
-__schema_version__ = 3
+__schema_version__ = 4
 
 from ribasim.config import Allocation, Logging, Node, Solver
 from ribasim.geometry.edge import EdgeTable

python/ribasim/ribasim/migrations.py

@@ -90,3 +90,17 @@ def outletstaticschema_migration(df: DataFrame, schema_version: int) -> DataFram
         df.rename(columns={"min_crest_level": "min_upstream_level"}, inplace=True)
 
     return df
+
+
+for node_type in ["UserDemand", "LevelDemand", "FlowDemand"]:
+    for table_type in ["static", "time"]:
+
+        def migration_func(df: DataFrame, schema_version: int) -> DataFrame:
+            if schema_version < 4:
+                warnings.warn(
+                    f"Migrating outdated {node_type} / {table_type} table.", UserWarning
+                )
+                df.rename(columns={"priority": "demand_priority"}, inplace=True)
+            return df
+
+        globals()[f"{node_type.lower()}{table_type}_migration"] = migration_func

ribasim_qgis/core/geopackage.py

@@ -52,7 +52,7 @@ def layers(path: Path) -> list[str]:
 
 
 # Keep version synced __schema_version__ in ribasim/__init__.py
-def write_schema_version(path: Path, version: int = 3) -> None:
+def write_schema_version(path: Path, version: int = 4) -> None:
     """Write the schema version to the geopackage."""
     with sqlite3_cursor(path) as cursor:
         cursor.execute(