elasticsearch

Documentation

Index

• Variables
• func FormatFilter(filter *filters.Filter, mapKey string) elastic.Query
• func SetRollingRate(rate time.Duration)
• type Client
  • func NewClient(indices []Index, cfg Config, electionService common.MasterElectionService) (*Client, error)
  • func (c *Client) AddEventListener(listener storage.EventListener)
  • func (c *Client) BulkDelete(index Index, id string) error
  • func (c *Client) BulkIndex(index Index, id string, data interface{}) error
  • func (c *Client) Delete(index Index, id string) (*elastic.DeleteResponse, error)
  • func (c *Client) Get(index Index, id string) (*elastic.GetResult, error)
  • func (c *Client) GetClient() *elastic.Client
  • func (c *Client) Index(index Index, id string, data interface{}) error
  • func (c *Client) RollIndex()
  • func (c *Client) Search(typ string, query elastic.Query, opts filters.SearchQuery, indices ...string) (*elastic.SearchResult, error)
  • func (c *Client) Start()
  • func (c *Client) Started() bool
  • func (c *Client) Stop()
  • func (c *Client) UpdateByScript(typ string, query elastic.Query, script *elastic.Script, indices ...string) error
• type ClientInterface
• type Config
• type Index
  • func (i *Index) Alias() string
  • func (i *Index) FullName() string
  • func (i *Index) IndexWildcard() string

Variables

var (
	// ErrBadConfig error bad configuration file
	ErrBadConfig = func(reason string) error { return fmt.Errorf("Config file is misconfigured: %s", reason) }
	// ErrIndexTypeNotFound error index type used but not defined
	ErrIndexTypeNotFound = errors.New("Index type not found in the indices map")
)

var (
	// RollingRate delay between two potential rolling index
	RollingRate = time.Minute
)

Functions

func FormatFilter

func FormatFilter(filter *filters.Filter, mapKey string) elastic.Query

FormatFilter creates a ElasticSearch request based on filters

func SetRollingRate

func SetRollingRate(rate time.Duration)

SetRollingRate override the default rolling index rate. Has to be called before client instantiation.

Types

type Client

type Client struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Client describes a ElasticSearch client connection

func NewClient

func NewClient(indices []Index, cfg Config, electionService common.MasterElectionService) (*Client, error)

NewClient creates a new ElasticSearch client based on configuration

func (*Client) AddEventListener

func (c *Client) AddEventListener(listener storage.EventListener)

AddEventListener add event listener

func (*Client) BulkDelete

func (c *Client) BulkDelete(index Index, id string) error

BulkDelete an object with the indexer

func (*Client) BulkIndex

func (c *Client) BulkIndex(index Index, id string, data interface{}) error

BulkIndex returns the bulk index from the indexer

func (*Client) Delete

func (c *Client) Delete(index Index, id string) (*elastic.DeleteResponse, error)

Delete an object

func (*Client) Get

func (c *Client) Get(index Index, id string) (*elastic.GetResult, error)

Get an object

func (*Client) GetClient

func (c *Client) GetClient() *elastic.Client

GetClient returns the elastic client object

func (*Client) Index

func (c *Client) Index(index Index, id string, data interface{}) error

Index returns the skydive index

func (*Client) RollIndex

func (c *Client) RollIndex()

RollIndex forces a rolling index

func (*Client) Search

func (c *Client) Search(typ string, query elastic.Query, opts filters.SearchQuery, indices ...string) (*elastic.SearchResult, error)

Search an object

func (*Client) Start

func (c *Client) Start()

Start the Elasticsearch client background jobs

func (*Client) Started

func (c *Client) Started() bool

Started is the client already started ?

func (*Client) Stop

func (c *Client) Stop()

Stop Elasticsearch background client

func (*Client) UpdateByScript

func (c *Client) UpdateByScript(typ string, query elastic.Query, script *elastic.Script, indices ...string) error

UpdateByScript updates the document using the given script

type ClientInterface

type ClientInterface interface {
	Index(index Index, id string, data interface{}) error
	BulkIndex(index Index, id string, data interface{}) error
	Get(index Index, id string) (*elastic.GetResult, error)
	Delete(index Index, id string) (*elastic.DeleteResponse, error)
	BulkDelete(index Index, id string) error
	Search(typ string, query elastic.Query, pagination filters.SearchQuery, indices ...string) (*elastic.SearchResult, error)
	Start()
	AddEventListener(listener storage.EventListener)
	UpdateByScript(typ string, query elastic.Query, script *elastic.Script, indices ...string) error
}

ClientInterface describes the mechanism API of ElasticSearch database client

type Config

type Config struct {
	ElasticHost  string
	BulkMaxDelay int
	EntriesLimit int
	AgeLimit     int
	IndicesLimit int
}

Config describes configuration for elasticsearch

type Index

type Index struct {
	Name      string
	Type      string
	Mapping   string
	RollIndex bool
	URL       string
}

Index defines a Client Index

func (*Index) Alias

func (i *Index) Alias() string

Alias returns the Alias of the index

func (*Index) FullName

func (i *Index) FullName() string

FullName returns the full name of an index, prefix, name, version, suffix in case of rolling index

func (*Index) IndexWildcard

func (i *Index) IndexWildcard() string

IndexWildcard returns the Index wildcard search string used to all the indexes of an index definition. Useful to request rolled over indexes.