Better back-compat comment [skip ci].

cylc · Aug 21, 2023 · 154ede5 · 154ede5
1 parent d6334f3
commit 154ede5
Showing 1 changed file with 7 additions and 1 deletion.
diff --git a/cylc/flow/rundb.py b/cylc/flow/rundb.py
@@ -179,7 +179,13 @@ class CylcWorkflowDAO:
     TABLE_BROADCAST_STATES = "broadcast_states"
     TABLE_INHERITANCE = "inheritance"
     TABLE_WORKFLOW_PARAMS = "workflow_params"
-    TABLE_SUITE_PARAMS = "suite_params"  # back compat
+    # BACK COMPAT: suite_params
+    # This Cylc 7 DB table is needed to allow workflow-state
+    # xtriggers (and the `cylc workflow-state` command) to
+    # work with Cylc 7 workflows.
+    # url: https://github.com/cylc/cylc-flow/issues/5236
+    # remove at: 8.x
+    TABLE_SUITE_PARAMS = "suite_params"
     TABLE_WORKFLOW_FLOWS = "workflow_flows"
     TABLE_WORKFLOW_TEMPLATE_VARS = "workflow_template_vars"
     TABLE_TASK_JOBS = "task_jobs"