2015-02-24 04:46:34 -06:00
|
|
|
package migrations
|
|
|
|
|
|
|
|
import . "github.com/grafana/grafana/pkg/services/sqlstore/migrator"
|
|
|
|
|
|
|
|
// --- Migration Guide line ---
|
|
|
|
// 1. Never change a migration that is committed and pushed to master
|
|
|
|
// 2. Always add new migrations (to change or undo previous migrations)
|
2017-02-03 05:10:22 -06:00
|
|
|
// 3. Some migrations are not yet written (rename column, table, drop table, index etc)
|
2015-02-24 04:46:34 -06:00
|
|
|
|
|
|
|
func AddMigrations(mg *Migrator) {
|
|
|
|
addMigrationLogMigrations(mg)
|
|
|
|
addUserMigrations(mg)
|
2015-07-16 10:59:11 -05:00
|
|
|
addTempUserMigrations(mg)
|
2015-02-24 04:46:34 -06:00
|
|
|
addStarMigrations(mg)
|
|
|
|
addOrgMigrations(mg)
|
|
|
|
addDashboardMigration(mg)
|
|
|
|
addDataSourceMigration(mg)
|
|
|
|
addApiKeyMigrations(mg)
|
2015-03-21 07:53:16 -05:00
|
|
|
addDashboardSnapshotMigrations(mg)
|
2015-07-20 07:51:27 -05:00
|
|
|
addQuotaMigration(mg)
|
2016-01-10 14:37:11 -06:00
|
|
|
addAppSettingsMigration(mg)
|
2015-12-23 01:33:46 -06:00
|
|
|
addSessionMigration(mg)
|
2015-12-24 04:25:49 -06:00
|
|
|
addPlaylistMigrations(mg)
|
2016-03-04 03:29:46 -06:00
|
|
|
addPreferencesMigrations(mg)
|
2016-04-13 03:33:45 -05:00
|
|
|
addAlertMigrations(mg)
|
2016-08-01 03:07:00 -05:00
|
|
|
addAnnotationMig(mg)
|
2017-03-30 11:03:50 -05:00
|
|
|
addTestDataMigrations(mg)
|
History and Version Control for Dashboard Updates
A simple version control system for dashboards. Closes #1504.
Goals
1. To create a new dashboard version every time a dashboard is saved.
2. To allow users to view all versions of a given dashboard.
3. To allow users to rollback to a previous version of a dashboard.
4. To allow users to compare two versions of a dashboard.
Usage
Navigate to a dashboard, and click the settings cog. From there, click
the "Changelog" button to be brought to the Changelog view. In this
view, a table containing each version of a dashboard can be seen. Each
entry in the table represents a dashboard version. A selectable
checkbox, the version number, date created, name of the user who created
that version, and commit message is shown in the table, along with a
button that allows a user to restore to a previous version of that
dashboard. If a user wants to restore to a previous version of their
dashboard, they can do so by clicking the previously mentioned button.
If a user wants to compare two different versions of a dashboard, they
can do so by clicking the checkbox of two different dashboard versions,
then clicking the "Compare versions" button located below the dashboard.
From there, the user is brought to a view showing a summary of the
dashboard differences. Each summarized change contains a link that can
be clicked to take the user a JSON diff highlighting the changes line by
line.
Overview of Changes
Backend Changes
- A `dashboard_version` table was created to store each dashboard
version, along with a dashboard version model and structs to represent
the queries and commands necessary for the dashboard version API
methods.
- API endpoints were created to support working with dashboard
versions.
- Methods were added to create, update, read, and destroy dashboard
versions in the database.
- Logic was added to compute the diff between two versions, and
display it to the user.
- The dashboard migration logic was updated to save a "Version
1" of each existing dashboard in the database.
Frontend Changes
- New views
- Methods to pull JSON and HTML from endpoints
New API Endpoints
Each endpoint requires the authorization header to be sent in
the format,
```
Authorization: Bearer <jwt>
```
where `<jwt>` is a JSON web token obtained from the Grafana
admin panel.
`GET "/api/dashboards/db/:dashboardId/versions?orderBy=<string>&limit=<int>&start=<int>"`
Get all dashboard versions for the given dashboard ID. Accepts
three URL parameters:
- `orderBy` String to order the results by. Possible values
are `version`, `created`, `created_by`, `message`. Default
is `versions`. Ordering is always in descending order.
- `limit` Maximum number of results to return
- `start` Position in results to start from
`GET "/api/dashboards/db/:dashboardId/versions/:id"`
Get an individual dashboard version by ID, for the given
dashboard ID.
`POST "/api/dashboards/db/:dashboardId/restore"`
Restore to the given dashboard version. Post body is of
content-type `application/json`, and must contain.
```json
{
"dashboardId": <int>,
"version": <int>
}
```
`GET "/api/dashboards/db/:dashboardId/compare/:versionA...:versionB"`
Compare two dashboard versions by ID for the given
dashboard ID, returning a JSON delta formatted
representation of the diff. The URL format follows
what GitHub does. For example, visiting
[/api/dashboards/db/18/compare/22...33](http://ec2-54-80-139-44.compute-1.amazonaws.com:3000/api/dashboards/db/18/compare/22...33)
will return the diff between versions 22 and 33 for
the dashboard ID 18.
Dependencies Added
- The Go package [gojsondiff](https://github.com/yudai/gojsondiff)
was added and vendored.
2017-05-24 18:14:39 -05:00
|
|
|
addDashboardVersionMigration(mg)
|
2015-02-24 04:46:34 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
func addMigrationLogMigrations(mg *Migrator) {
|
2015-02-24 11:32:29 -06:00
|
|
|
migrationLogV1 := Table{
|
|
|
|
Name: "migration_log",
|
|
|
|
Columns: []*Column{
|
2015-03-07 09:23:22 -06:00
|
|
|
{Name: "id", Type: DB_BigInt, IsPrimaryKey: true, IsAutoIncrement: true},
|
|
|
|
{Name: "migration_id", Type: DB_NVarchar, Length: 255},
|
|
|
|
{Name: "sql", Type: DB_Text},
|
|
|
|
{Name: "success", Type: DB_Bool},
|
|
|
|
{Name: "error", Type: DB_Text},
|
|
|
|
{Name: "timestamp", Type: DB_DateTime},
|
2015-02-24 11:32:29 -06:00
|
|
|
},
|
|
|
|
}
|
|
|
|
|
|
|
|
mg.AddMigration("create migration_log table", NewAddTableMigration(migrationLogV1))
|
2015-02-24 04:46:34 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
func addStarMigrations(mg *Migrator) {
|
2015-02-24 11:32:29 -06:00
|
|
|
starV1 := Table{
|
|
|
|
Name: "star",
|
|
|
|
Columns: []*Column{
|
2015-03-07 09:23:22 -06:00
|
|
|
{Name: "id", Type: DB_BigInt, IsPrimaryKey: true, IsAutoIncrement: true},
|
|
|
|
{Name: "user_id", Type: DB_BigInt, Nullable: false},
|
|
|
|
{Name: "dashboard_id", Type: DB_BigInt, Nullable: false},
|
2015-02-24 11:32:29 -06:00
|
|
|
},
|
|
|
|
Indices: []*Index{
|
2015-03-07 09:23:22 -06:00
|
|
|
{Cols: []string{"user_id", "dashboard_id"}, Type: UniqueIndex},
|
2015-02-24 11:32:29 -06:00
|
|
|
},
|
|
|
|
}
|
2015-02-24 04:46:34 -06:00
|
|
|
|
2015-02-24 11:32:29 -06:00
|
|
|
mg.AddMigration("create star table", NewAddTableMigration(starV1))
|
|
|
|
mg.AddMigration("add unique index star.user_id_dashboard_id", NewAddIndexMigration(starV1, starV1.Indices[0]))
|
2015-02-24 04:46:34 -06:00
|
|
|
}
|