elasticsearch

Documentation

Index

• Constants
• Variables
• type BulkProcessorParameters
• type Client
  • func NewClient(config *Config) (Client, error)
  • func NewWrapperClient(esClient *elastic.Client) Client
• type Config
  • func (cfg *Config) GetVisibilityIndex() string
• type ScrollService
• type SearchParameters

Constants

const (
	NamespaceID     = "NamespaceId"
	WorkflowID      = "WorkflowId"
	RunID           = "RunId"
	WorkflowType    = "WorkflowType"
	StartTime       = "StartTime"
	ExecutionTime   = "ExecutionTime"
	CloseTime       = "CloseTime"
	ExecutionStatus = "ExecutionStatus"
	HistoryLength   = "HistoryLength"
	Memo            = "Memo"
	Encoding        = "Encoding"
	TaskQueue       = "TaskQueue"
	CustomNamespace = "CustomNamespace"

	KafkaKey = "KafkaKey"
)

All legal fields allowed in elastic search index

Variables

var (
	FieldTypeString = enumsspb.FIELD_TYPE_STRING
	FieldTypeInt    = enumsspb.FIELD_TYPE_INT
	FieldTypeBool   = enumsspb.FIELD_TYPE_BOOL
	FieldTypeBinary = enumsspb.FIELD_TYPE_BINARY
)

Supported field types

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)
	SearchWithDSL(ctx context.Context, index, query string) (*elastic.SearchResult, error)
	Scroll(ctx context.Context, scrollID string) (*elastic.SearchResult, ScrollService, error)
	ScrollFirstPage(ctx context.Context, index, query string) (*elastic.SearchResult, ScrollService, error)
	Count(ctx context.Context, index, query string) (int64, error)
	RunBulkProcessor(ctx context.Context, p *BulkProcessorParameters) (*elastic.BulkProcessor, error)
	PutMapping(ctx context.Context, index, root, key, valueType string) error
	CreateIndex(ctx context.Context, index string) 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 {
	URL      url.URL           `yaml:"url"` //nolint:govet
	Username string            `yaml:"username"`
	Password string            `yaml:"password"`
	Indices  map[string]string `yaml:"indices"` //nolint:govet
}

Config for connecting to ElasticSearch

func (*Config) GetVisibilityIndex

func (cfg *Config) GetVisibilityIndex() string

GetVisibilityIndex return visibility index name

type ScrollService

type ScrollService interface {
	Clear(ctx context.Context) error
}

ScrollService is a interface for elastic.ScrollService

type SearchParameters

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

SearchParameters holds all required and optional parameters for executing a search