search

Documentation

Overview

Package search provides search features for Helm.

Index

• Variables
• func SortScore(r []*Result)
• type Index
  • func NewIndex(cfg *config.Configfile, cachedir string) *Index
  • func (i *Index) Chart(name string) (*chart.Chartfile, error)
  • func (i *Index) Search(term string, threshold int, regexp bool) ([]*Result, error)
  • func (i *Index) SearchLiteral(term string, threshold int) []*Result
  • func (i *Index) SearchRegexp(re string, threshold int) ([]*Result, error)
• type Result

Variables

var ErrNoChart = errors.New("no such chart")

ErrNoChart indicates that a chart is not in the chart cache.

Functions

func SortScore

func SortScore(r []*Result)

Sort does an in-place sort of the results.

Lowest scores are highest on the list. Matching scores are subsorted alphabetically.

Types

type Index

type Index struct {
	// contains filtered or unexported fields
}

Index is a searchable index of chart information.

func NewIndex

func NewIndex(cfg *config.Configfile, cachedir string) *Index

NewIndex creats a new Index.

NewIndex indexes all of the chart tables configured in the config.yaml file. For that reason, it may cause substantial overhead on a large set of repos.

func (*Index) Chart

func (i *Index) Chart(name string) (*chart.Chartfile, error)

Get the *Chartfile for a chart that was found during search.

This is a convenience method for retrieving a cached chart that was located during search indexing.

func (*Index) Search

func (i *Index) Search(term string, threshold int, regexp bool) ([]*Result, error)

Search searches an index for the given term.

Threshold indicates the maximum score a term may have before being marked irrelevant. (Low score means higher relevance. Golf, not bowling.)

If regexp is true, the term is treated as a regular expression. Otherwise, term is treated as a literal string.

func (*Index) SearchLiteral

func (i *Index) SearchLiteral(term string, threshold int) []*Result

SearchLiteral does a literal string search (no regexp).

func (*Index) SearchRegexp

func (i *Index) SearchRegexp(re string, threshold int) ([]*Result, error)

SearchRegexp searches using a regular expression.

type Result

type Result struct {
	Name  string
	Score int
}

Result is a search result.

Score indicates how close it is to match. The higher the score, the longer the distance.