Preferences: Use dashboard uid for the home dashboard (#106666)

This commit is contained in:
Stephanie Hingtgen
2025-06-13 07:10:44 -05:00
committed by GitHub
parent 4c2bfe8263
commit 352aac162c
16 changed files with 303 additions and 177 deletions
@@ -1,7 +1,10 @@
package migrations
import (
"fmt"
. "github.com/grafana/grafana/pkg/services/sqlstore/migrator"
"github.com/grafana/grafana/pkg/util/xorm"
)
func addPreferencesMigrations(mg *Migrator) {
@@ -58,4 +61,48 @@ func addPreferencesMigrations(mg *Migrator) {
mg.AddMigration("Add preferences index org_id", NewAddIndexMigration(preferencesV2, preferencesV2.Indices[0]))
mg.AddMigration("Add preferences index user_id", NewAddIndexMigration(preferencesV2, preferencesV2.Indices[1]))
mg.AddMigration("Add home_dashboard_uid column to preferences table", NewAddColumnMigration(preferencesV2, &Column{
Name: "home_dashboard_uid", Type: DB_NVarchar, Length: 40, Nullable: true,
}))
mg.AddMigration("Add missing dashboard_uid to preferences table", &AddDashboardUIDMigration{})
}
type AddDashboardUIDMigration struct {
MigrationBase
}
func (m *AddDashboardUIDMigration) SQL(dialect Dialect) string {
return "code migration"
}
func (m *AddDashboardUIDMigration) Exec(sess *xorm.Session, mg *Migrator) error {
return RunPreferencesMigration(sess, mg.Dialect.DriverName())
}
func RunPreferencesMigration(sess *xorm.Session, driverName string) error {
// sqlite
sql := `UPDATE preferences
SET home_dashboard_uid = (SELECT uid FROM dashboard WHERE dashboard.id = preferences.home_dashboard_id)
WHERE home_dashboard_uid IS NULL AND EXISTS (SELECT 1 FROM dashboard WHERE dashboard.id = preferences.home_dashboard_id);`
switch driverName {
case Postgres:
sql = `UPDATE preferences
SET home_dashboard_uid = dashboard.uid
FROM dashboard
WHERE preferences.home_dashboard_id = dashboard.id
AND (preferences.home_dashboard_uid IS NULL);`
case MySQL:
sql = `UPDATE preferences
LEFT JOIN dashboard ON preferences.home_dashboard_id = dashboard.id
SET preferences.home_dashboard_uid = dashboard.uid
WHERE preferences.home_dashboard_uid IS NULL;`
}
if _, err := sess.Exec(sql); err != nil {
return fmt.Errorf("failed to set home_dashboard_uid for preferences: %w", err)
}
return nil
}