escrud

README

escrud

Simple CRUD and search for Elastic Search

Start

Call Connect(host, port) to establish connection.

Documentation

Overview

Package escrud provides simple CRUD operations and search function to work with Elastic Search

Index

• type Client
  • func Connect(host string, port int, scheme string) (*Client, error)
  • func (Es *Client) Create(index string, id string, data []byte) error
  • func (Es *Client) Delete(index, id string) (*ResponseBody, error)
  • func (Es *Client) Exists(index string, id string) (bool, error)
  • func (Es *Client) IncrementField(index string, docID string, fieldName string, incr int) (*ResponseBody, error)
  • func (Es *Client) Read(index, id string) (*ResponseBody, error)
  • func (Es *Client) RemoveArrayItem(index string, docID string, arrayName string, itemName string, itemValue int) (*ResponseBody, error)
  • func (Es *Client) Source(index, id string) ([]byte, error)
  • func (Es *Client) Update(index, id string, data []byte) (*ResponseBody, error)
  • func (Es *Client) UpdateArrayItem(index string, docID string, arrayName string, itemName string, itemValue int, ...) (*ResponseBody, error)
• type ResponseBody
• type Transport
  • func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error)

Types

type Client

type Client struct {
	Client *elasticsearch.Client
	Info   *esapi.Response
}

Client elasticsearch

func Connect

func Connect(host string, port int, scheme string) (*Client, error)

Connect to a elastic

func (*Client) Create

func (Es *Client) Create(index string, id string, data []byte) error

Create record in elasticsearch should contain a valid JSON with key {..."id":your_unique_id}

func (*Client) Delete

func (Es *Client) Delete(index, id string) (*ResponseBody, error)

Delete record by id in elasticsearch

func (*Client) Exists

func (Es *Client) Exists(index string, id string) (bool, error)

Exists checks if there's a document with such id in such an index

func (*Client) IncrementField

func (Es *Client) IncrementField(index string, docID string, fieldName string, incr int) (*ResponseBody, error)

IncrementField пересчитать просмотры в материале аналог запроса POST http://localhost:9200/article/_update/{{id}}/ { "script" : "ctx._source.viewed+={{amount}}" }

func (*Client) Read

func (Es *Client) Read(index, id string) (*ResponseBody, error)

func (*Client) RemoveArrayItem

func (Es *Client) RemoveArrayItem(index string, docID string, arrayName string, itemName string, itemValue int) (*ResponseBody, error)

RemoveArrayItem удалить элемент массива по его параметру (пока только числовой ID) POST http://localhost:9200/mask/_update/_3/ { "script": { "source": "ctx._source.mask_articles.removeIf(li -> li.article_id == params.article_id)", "params": { "article_id": 1886746 } } }

func (*Client) Source

func (Es *Client) Source(index, id string) ([]byte, error)

Source get source

func (*Client) Update

func (Es *Client) Update(index, id string, data []byte) (*ResponseBody, error)

Update record by id in elasticsearch

func (*Client) UpdateArrayItem

func (Es *Client) UpdateArrayItem(index string, docID string, arrayName string, itemName string, itemValue int, subst []byte) (*ResponseBody, error)

UpdateArrayItem заменить элемент массива по его параметру (пока только числовой ID) POST http://localhost:9200/mask/_update/_3/ { "script": { "inline": "ctx._source.mask_articles.removeIf(li -> li.article_id == params.article_id);", "lang": "painless", "params": { "article_id": 1886746, "cat": { "article_id": 1886746, "position": 5 } } } }

type ResponseBody

type ResponseBody struct {
	Index   string      `json:"_index,omitempty"`
	ID      string      `json:"_id,omitempty"`
	Version int         `json:"_version,omitempty"`
	Source  interface{} `json:"_source,omitempty"`
	Result  string      `json:"result,omitempty"`
}

ResponseBody struct from elastic

type Transport

type Transport struct{}

Transport implements the estransport interface with the github.com/valyala/fasthttp HTTP client.

func (*Transport) RoundTrip

func (t *Transport) RoundTrip(req *http.Request) (*http.Response, error)

RoundTrip performs the request and returns a response or error