Drop db legacy_variable_name

coder · mtojek · Jul 7, 2023 · Jul 7, 2023 · Jul 7, 2023 · Jul 7, 2023
commit cdd3c2f680b39f1f4980ed7202e68fbd7ee06a1c
diff --git a/coderd/database/dump.sql b/coderd/database/dump.sql
diff --git a/coderd/database/migrations/000135_drop_rich_parameter_legacy_variable.down.sql b/coderd/database/migrations/000135_drop_rich_parameter_legacy_variable.down.sql
@@ -0,0 +1,5 @@
+-- Unfortunately we can't bring back deleted values.
+
+ALTER TABLE template_version_parameters ADD COLUMN legacy_variable_name text NOT NULL DEFAULT '';
+
+COMMENT ON COLUMN template_version_parameters.legacy_variable_name IS 'Name of the legacy variable for migration purposes';
diff --git a/coderd/database/migrations/000135_drop_rich_parameter_legacy_variable.up.sql b/coderd/database/migrations/000135_drop_rich_parameter_legacy_variable.up.sql
@@ -0,0 +1 @@
+ALTER TABLE template_version_parameters DROP COLUMN legacy_variable_name;
diff --git a/coderd/database/models.go b/coderd/database/models.go
diff --git a/coderd/database/queries.sql.go b/coderd/database/queries.sql.go
diff --git a/coderd/database/queries/templateversionparameters.sql b/coderd/database/queries/templateversionparameters.sql
@@ -15,7 +15,6 @@ INSERT INTO
         validation_error,
         validation_monotonic,
         required,
-        legacy_variable_name,
         display_name,
         display_order
     )
@@ -36,8 +35,7 @@ VALUES
         $13,
         $14,
         $15,
-        $16,
-        $17
+        $16
     ) RETURNING *;
 
 -- name: GetTemplateVersionParameters :many
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		ALTER TABLE template_version_parameters DROP COLUMN legacy_variable_name;
Copy link Member mafredri Jul 7, 2023 • edited Loading Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. What could happen if legacy variables are still present when we upgrade? Should we somehow prevent this migration if any column has a non-empty value here? I'm not sure what we should do, but perhaps something like this (granted the condition is needed). DO $$ BEGIN RAISE 'Bad things will happen!'; END; $$ LANGUAGE plpgsql; Copy link Member Author mtojek Jul 7, 2023 Choose a reason for hiding this comment The reason will be displayed to describe this comment to others. Learn more. Legacy variable names are not used since 2 minor releases (v0.24.0, v0.25.0). I would assume that we can just drop the column :) Users who forgot to migrate workspaces will not benefit from the `legacy_variable_name` property.