dashver

Documentation

Index

• Variables
• type DashboardVersion
  • func (v *DashboardVersion) ToDTO(dashUid string) *DashboardVersionDTO
• type DashboardVersionDTO
• type DashboardVersionMeta
• type DeleteExpiredVersionsCommand
• type GetDashboardVersionQuery
• type ListDashboardVersionsQuery
• type Service

Variables

var (
	ErrDashboardVersionNotFound = errors.New("dashboard version not found")
	ErrNoVersionsForDashboardID = errors.New("no dashboard versions found for the given DashboardId")
)

Types

type DashboardVersion

type DashboardVersion struct {
	ID            int64 `json:"id" xorm:"pk autoincr 'id'" db:"id"`
	DashboardID   int64 `json:"dashboardId"  xorm:"dashboard_id" db:"dashboard_id"`
	ParentVersion int   `json:"parentVersion" db:"parent_version"`
	RestoredFrom  int   `json:"restoredFrom" db:"restored_from"`
	Version       int   `json:"version" db:"version"`

	Created   time.Time `json:"created" db:"created"`
	CreatedBy int64     `json:"createdBy" db:"created_by"`

	Message string           `json:"message" db:"message"`
	Data    *simplejson.Json `json:"data" db:"data"`
}

DashboardVersion represents a dashboard version in the database. Ideally this will be moved into dashverimpl and unexported, but there are a few test fixtures that insert DashboardVersions directly into a database which must be refactored first.

func (*DashboardVersion) ToDTO

func (v *DashboardVersion) ToDTO(dashUid string) *DashboardVersionDTO

ToDTO converts a DashboardVersion to a DashboardVersionDTO.

type DashboardVersionDTO

type DashboardVersionDTO struct {
	ID            int64            `json:"id"`
	DashboardID   int64            `json:"dashboardId"`
	DashboardUID  string           `json:"dashboardUid"`
	ParentVersion int              `json:"parentVersion"`
	RestoredFrom  int              `json:"restoredFrom"`
	Version       int              `json:"version"`
	Created       time.Time        `json:"created"`
	CreatedBy     int64            `json:"createdBy"`
	Message       string           `json:"message"`
	Data          *simplejson.Json `json:"data" db:"data"`
}

type DashboardVersionMeta

type DashboardVersionMeta struct {
	ID            int64            `json:"id"`
	DashboardID   int64            `json:"dashboardId"`
	DashboardUID  string           `json:"uid"`
	ParentVersion int              `json:"parentVersion"`
	RestoredFrom  int              `json:"restoredFrom"`
	Version       int              `json:"version"`
	Created       time.Time        `json:"created"`
	Message       string           `json:"message"`
	Data          *simplejson.Json `json:"data"`
	CreatedBy     string           `json:"createdBy"`
}

DashboardVersionMeta extends the DashboardVersionDTO with the names associated with the UserIds, overriding the field with the same name from the DashboardVersionDTO model.

type DeleteExpiredVersionsCommand

type DeleteExpiredVersionsCommand struct {
	DeletedRows int64
}

type GetDashboardVersionQuery

type GetDashboardVersionQuery struct {
	DashboardID  int64
	DashboardUID string
	OrgID        int64
	Version      int
}

GetDashboardVersionQuery is used to Get a dashboard version. Only one of DashboardID and DashboardUID are required.

type ListDashboardVersionsQuery

type ListDashboardVersionsQuery struct {
	DashboardID  int64
	DashboardUID string
	OrgID        int64
	Limit        int
	Start        int
}

type Service

type Service interface {
	Get(context.Context, *GetDashboardVersionQuery) (*DashboardVersionDTO, error)
	DeleteExpired(context.Context, *DeleteExpiredVersionsCommand) error
	List(context.Context, *ListDashboardVersionsQuery) ([]*DashboardVersionDTO, error)
}