elasticsearch

Documentation

Index

• Constants
• Variables
• func IsFieldNameValid(name string) bool
• type BulkProcessorParameters
• type Client
  • func NewClient(config *Config) (Client, error)
  • func NewWrapperClient(esClient *elastic.Client) Client
• type Config
• type SearchParameters

Constants

const (
	DomainID      = "DomainID"
	WorkflowID    = "WorkflowID"
	RunID         = "RunID"
	WorkflowType  = "WorkflowType"
	StartTime     = "StartTime"
	CloseTime     = "CloseTime"
	CloseStatus   = "CloseStatus"
	HistoryLength = "HistoryLength"

	KafkaKey = "KafkaKey"
)

All legal fields allowed in elastic search index

Variables

var (
	FieldTypeString = indexer.FieldTypeString
	FieldTypeInt    = indexer.FieldTypeInt
	FieldTypeBool   = indexer.FieldTypeBool
)

Supported field types

Functions

func IsFieldNameValid

func IsFieldNameValid(name string) bool

IsFieldNameValid return true if given field name are allowed to index in elastic search

Types

type BulkProcessorParameters

type BulkProcessorParameters struct {
	Name          string
	NumOfWorkers  int
	BulkActions   int
	BulkSize      int
	FlushInterval time.Duration
	Backoff       elastic.Backoff
	BeforeFunc    elastic.BulkBeforeFunc
	AfterFunc     elastic.BulkAfterFunc
}

BulkProcessorParameters holds all required and optional parameters for executing bulk service

type Client

type Client interface {
	Search(ctx context.Context, p *SearchParameters) (*elastic.SearchResult, error)
	RunBulkProcessor(ctx context.Context, p *BulkProcessorParameters) (*elastic.BulkProcessor, error)
}

Client is a wrapper around ElasticSearch client library. It simplifies the interface and enables mocking. We intentionally let implementation details of the elastic library bleed through, as the main purpose is testability not abstraction.

func NewClient

func NewClient(config *Config) (Client, error)

NewClient create a ES client

func NewWrapperClient

func NewWrapperClient(esClient *elastic.Client) Client

NewWrapperClient returns a new implementation of Client

type Config

type Config struct {
	Enable  bool              `yaml:enable`
	URL     url.URL           `yaml:url`
	Indices map[string]string `yaml:indices`
}

Config for connecting to ElasticSearch

type SearchParameters

type SearchParameters struct {
	Index    string
	Query    elastic.Query
	From     int
	PageSize int
	Sorter   []elastic.Sorter
}

SearchParameters holds all required and optional parameters for executing a search