grafana/pkg/services/star/model.go

package star

import "errors"

var ErrCommandValidationFailed = errors.New("command missing required fields")

type Star struct {
	ID          int64 `xorm:"pk autoincr 'id'"`
	UserID      int64 `xorm:"user_id"`
	DashboardID int64 `xorm:"dashboard_id"`
}

// ----------------------
// COMMANDS

type StarDashboardCommand struct {
	UserID      int64 `xorm:"user_id"`
	DashboardID int64 `xorm:"dashboard_id"`
}

func (cmd *StarDashboardCommand) Validate() error {
	if cmd.DashboardID == 0 || cmd.UserID == 0 {
		return ErrCommandValidationFailed
	}
	return nil
}

type UnstarDashboardCommand struct {
	UserID      int64 `xorm:"user_id"`
	DashboardID int64 `xorm:"dashboard_id"`
}

func (cmd *UnstarDashboardCommand) Validate() error {
	if cmd.DashboardID == 0 || cmd.UserID == 0 {
		return ErrCommandValidationFailed
	}
	return nil
}

// ---------------------
// QUERIES

type GetUserStarsQuery struct {
	UserID int64 `xorm:"user_id"`
}

type IsStarredByUserQuery struct {
	UserID      int64 `xorm:"user_id"`
	DashboardID int64 `xorm:"dashboard_id"`
}

type GetUserStarsResult struct {
	UserStars map[int64]bool
}