elastirad

README

Elastirad: A Go Client Wrapper for Elasticsearch

Simple client to query Elasticsearch API using HTTP API documentation. This is inspired by the Elastirad Ruby gem.

Usage

See the sample code in the docs folder.

So far the following example code has been created:

1. Create Index: Go code, ES docs
2. Index Docs: Go code, ES docs
3. Bool Query: Go code, ES docs
4. Terms Aggregation: Go code, ES docs

Documentation

Index

• Constants
• type Client
  • func NewClient(baseURL url.URL) Client
  • func (c *Client) BuildFastRequest(esReq models.Request) (*fasthttp.Request, error)
  • func (c *Client) BuildURL(esReq models.Request) url.URL
  • func (c *Client) SendFastRequest(esReq models.Request) (*fasthttp.Response, *fasthttp.Request, error)
  • func (c *Client) SetDefaults()

Constants

const (
	// ElasticsearchAPIDefaultScheme is the HTTP scheme for the default server.
	ElasticsearchAPIDefaultScheme string = "http"
	// ElasticsearchAPIDefaultHost is the HTTP host for the default server.
	ElasticsearchAPIDefaultHost string = "127.0.0.1:9200"
	// CreateSlug is the URL path part for creates.
	CreateSlug string = "_create"
	// UpdateSlug is the URL path part for updates.
	UpdateSlug string = "_update"
	// SearchSlug is the URL path part for search.
	SearchSlug string = "_search"
)

Types

type Client

type Client struct {
	BaseURL        url.URL
	FastHTTPClient fasthttp.Client
}

Client is a API client for Elasticsearch.

func NewClient

func NewClient(baseURL url.URL) Client

NewClient returns a Client struct given a Elasticsearch server URL.

func (*Client) BuildFastRequest

func (c *Client) BuildFastRequest(esReq models.Request) (*fasthttp.Request, error)

BuildFastRequest builds a valyala/fasthttp HTTP request struct.

func (*Client) BuildURL

func (c *Client) BuildURL(esReq models.Request) url.URL

BuildURL merges the URL info in the request with the Elasticsearch server info configured in the client.

func (*Client) SendFastRequest

func (c *Client) SendFastRequest(esReq models.Request) (*fasthttp.Response, *fasthttp.Request, error)

SendFastRequest executes a valyala/fasthttp HTTP request and returns the response, request and error structs.

func (*Client) SetDefaults

func (c *Client) SetDefaults()

SetDefaults sets default values where not specified.