common

Documentation

Index

• Constants
• func CreateFilterQuery(simpleField string, value interface{}) []elastic.Query
• func CreateSortBy(sortField string, sortOrder string) elastic.Sorter
• func CreateSortByMultiple(sortParameters []SortParameter) []elastic.Sorter
• func EscapeQueryStringQuery(query string) string
• type Aggregation
  • func ParseAggregation(aggregations elastic.Aggregations, name string) (Aggregation, error)
• type Bucket
• type HighlightPart
  • func TransformEsHighlight(esHighlight string) []HighlightPart
• type SortParameter
  • func ParseSortParams(str string) ([]SortParameter, error)

Constants

const HighlightPostTag = "<__POST_HL_TAG__>"

const HighlightPreTag = "<__PRE_HL_TAG__>"

Functions

func CreateFilterQuery

func CreateFilterQuery(simpleField string, value interface{}) []elastic.Query

func CreateSortBy

func CreateSortBy(sortField string, sortOrder string) elastic.Sorter

func CreateSortByMultiple

func CreateSortByMultiple(sortParameters []SortParameter) []elastic.Sorter

func EscapeQueryStringQuery

func EscapeQueryStringQuery(query string) string

escape reserved characters, but preserve any leading or trailing wildcards

Types

type Aggregation

type Aggregation struct {
	Buckets                 []Bucket `json:"buckets,omitempty"`
	DocCountErrorUpperBound int      `json:"doc_count_error_upper_bound"`
	SumOtherDocCount        int      `json:"sum_other_doc_count"`
}

func ParseAggregation

func ParseAggregation(aggregations elastic.Aggregations, name string) (Aggregation, error)

type Bucket

type Bucket struct {
	// For boolean values, ES will return 0/1 as key, so we need to handle both
	// integers and strings as bucket key.
	Key         intOrString `json:"key,omitempty"`
	KeyAsString string      `json:"key_as_string,omitempty"`
	Count       int         `json:"doc_count,omitempty"`
}

type HighlightPart

type HighlightPart struct {
	Highlighted bool   `json:"highlighted"`
	Text        string `json:"text"`
}

func TransformEsHighlight

func TransformEsHighlight(esHighlight string) []HighlightPart

type SortParameter

type SortParameter struct {
	Field     string
	Ascending bool
}

func ParseSortParams

func ParseSortParams(str string) ([]SortParameter, error)