django-sql-dashboard icon indicating copy to clipboard operation
django-sql-dashboard copied to clipboard

Ability to configure dashboards in code that lives in source control

Open simonw opened this issue 3 years ago • 2 comments

Dashboard configurations that live in the database could get out of sync with the database design - especially if it is being actively iterated on.

An option where you can define your dashboards in source code - probably YAML - would enable people to keep the dashboards synchronized with changes made to their models, enforced by code review.

Could even have a testing mechanism which can attempt to render every configured dashboard and check that no SQL errors (e.g. from missing columns) are returned during the renders.

Given this mechanism, users could opt-out entirely of database-driven dashboards - or they could use both.

simonw avatar Mar 15 '21 22:03 simonw

YAML or even a Django setting would be nice.

A Django fixture isn't a terrible idea though either.

jefftriplett avatar Mar 21 '21 19:03 jefftriplett

I've been resisting adding a JSON API for the data in a dashboard mainly because I get very nervous about API definitions that don't live in source control... but if I implement this feature that nervousness evaporates.

simonw avatar May 12 '21 01:05 simonw