search

Documentation

Index

• Variables
• type Query
• type SearchService
  • func ProvideService(cfg *setting.Cfg, sqlstore db.DB, starService star.Service, ...) *SearchService
  • func (s *SearchService) RegisterSortOption(option model.SortOption)
  • func (s *SearchService) SearchHandler(ctx context.Context, query *Query) (model.HitList, error)
  • func (s *SearchService) SortOptions() []model.SortOption
• type Service

Variables

var (
	SortAlphaAsc = model.SortOption{
		Name:        "alpha-asc",
		DisplayName: "Alphabetically (A–Z)",
		Description: "Sort results in an alphabetically ascending order",
		Index:       0,
		Filter: []model.SortOptionFilter{
			searchstore.TitleSorter{},
		},
	}
	SortAlphaDesc = model.SortOption{
		Name:        "alpha-desc",
		DisplayName: "Alphabetically (Z–A)",
		Description: "Sort results in an alphabetically descending order",
		Index:       0,
		Filter: []model.SortOptionFilter{
			searchstore.TitleSorter{Descending: true},
		},
	}
)

Types

type Query

type Query struct {
	Title         string
	Tags          []string
	OrgId         int64
	SignedInUser  *user.SignedInUser
	Limit         int64
	Page          int64
	IsStarred     bool
	IsDeleted     bool
	Type          string
	DashboardUIDs []string
	DashboardIds  []int64
	// Deprecated: use FolderUID instead
	FolderIds  []int64
	FolderUIDs []string
	Permission dashboardaccess.PermissionType
	Sort       string
}

type SearchService

type SearchService struct {
	Cfg *setting.Cfg
	// contains filtered or unexported fields
}

func ProvideService

func ProvideService(cfg *setting.Cfg, sqlstore db.DB, starService star.Service, dashboardService dashboards.DashboardService) *SearchService

func (*SearchService) RegisterSortOption

func (s *SearchService) RegisterSortOption(option model.SortOption)

RegisterSortOption allows for hooking in more search options from other services.

func (*SearchService) SearchHandler

func (s *SearchService) SearchHandler(ctx context.Context, query *Query) (model.HitList, error)

func (*SearchService) SortOptions

func (s *SearchService) SortOptions() []model.SortOption

type Service

type Service interface {
	SearchHandler(context.Context, *Query) (model.HitList, error)
	SortOptions() []model.SortOption
}