IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Search (SQL): support dashboardUID query parameter (#50121)

Browse Source
This commit is contained in:
Ryan McKinley 2022-06-02 12:56:01 -07:00 committed by GitHub
parent bc8578524b
commit d452322aa8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
6 changed files with 87 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
pkg/api/search.go
View File

@ -39,6 +39,8 @@ func (hs *HTTPServer) Search(c *models.ReqContext) response.Response {
}
}
dbUIDs := c.QueryStrings("dashboardUID")
folderIDs := make([]int64, 0)
for _, id := range c.QueryStrings("folderIds") {
folderID, err := strconv.ParseInt(id, 10, 64)
@ -47,19 +49,24 @@ func (hs *HTTPServer) Search(c *models.ReqContext) response.Response {
}
}
if len(dbIDs) > 0 && len(dbUIDs) > 0 {
return response.Error(400, "search supports UIDs or IDs, not both", nil)
}
searchQuery := search.Query{
Title: query,
Tags: tags,
SignedInUser: c.SignedInUser,
Limit: limit,
Page: page,
IsStarred: starred == "true",
OrgId: c.OrgId,
DashboardIds: dbIDs,
Type: dashboardType,
FolderIds: folderIDs,
Permission: permission,
Sort: sort,
Title: query,
Tags: tags,
SignedInUser: c.SignedInUser,
Limit: limit,
Page: page,
IsStarred: starred == "true",
OrgId: c.OrgId,
DashboardIds: dbIDs,
DashboardUIDs: dbUIDs,
Type: dashboardType,
FolderIds: folderIDs,
Permission: permission,
Sort: sort,
}
err := hs.SearchService.SearchHandler(c.Req.Context(), &searchQuery)

25
pkg/models/search.go
View File

@ -20,18 +20,19 @@ type SortOptionFilter interface {
}
type FindPersistedDashboardsQuery struct {
Title string
OrgId int64
SignedInUser *SignedInUser
IsStarred bool
DashboardIds []int64
Type string
FolderIds []int64
Tags []string
Limit int64
Page int64
Permission PermissionType
Sort SortOption
Title string
OrgId int64
SignedInUser *SignedInUser
IsStarred bool
DashboardIds []int64
DashboardUIDs []string
Type string
FolderIds []int64
Tags []string
Limit int64
Page int64
Permission PermissionType
Sort SortOption
Filters []interface{}

6
pkg/services/dashboards/database/database.go
View File

@ -964,8 +964,10 @@ func (d *DashboardStore) FindDashboards(ctx context.Context, query *models.FindP
filters = append(filters, searchstore.TagsFilter{Tags: query.Tags})
}
if len(query.DashboardIds) > 0 {
filters = append(filters, searchstore.DashboardFilter{IDs: query.DashboardIds})
if len(query.DashboardUIDs) > 0 {
filters = append(filters, searchstore.DashboardFilter{UIDs: query.DashboardUIDs})
} else if len(query.DashboardIds) > 0 {
filters = append(filters, searchstore.DashboardIDFilter{IDs: query.DashboardIds})
}
if query.IsStarred {

46
pkg/services/search/service.go
View File

@ -27,18 +27,19 @@ func ProvideService(cfg *setting.Cfg, sqlstore *sqlstore.SQLStore, starService s
}
type Query struct {
Title string
Tags []string
OrgId int64
SignedInUser *models.SignedInUser
Limit int64
Page int64
IsStarred bool
Type string
DashboardIds []int64
FolderIds []int64
Permission models.PermissionType
Sort string
Title string
Tags []string
OrgId int64
SignedInUser *models.SignedInUser
Limit int64
Page int64
IsStarred bool
Type string
DashboardUIDs []string
DashboardIds []int64
FolderIds []int64
Permission models.PermissionType
Sort string
Result models.HitList
}
@ -58,16 +59,17 @@ type SearchService struct {
func (s *SearchService) SearchHandler(ctx context.Context, query *Query) error {
dashboardQuery := models.FindPersistedDashboardsQuery{
Title: query.Title,
SignedInUser: query.SignedInUser,
IsStarred: query.IsStarred,
DashboardIds: query.DashboardIds,
Type: query.Type,
FolderIds: query.FolderIds,
Tags: query.Tags,
Limit: query.Limit,
Page: query.Page,
Permission: query.Permission,
Title: query.Title,
SignedInUser: query.SignedInUser,
IsStarred: query.IsStarred,
DashboardUIDs: query.DashboardUIDs,
DashboardIds: query.DashboardIds,
Type: query.Type,
FolderIds: query.FolderIds,
Tags: query.Tags,
Limit: query.Limit,
Page: query.Page,
Permission: query.Permission,
}
if sortOpt, exists := s.sortOptions[query.Sort]; exists {

27
pkg/services/sqlstore/searchstore/filters.go
View File

@ -95,14 +95,22 @@ func (f FolderFilter) Where() (string, []interface{}) {
return sqlIDin("dashboard.folder_id", f.IDs)
}
type DashboardFilter struct {
type DashboardIDFilter struct {
IDs []int64
}
func (f DashboardFilter) Where() (string, []interface{}) {
func (f DashboardIDFilter) Where() (string, []interface{}) {
return sqlIDin("dashboard.id", f.IDs)
}
type DashboardFilter struct {
UIDs []string
}
func (f DashboardFilter) Where() (string, []interface{}) {
return sqlUIDin("dashboard.uid", f.UIDs)
}
type TagsFilter struct {
Tags []string
}
@ -150,6 +158,21 @@ func sqlIDin(column string, ids []int64) (string, []interface{}) {
return fmt.Sprintf("%s IN %s", column, sqlArray), params
}
func sqlUIDin(column string, uids []string) (string, []interface{}) {
length := len(uids)
if length < 1 {
return "", nil
}
sqlArray := "(?" + strings.Repeat(",?", length-1) + ")"
params := []interface{}{}
for _, id := range uids {
params = append(params, id)
}
return fmt.Sprintf("%s IN %s", column, sqlArray), params
}
// FolderWithAlertsFilter applies a filter that makes the result contain only folders that contain alert rules
type FolderWithAlertsFilter struct {
}

7
public/app/features/search/service/sql.ts
View File

@ -16,11 +16,9 @@ interface APIQuery {
page?: number;
type?: string;
// DashboardIds []int64
dashboardUID?: string[];
folderIds?: number[];
sort?: string;
// NEW!!!! TODO TODO: needs backend support?
dashboardUIDs?: string[];
}
// Internal object to hold folderId
@ -57,8 +55,7 @@ export class SQLSearcher implements GrafanaSearcher {
}
if (query.uid) {
q.query = query.uid.join(', '); // TODO! this will return nothing
q.dashboardUIDs = query.uid;
q.dashboardUID = query.uid;
} else if (query.location?.length) {
let info = this.locationInfo[query.location];
if (!info) {