elasticsearch

README

主要是提供一些搜索服务客户端，比如常见的 Elasticsearch、solr

Elasticsearch

Elasticsearch 是当前比较流行的 搜索框架，这里提供两个库，第三方和官方的，特点各有千秋。

• 官方 https://github.com/elastic/go-elasticsearch star: 2700+
• 第三方https://github.com/olivere/elastic star: 5300+

第三方的这个已经不在维护，所以推荐使用官方的

Compatibility

The client major versions correspond to the compatible Elasticsearch major versions: to connect to Elasticsearch 7.x, use a 7.x version of the client, to connect to Elasticsearch 6.x, use a 6.x version of the client.

Reference

• https://medium.com/a-journey-with-go/go-elasticsearch-clients-study-case-dbaee1e02c7
• https://mp.weixin.qq.com/s?__biz=MzkyNzI1NzM5NQ==&mid=2247484756&idx=1&sn=6029ed72391e175ebef3de47bf9290a2&chksm=c22b8308f55c0a1eb0d06f4f5f7404e0ba33f6bb10a86f996dfbbd7b80b952e5bef97ce2344f&cur_album_id=1932372564102709257&scene=189#wechat_redirect
• https://discuss.elastic.co/t/go-elasticsearch-versus-olivere-golang-client/252248
• https://github.com/olivere/elastic/issues/1240
• https://www.elastic.co/guide/en/elasticsearch/reference/7.17/docker.html
• https://studygolang.com/articles/28869

Documentation

Index

• Variables
• type EsClient
  • func NewESClient(hosts []string, username, password string) (client *EsClient, err error)
  • func (es *EsClient) CreateDocument(ctx context.Context, indexName string, docId string, ...) (map[string]interface{}, error)
  • func (es *EsClient) CreateIndex(ctx context.Context, indexName string, body string) (map[string]interface{}, error)
  • func (es *EsClient) DeleteDocument(ctx context.Context, indexName string, docId string) error
  • func (es *EsClient) DeleteDocumentByQuery(ctx context.Context, indexName string, query, data map[string]interface{}) (map[string]interface{}, error)
  • func (es *EsClient) DeleteIndex(ctx context.Context, indexName string) error
  • func (es *EsClient) GetDocument(ctx context.Context, indexName, docId string) (map[string]interface{}, error)
  • func (es *EsClient) GetIndex(ctx context.Context, indexName string) (map[string]interface{}, error)
  • func (es *EsClient) IsExistDocument(ctx context.Context, indexName, docId string) (bool, error)
  • func (es *EsClient) Search(ctx context.Context, indexName string, query, sort map[string]interface{}, ...) (ret []map[string]interface{}, total int, err error)
  • func (es *EsClient) SearchByAggregations(ctx context.Context, indexName string, jsonBody string) (ret map[string]interface{}, err error)
  • func (es *EsClient) UpdateDocument(ctx context.Context, indexName, docId string, data map[string]interface{}) (map[string]interface{}, error)
  • func (es *EsClient) UpdateDocumentByQuery(ctx context.Context, indexName string, query, data map[string]interface{}) (map[string]interface{}, error)

Variables

var (
	ErrEsNotFound = errors.New("es: not found")
)

Types

type EsClient

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

func NewESClient

func NewESClient(hosts []string, username, password string) (client *EsClient, err error)

func (*EsClient) CreateDocument

func (es *EsClient) CreateDocument(ctx context.Context, indexName string, docId string,
	data map[string]interface{}) (map[string]interface{}, error)

CreateDocument create a document

func (*EsClient) CreateIndex

func (es *EsClient) CreateIndex(ctx context.Context, indexName string, body string) (map[string]interface{}, error)

CreateIndex creates an index with the given name and body.

func (*EsClient) DeleteDocument

func (es *EsClient) DeleteDocument(ctx context.Context, indexName string, docId string) error

func (*EsClient) DeleteDocumentByQuery

func (es *EsClient) DeleteDocumentByQuery(ctx context.Context, indexName string, query, data map[string]interface{}) (map[string]interface{}, error)

func (*EsClient) DeleteIndex

func (es *EsClient) DeleteIndex(ctx context.Context, indexName string) error

DeleteIndex deletes an index with the given name.

func (*EsClient) GetDocument

func (es *EsClient) GetDocument(ctx context.Context, indexName, docId string) (map[string]interface{}, error)

GetDocument get a document

func (*EsClient) GetIndex

func (es *EsClient) GetIndex(ctx context.Context, indexName string) (map[string]interface{}, error)

GetIndex gets an index with the given name.

func (*EsClient) IsExistDocument

func (es *EsClient) IsExistDocument(ctx context.Context, indexName, docId string) (bool, error)

IsExistDocument check a document is exist

func (*EsClient) Search

func (es *EsClient) Search(ctx context.Context, indexName string, query, sort map[string]interface{}, offset,
	limit int) (ret []map[string]interface{}, total int, err error)

Search documents by query and sort

func (*EsClient) SearchByAggregations

func (es *EsClient) SearchByAggregations(ctx context.Context, indexName string,
	jsonBody string) (ret map[string]interface{}, err error)

SearchByAggregations documents by body with json format

func (*EsClient) UpdateDocument

func (es *EsClient) UpdateDocument(ctx context.Context, indexName, docId string, data map[string]interface{}) (map[string]interface{}, error)

UpdateDocument update a document

func (*EsClient) UpdateDocumentByQuery

func (es *EsClient) UpdateDocumentByQuery(ctx context.Context, indexName string, query, data map[string]interface{}) (map[string]interface{}, error)

UpdateDocumentByQuery 根据搜索条件更新